Package org.odpi.openmetadata.samples.archiveutilities

Class EgeriaBaseArchiveWriter

java.lang.Object
org.odpi.openmetadata.repositoryservices.archiveutilities.OMRSArchiveWriter
org.odpi.openmetadata.samples.archiveutilities.EgeriaBaseArchiveWriter
Direct Known Subclasses:
CocoBusinessSystemsArchiveWriter, CocoClinicalTrialsArchiveWriter, CocoComboArchiveWriter, CocoGovernanceEnginesArchiveWriter, CocoGovernanceProgramArchiveWriter, CocoOrganizationArchiveWriter, CocoSustainabilityArchiveWriter, ContentPackBaseArchiveWriter
public abstract class EgeriaBaseArchiveWriter extends OMRSArchiveWriter
CocoBaseArchiveWriter provides a base class for utilities creating a physical open metadata archive file containing definitions for Coco Pharmaceuticals.

  • Field Details

  • Constructor Details

    • EgeriaBaseArchiveWriter

      protected EgeriaBaseArchiveWriter(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

    • EgeriaBaseArchiveWriter

      protected EgeriaBaseArchiveWriter(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

      public void setArchiveBuilder(OMRSArchiveBuilder archiveBuilder, GovernanceArchiveHelper 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.

    • getParentSet

      protected String getParentSet(String requestedGUID, String typeName, String propertyName, String mapName)
      Find or create the parent set for a valid value.
      Parameters:
      requestedGUID - optional guid for the valid value
      typeName - name of the type (can be null)
      propertyName - name of the property (can be null)
      mapName - name of the mapName (can be null)
      Returns:
      unique identifier (guid) of the parent set

    • addValidMetadataValue

      protected void addValidMetadataValue(String displayName, String description, String propertyName, String typeName, String mapName, String preferredValue)
      Add a new valid value to an open metadata valid value set.
      Parameters:
      displayName - human-readable name
      description - description of the value
      propertyName - name of property
      typeName - type name - if values only apply to one type
      mapName - name of property if stored in a map
      preferredValue - preferred value to use

    • addValidMetadataValue

      protected void addValidMetadataValue(String suppliedGUID, String displayName, String description, String propertyName, String dataType, String typeName, String mapName, String preferredValue, Map<String,String> additionalProperties)
      Add a new valid value to an open metadata valid value set.
      Parameters:
      suppliedGUID - predefined guid
      displayName - human-readable name
      description - description of the value
      propertyName - name of property
      dataType - type of property
      typeName - type name - if values only apply to one type
      mapName - name of property if stored in a map
      preferredValue - preferred value to use
      additionalProperties - additional properties or null

    • writeOpenMetadataArchive

      public void writeOpenMetadataArchive()
      Generates and writes out the open metadata archive created in the builder.

    • writeOpenMetadataArchive

      public void writeOpenMetadataArchive(String folderName)
      Generates and writes out the open metadata archive created in the builder.
      Parameters:
      folderName - name of the folder to add the archive into