Package org.odpi.openmetadata.samples.archiveutilities.combo

Class CocoBaseArchiveWriter

java.lang.Object

org.odpi.openmetadata.repositoryservices.archiveutilities.OMRSArchiveWriter

org.odpi.openmetadata.samples.archiveutilities.combo.CocoBaseArchiveWriter

Direct Known Subclasses:

CocoBusinessSystemsArchiveWriter, CocoClinicalTrialsArchiveWriter, CocoComboArchiveWriter, CocoGovernanceEnginesArchiveWriter, CocoGovernanceProgramArchiveWriter, CocoOrganizationArchiveWriter, CocoSustainabilityArchiveWriter

public abstract class CocoBaseArchiveWriter
extends OMRSArchiveWriter

CocoBaseArchiveWriter provides a base class for utilities creating a physical open metadata archive file containing definitions for Coco Pharmaceuticals.

Field Summary

Fields

Modifier and Type	Field	Description
protected OMRSArchiveBuilder	archiveBuilder
protected final String	archiveFileName
protected final String	archiveGUID
protected CocoArchiveHelper	archiveHelper
protected static final String	archiveLicense
protected final String	archiveName
protected static final OpenMetadataArchiveType	archiveType
protected final Date	creationDate
protected static final String	guidMapFileName
protected static final String	openMetadataValidValueSetPrefix
protected static final String	originatorName
protected static final String	versionName
protected static final long	versionNumber

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CocoBaseArchiveWriter(String archiveGUID, String archiveName, String archiveDescription, Date creationDate, String archiveFileName)	Constructor for an archive.
protected	CocoBaseArchiveWriter(String archiveGUID, String archiveName, String archiveDescription, Date creationDate, String archiveFileName, OpenMetadataArchive[] additionalDependencies)	Constructor for an archive.

Method Summary

Modifier and Type	Method	Description
abstract void	getArchiveContent()	Implemented by subclass to add the content.
OpenMetadataArchive	getOpenMetadataArchive()	Returns the open metadata archive containing new metadata entities.
protected void	setArchiveBuilder(OMRSArchiveBuilder archiveBuilder, CocoArchiveHelper archiveHelper)	Provide an alternative archive builder.
void	writeOpenMetadataArchive()	Generates and writes out the open metadata archive created in the builder.

Methods inherited from class org.odpi.openmetadata.repositoryservices.archiveutilities.OMRSArchiveWriter

getOpenMetadataArchiveFileConnection, writeOpenMetadataArchive, writeOpenMetadataArchive

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

archiveLicense

protected static final String archiveLicense

See Also:

• Constant Field Values

archiveType

protected static final OpenMetadataArchiveType archiveType

originatorName

protected static final String originatorName

See Also:

• Constant Field Values

guidMapFileName

protected static final String guidMapFileName

See Also:

• Constant Field Values

openMetadataValidValueSetPrefix

protected static final String openMetadataValidValueSetPrefix

See Also:

• Constant Field Values

versionNumber

protected static final long versionNumber

See Also:

• Constant Field Values

versionName

protected static final String versionName

See Also:

• Constant Field Values

archiveBuilder

protected OMRSArchiveBuilder archiveBuilder

archiveHelper

protected CocoArchiveHelper archiveHelper

archiveGUID

protected final String archiveGUID

archiveName

protected final String archiveName

creationDate

protected final Date creationDate

archiveFileName

protected final String archiveFileName

Constructor Details

CocoBaseArchiveWriter

protected CocoBaseArchiveWriter(String archiveGUID,
 String archiveName,
 String archiveDescription,
 Date creationDate,
 String archiveFileName)

Constructor for an archive.

Parameters:

archiveGUID - unique identifier of the archive

archiveName - name of the archive

archiveDescription - description of archive

creationDate - date/time this archive writer ran

archiveFileName - name of file to write archive to

CocoBaseArchiveWriter

protected CocoBaseArchiveWriter(String archiveGUID,
 String archiveName,
 String archiveDescription,
 Date creationDate,
 String archiveFileName,
 OpenMetadataArchive[] additionalDependencies)

Constructor for an archive.

Parameters:

archiveGUID - unique identifier of the archive

archiveName - name of the archive

archiveDescription - description of archive

creationDate - date/time this archive writer ran

archiveFileName - name of file to write archive to

additionalDependencies - archive that this archive is dependent on

Method Details

setArchiveBuilder

protected void setArchiveBuilder(OMRSArchiveBuilder archiveBuilder,
 CocoArchiveHelper archiveHelper)

Provide an alternative archive builder. Used when consolidating archives.

Parameters:

archiveBuilder - new archive builder

getOpenMetadataArchive

public OpenMetadataArchive getOpenMetadataArchive()

Returns the open metadata archive containing new metadata entities.

Returns:

populated open metadata archive object

getArchiveContent

public abstract void getArchiveContent()

Implemented by subclass to add the content.

writeOpenMetadataArchive

public void writeOpenMetadataArchive()

Generates and writes out the open metadata archive created in the builder.