Package org.odpi.openmetadata.frameworks.openmetadata.metadataelements

Class ElementHeader

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader
Direct Known Subclasses:
ElementStub
public class ElementHeader extends ElementControlHeader
ElementHeader provides the common identifier and type information for all properties objects that link off of the asset and have a guid associated with them. This typically means it is represented by an entity in the metadata repository.

  • Constructor Details

    • ElementHeader

      public ElementHeader()
      Default constructor used by subclasses

    • ElementHeader

      public ElementHeader(ElementHeader template)
      Copy/clone constructor.
      Parameters:
      template - element to copy

    • ElementHeader

      public ElementHeader(ElementControlHeader template)
      Copy/clone constructor.
      Parameters:
      template - element to copy

  • Method Details

    • getGUID

      public String getGUID()
      Return the unique id for the properties object. Null means no guid is assigned.
      Returns:
      String unique id

    • setGUID

      public void setGUID(String guid)
      Set up the guid for the element.
      Parameters:
      guid - String unique identifier

    • getAnchor

      public ElementClassification getAnchor()
      Return the Anchors classification
      Returns:
      classification

    • setAnchor

      public void setAnchor(ElementClassification anchor)
      Set up the Anchors classification.
      Parameters:
      anchor - classification

    • getZoneMembership

      public ElementClassification getZoneMembership()
      Return the ZoneMembership classification.
      Returns:
      classification

    • setZoneMembership

      public void setZoneMembership(ElementClassification zoneMembership)
      Set up the ZoneMembership classification.
      Parameters:
      zoneMembership - classification

    • getZoneMembershipProfile

      public ElementClassification getZoneMembershipProfile()
      Return the ZoneMembershipProfile classification.
      Returns:
      classification

    • setZoneMembershipProfile

      public void setZoneMembershipProfile(ElementClassification zoneMembershipProfile)
      Set up the ZoneMembershipProfile classification.
      Parameters:
      zoneMembershipProfile - classification

    • getImpact

      public ElementClassification getImpact()
      Return the impact assessment for this element.
      Returns:
      classification

    • setImpact

      public void setImpact(ElementClassification impact)
      Set up the impact assessment for this element.
      Parameters:
      impact - classification

    • getCriticality

      public ElementClassification getCriticality()
      Return the criticality assessment for this element.
      Returns:
      classification

    • setCriticality

      public void setCriticality(ElementClassification criticality)
      Set up the criticality assessment for this element.
      Parameters:
      criticality - classification

    • getConfidentiality

      public ElementClassification getConfidentiality()
      Return the level of confidentiality assigned to this element.
      Returns:
      classification

    • setConfidentiality

      public void setConfidentiality(ElementClassification confidentiality)
      Set up the level of confidentiality assigned to this element.
      Parameters:
      confidentiality - classification

    • getConfidence

      public ElementClassification getConfidence()
      Return any confidence assessment associated with this element.
      Returns:
      classification

    • setConfidence

      public void setConfidence(ElementClassification confidence)
      Set up any confidence assessment associated with this element.
      Parameters:
      confidence - classification

    • getRetention

      public ElementClassification getRetention()
      Return any retention requirements.
      Returns:
      classification

    • setRetention

      public void setRetention(ElementClassification retention)
      Set up any retention requirements.
      Parameters:
      retention - classification

    • getGovernanceExpectations

      public ElementClassification getGovernanceExpectations()
      Return the governance expectations classification.
      Returns:
      classification

    • setGovernanceExpectations

      public void setGovernanceExpectations(ElementClassification governanceExpectations)
      Set up the governance expectations classification.
      Parameters:
      governanceExpectations - classifications

    • getGovernanceMeasurements

      public ElementClassification getGovernanceMeasurements()
      Return the governance measurements classification.
      Returns:
      classification

    • setGovernanceMeasurements

      public void setGovernanceMeasurements(ElementClassification governanceMeasurements)
      Set up the governance measurements classification.
      Parameters:
      governanceMeasurements - classification

    • getExecutionPoints

      public List<ElementClassification> getExecutionPoints()
      Return details of whether this element is identified as providing the implementation of one or more execution points.
      Returns:
      list

    • setExecutionPoints

      public void setExecutionPoints(List<ElementClassification> executionPoints)
      Set up details of whether this element is identified as providing the implementation of one or more execution points.
      Parameters:
      executionPoints - list

    • getDigitalResourceOrigin

      public ElementClassification getDigitalResourceOrigin()
      Return the DigitalResourceOrigin classification.
      Returns:
      classification

    • setDigitalResourceOrigin

      public void setDigitalResourceOrigin(ElementClassification digitalResourceOrigin)
      Set up the DigitalResourceOrigin classification.
      Parameters:
      digitalResourceOrigin - classification

    • getOwnership

      public ElementClassification getOwnership()
      Return the Ownership classification.
      Returns:
      classification

    • setOwnership

      public void setOwnership(ElementClassification ownership)
      Set up the Ownership classification.
      Parameters:
      ownership - classification

    • getMemento

      public ElementClassification getMemento()
      Return the memento classification that shows that the element has been archived.
      Returns:
      classification

    • setMemento

      public void setMemento(ElementClassification memento)
      Set up the memento classification that shows that the element has been archived.
      Parameters:
      memento - classification

    • getTemplate

      public ElementClassification getTemplate()
      Return whether this element has the Template classification that shows that the element is a template.
      Returns:
      classification

    • setTemplate

      public void setTemplate(ElementClassification template)
      Set up whether this element has the Template classification that shows that the element is a template.
      Parameters:
      template - classification

    • getTemplateSubstitute

      public ElementClassification getTemplateSubstitute()
      Return the classification that indicates this element is part of a template. It links to an element via the SourcedFrom relationship that the template logically links to using a significant relationship. The template substitute removes confusion that would occur if the template linked directly to this element using the significant relationship type.
      Returns:
      classification

    • setTemplateSubstitute

      public void setTemplateSubstitute(ElementClassification templateSubstitute)
      Set up the template substitute classification.
      Parameters:
      templateSubstitute - classification

    • getDuplicateClassifications

      public List<ElementClassification> getDuplicateClassifications()
      Return whether this element is involved in duplicate processing.
      Returns:
      list

    • setDuplicateClassifications

      public void setDuplicateClassifications(List<ElementClassification> duplicateClassifications)
      Set up whether this element is involved in duplicate processing.
      Parameters:
      duplicateClassifications - list

    • getSchemaType

      public ElementClassification getSchemaType()
      Return the TypeEmbeddedAttribute classification - only attached to a SchemaAttribute.
      Returns:
      classification

    • setSchemaType

      public void setSchemaType(ElementClassification schemaType)
      Set the TypeEmbeddedAttribute classification - only attached to a SchemaAttribute.
      Parameters:
      schemaType - classification

    • getDataScope

      public ElementClassification getDataScope()
      Return the DataScope classifications - used to describe the scope of data stored in the associated digital resource.
      Returns:
      classification

    • setDataScope

      public void setDataScope(ElementClassification dataScope)
      Set up the DataScope classifications - used to describe the scope of data stored in the associated digital resource.
      Parameters:
      dataScope - classification

    • getDataAssetEncoding

      public ElementClassification getDataAssetEncoding()
      Return the DataAssetEncoding classification that describes the encoding used in the associated digital resource.
      Returns:
      classification

    • setDataAssetEncoding

      public void setDataAssetEncoding(ElementClassification dataAssetEncoding)
      Set up the DataAssetEncoding classification that describes the encoding used in the associated digital resource.
      Parameters:
      dataAssetEncoding - classification

    • getCalculatedValue

      public ElementClassification getCalculatedValue()
      Return the CalculatedValue classification - only attached to a SchemaAttribute.
      Returns:
      classification

    • setCalculatedValue

      public void setCalculatedValue(ElementClassification calculatedValue)
      Set the CalculatedValue classification - only attached to a SchemaAttribute.
      Parameters:
      calculatedValue - classification

    • getPrimaryKey

      public ElementClassification getPrimaryKey()
      Return whether this element (TabularColumn) is a primary key.
      Returns:
      classification

    • setPrimaryKey

      public void setPrimaryKey(ElementClassification primaryKey)
      Set up whether this element (TabularColumn) is a primary key.
      Parameters:
      primaryKey - classification

    • getSecurityTags

      public ElementClassification getSecurityTags()
      Return the SecurityTags classification - attached to any referenceable metadata element.
      Returns:
      classification

    • setSecurityTags

      public void setSecurityTags(ElementClassification securityTags)
      Set up the SecurityTags classification - attached to any referenceable metadata element.
      Parameters:
      securityTags - classification

    • getSecurityListMembership

      public ElementClassification getSecurityListMembership()
      Return the SecurityListMembership classification - only attached to a user identity entity.
      Returns:
      classification

    • setSecurityListMembership

      public void setSecurityListMembership(ElementClassification securityListMembership)
      Set up the SecurityListMembership classification - only attached to a user identity entity.
      Parameters:
      securityListMembership - classification

    • getUserAccountProfile

      public ElementClassification getUserAccountProfile()
      Return the UserAccountProfile classification - only attached to a secrets collection entity.
      Returns:
      classification

    • setUserAccountProfile

      public void setUserAccountProfile(ElementClassification userAccountProfile)
      Set up the UserAccountProfile classification - only attached to a secrets collection entity.
      Parameters:
      userAccountProfile - classification

    • getKnownDuplicate

      public ElementClassification getKnownDuplicate()
      Return whether this element has a known duplicate.
      Returns:
      classification

    • setKnownDuplicate

      public void setKnownDuplicate(ElementClassification knownDuplicate)
      Set up whether this element has a known duplicate.
      Parameters:
      knownDuplicate - classification

    • getConsolidateDuplicate

      public ElementClassification getConsolidateDuplicate()
      Return whether this element is a consolidated duplication.
      Returns:
      classification

    • setConsolidateDuplicate

      public void setConsolidateDuplicate(ElementClassification consolidateDuplicate)
      Set up whether this element is a consolidated duplication.
      Parameters:
      consolidateDuplicate - classification

    • getProjectClassification

      public ElementClassification getProjectClassification()
      Return the properties that are used to classify the style and purpose of the project.
      Returns:
      classification

    • setProjectClassification

      public void setProjectClassification(ElementClassification projectClassification)
      Set up the properties that are used to classify the style and purpose of the project.
      Parameters:
      projectClassification - classification

    • getCollectionKinds

      public List<ElementClassification> getCollectionKinds()
      Return the optional list of category classifications found on a collection entity that indicate how a collection is being used.
      Returns:
      list of classifications

    • setCollectionKinds

      public void setCollectionKinds(List<ElementClassification> collectionKinds)
      Set up the optional list of category classifications found on a collection entity that indicate how a collection is being used.
      Parameters:
      collectionKinds - list of classifications

    • getLocationKinds

      public List<ElementClassification> getLocationKinds()
      Return the classifications associated with locations.
      Returns:
      list of classifications

    • setLocationKinds

      public void setLocationKinds(List<ElementClassification> locationKinds)
      Set up the classifications associated with locations.
      Parameters:
      locationKinds - list of classifications

    • getProjectKinds

      public List<ElementClassification> getProjectKinds()
      Return the optional list of category classifications found on a project entity that indicate how a collection is being used.
      Returns:
      list of classifications

    • setProjectKinds

      public void setProjectKinds(List<ElementClassification> projectKinds)
      Set up the optional list of category classifications found on a project entity that indicate how a collection is being used.
      Parameters:
      projectKinds - list of classifications

    • getOtherClassifications

      public List<ElementClassification> getOtherClassifications()
      Return the list of remaining classifications associated with the metadata element.
      Returns:
      Classifications list of classifications

    • setOtherClassifications

      public void setOtherClassifications(List<ElementClassification> otherClassifications)
      Set up the list of remaining classifications associated with this metadata element.
      Parameters:
      otherClassifications - list of classifications

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class ElementControlHeader
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class ElementControlHeader
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Create a hash code for this element type.
      Overrides:
      hashCode in class ElementControlHeader
      Returns:
      int hash code