Package org.odpi.openmetadata.repositoryservices.connectors.stores.archivestore.properties

Class OpenMetadataArchiveProperties

java.lang.Object
org.odpi.openmetadata.repositoryservices.connectors.stores.archivestore.properties.OpenMetadataArchiveElementHeader
org.odpi.openmetadata.repositoryservices.connectors.stores.archivestore.properties.OpenMetadataArchiveProperties
All Implemented Interfaces:
Serializable
public class OpenMetadataArchiveProperties extends OpenMetadataArchiveElementHeader
OpenMetadataArchiveProperties defines the properties of an open metadata archive. This includes the following properties:
  • Unique identifier (GUID) of the archive. This is used as the metadata collection id for the elements in the archive.
  • Archive name. This is used as the name of the metadata collection for the elements in the archive.
  • Archive description. This helps people choose which archive they want.
  • Archive Type (CONTENT_PACK or METADATA_EXPORT). A content pack is a reusable collection of metadata elements. A metadata export is an extraction of metadata from a cohort for backup/restore or to create metadata to send to a disconnected cohort.
  • Archive Version. A descriptive name for the version of this archive.
  • Originator name. This becomes the creation user id in the elements if it is not already specified.
  • Originator organization. Name of the organization that created the archive.
  • Originator license. The license associated with the metadata content. Null means no restrictions.
  • Creation date is the date that the archive was created. This will become the creationTime in the elements if not already specified.
  • GUIDs for archives that this archive depends on. This helps the open metadata repository services load the archives in the right order. Null here means no dependencies.
See Also:

  • Constructor Details

    • OpenMetadataArchiveProperties

      public OpenMetadataArchiveProperties()
      Default constructor that relies on initialization of variables in their declaration.

    • OpenMetadataArchiveProperties

      public OpenMetadataArchiveProperties(OpenMetadataArchiveProperties template)
      Copy/clone constructor
      Parameters:
      template - object to copy.

  • Method Details

    • getArchiveGUID

      public String getArchiveGUID()
      Return the unique identifier for this archive.
      Returns:
      String guid

    • setArchiveGUID

      public void setArchiveGUID(String archiveGUID)
      Set up the unique identifier for this open metadata archive.
      Parameters:
      archiveGUID - String guid

    • getArchiveName

      public String getArchiveName()
      Return the descriptive name for this open metadata archive.
      Returns:
      String name

    • setArchiveName

      public void setArchiveName(String archiveName)
      Set up the descriptive name for this open metadata archive.
      Parameters:
      archiveName - String name

    • getArchiveDescription

      public String getArchiveDescription()
      Return the description for this open metadata archive.
      Returns:
      String description

    • setArchiveDescription

      public void setArchiveDescription(String archiveDescription)
      Set up the description for this open metadata archive.
      Parameters:
      archiveDescription - String description

    • getArchiveType

      public OpenMetadataArchiveType getArchiveType()
      Return the type of this open metadata archive.
      Returns:
      OpenMetadataArchiveType enum

    • setArchiveType

      public void setArchiveType(OpenMetadataArchiveType archiveType)
      Set up the type of this open metadata archive.
      Parameters:
      archiveType - OpenMetadataArchiveType enum

    • getArchiveVersion

      public String getArchiveVersion()
      Return the descriptive version name for this archive.
      Returns:
      string version

    • setArchiveVersion

      public void setArchiveVersion(String archiveVersion)
      Set up the descriptive version name for this archive.
      Parameters:
      archiveVersion - string version

    • getOriginatorName

      public String getOriginatorName()
      Return the name of the originator of this open metadata archive. This will be used as the name of the creator for each element in the archive.
      Returns:
      String name

    • setOriginatorName

      public void setOriginatorName(String originatorName)
      Set up the name of the originator of this open metadata archive. This will be used as the name of the creator for each element in the archive.
      Parameters:
      originatorName - String name

    • getOriginatorOrganization

      public String getOriginatorOrganization()
      Return the name of the organization that provided this archive.
      Returns:
      String organization name

    • setOriginatorOrganization

      public void setOriginatorOrganization(String originatorOrganization)
      Set up the name of the organization that provided this archive.
      Parameters:
      originatorOrganization - String name

    • getOriginatorLicense

      public String getOriginatorLicense()
      Return the default license for all instance in this archive (this value can be overridden in individual instances in the archive). A null value means no restrictions.
      Returns:
      license string

    • setOriginatorLicense

      public void setOriginatorLicense(String originatorLicense)
      Set up the default license for all instances in this archive (this value can be overridden in individual instances in the archive). A null value means no restrictions.
      Parameters:
      originatorLicense - license string

    • getCreationDate

      public Date getCreationDate()
      Return the date that this open metadata archive was created.
      Returns:
      Date object

    • setCreationDate

      public void setCreationDate(Date creationDate)
      Set up the date that this open metadata archive was created.
      Parameters:
      creationDate - Date object

    • getDependsOnArchives

      public List<String> getDependsOnArchives()
      Return the list of GUIDs for open metadata archives that need to be loaded before this one.
      Returns:
      list of guids

    • setDependsOnArchives

      public void setDependsOnArchives(List<String> dependsOnArchives)
      Set up the list of GUIDs for open metadata archives that need to be loaded before this one.
      Parameters:
      dependsOnArchives - list of guids

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      JSON style description of variables.

    • equals

      public boolean equals(Object objectToCompare)
      Validate that an object is equal depending on their stored values.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - object
      Returns:
      boolean result

    • hashCode

      public int hashCode()
      Return a hash code based on the values of this object.
      Overrides:
      hashCode in class Object
      Returns:
      in hash code