Package org.odpi.openmetadata.accessservices.assetmanager.metadataelements

Class SchemaTypeElement

java.lang.Object
org.odpi.openmetadata.accessservices.assetmanager.metadataelements.SchemaTypeElement
All Implemented Interfaces:
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CorrelatedMetadataElement, org.odpi.openmetadata.frameworks.openmetadata.metadataelements.MetadataElement
public class SchemaTypeElement extends Object implements org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CorrelatedMetadataElement
SchemaTypeElement contains the properties and header for a schema type retrieved from the metadata repository.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SchemaTypeElement()
    Default constructor
    SchemaTypeElement(SchemaTypeElement template)
    Copy/clone constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Return comparison result based on the content of the properties.
    int
    getAttributeCount()
    Return the count of attributes in this schema type.
    List<org.odpi.openmetadata.frameworks.openmetadata.properties.MetadataCorrelationHeader>
    getCorrelationHeaders()
    Return the details of the external identifier and other correlation properties about the metadata source.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader
    getElementHeader()
    Return the element header associated with the properties.
    SchemaTypeElement
    getExternalSchemaType()
    Return the schema type that is reusable amongst assets.
    String
    getFormula()
    Return the formula used to combine the values of the queries.
    String
    getFormulaType()
    Return the specification language for the formula.
    SchemaTypeElement
    getMapFromElement()
    Return the type of schema element that represents the key or property name for the map.
    SchemaTypeElement
    getMapToElement()
    Return the type of schema element that represents the property value for the map.
    List<org.odpi.openmetadata.frameworks.openmetadata.properties.schema.DerivedSchemaTypeQueryTargetProperties>
    getQueries()
    Return the list of individual query targets for a derived column.
    List<SchemaTypeElement>
    getSchemaOptions()
    Return the list of alternative schema types that this attribute or asset may use.
    org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties
    getSchemaTypeProperties()
    Return the properties for the schema.
    int
    hashCode()
    Return hash code for this object
    void
    setAttributeCount(int attributeCount)
    Set up the count of attributes in this schema type
    void
    setCorrelationHeaders(List<org.odpi.openmetadata.frameworks.openmetadata.properties.MetadataCorrelationHeader> correlationHeaders)
    Set up the details of the external identifier and other correlation properties about the metadata source.
    void
    setElementHeader(org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader elementHeader)
    Set up the element header associated with the properties.
    void
    setExternalSchemaType(SchemaTypeElement externalSchemaType)
    Set up the schema type that is reusable amongst assets.
    void
    setFormula(String formula)
    Set up the formula used to combine the values of the queries.
    void
    setFormulaType(String formulaType)
    Set up the specification language for the formula.
    void
    setMapFromElement(SchemaTypeElement mapFromElement)
    Set up the type of schema element that represents the key or property name for the map.
    void
    setMapToElement(SchemaTypeElement mapToElement)
    Set up the type of schema element that represents the property value for the map.
    void
    setQueries(List<org.odpi.openmetadata.frameworks.openmetadata.properties.schema.DerivedSchemaTypeQueryTargetProperties> queries)
    Set up the list of individual query targets for a derived column.
    void
    setSchemaOptions(List<SchemaTypeElement> schemaOptions)
    Set up the list of alternative schema types that this attribute or asset may use.
    void
    setSchemaTypeProperties(org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties schemaTypeProperties)
    Set up the properties for the schema.
    String
    toString()
    JSON-style toString

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • SchemaTypeElement

      public SchemaTypeElement()
      Default constructor

    • SchemaTypeElement

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

  • Method Details

    • getElementHeader

      public org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader getElementHeader()
      Return the element header associated with the properties.
      Specified by:
      getElementHeader in interface org.odpi.openmetadata.frameworks.openmetadata.metadataelements.MetadataElement
      Returns:
      element header object

    • setElementHeader

      public void setElementHeader(org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader elementHeader)
      Set up the element header associated with the properties.
      Specified by:
      setElementHeader in interface org.odpi.openmetadata.frameworks.openmetadata.metadataelements.MetadataElement
      Parameters:
      elementHeader - element header object

    • getCorrelationHeaders

      public List<org.odpi.openmetadata.frameworks.openmetadata.properties.MetadataCorrelationHeader> getCorrelationHeaders()
      Return the details of the external identifier and other correlation properties about the metadata source. There is one entry in the list for each element in the third party technology that maps to the single open source element.
      Specified by:
      getCorrelationHeaders in interface org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CorrelatedMetadataElement
      Returns:
      list of correlation properties objects

    • setCorrelationHeaders

      public void setCorrelationHeaders(List<org.odpi.openmetadata.frameworks.openmetadata.properties.MetadataCorrelationHeader> correlationHeaders)
      Set up the details of the external identifier and other correlation properties about the metadata source. There is one entry in the list for each element in the third party technology that maps to the single open source element.
      Specified by:
      setCorrelationHeaders in interface org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CorrelatedMetadataElement
      Parameters:
      correlationHeaders - list of correlation properties objects

    • getSchemaTypeProperties

      public org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties getSchemaTypeProperties()
      Return the properties for the schema.
      Returns:
      schema properties (using appropriate subclass)

    • setSchemaTypeProperties

      public void setSchemaTypeProperties(org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaTypeProperties schemaTypeProperties)
      Set up the properties for the schema.
      Parameters:
      schemaTypeProperties - schema properties

    • getAttributeCount

      public int getAttributeCount()
      Return the count of attributes in this schema type.
      Returns:
      String data type name

    • setAttributeCount

      public void setAttributeCount(int attributeCount)
      Set up the count of attributes in this schema type
      Parameters:
      attributeCount - data type name

    • getMapFromElement

      public SchemaTypeElement getMapFromElement()
      Return the type of schema element that represents the key or property name for the map. This is also called the domain of the map.
      Returns:
      SchemaElement

    • setMapFromElement

      public void setMapFromElement(SchemaTypeElement mapFromElement)
      Set up the type of schema element that represents the key or property name for the map. This is also called the domain of the map.
      Parameters:
      mapFromElement - SchemaElement

    • getMapToElement

      public SchemaTypeElement getMapToElement()
      Return the type of schema element that represents the property value for the map. This is also called the range of the map.
      Returns:
      SchemaElement

    • setMapToElement

      public void setMapToElement(SchemaTypeElement mapToElement)
      Set up the type of schema element that represents the property value for the map. This is also called the range of the map.
      Parameters:
      mapToElement - SchemaType

    • getExternalSchemaType

      public SchemaTypeElement getExternalSchemaType()
      Return the schema type that is reusable amongst assets.
      Returns:
      bean describing external schema

    • setExternalSchemaType

      public void setExternalSchemaType(SchemaTypeElement externalSchemaType)
      Set up the schema type that is reusable amongst assets.
      Parameters:
      externalSchemaType - bean describing external schema

    • getSchemaOptions

      public List<SchemaTypeElement> getSchemaOptions()
      Return the list of alternative schema types that this attribute or asset may use.
      Returns:
      list of schema types

    • setSchemaOptions

      public void setSchemaOptions(List<SchemaTypeElement> schemaOptions)
      Set up the list of alternative schema types that this attribute or asset may use.
      Parameters:
      schemaOptions - list of schema types

    • getFormula

      public String getFormula()
      Return the formula used to combine the values of the queries. Each query is has a identifier and the formula has placeholders for these identifiers in it to show how the query results are combined.
      Returns:
      String formula

    • setFormula

      public void setFormula(String formula)
      Set up the formula used to combine the values of the queries. Each query is has a identifier and the formula has placeholders for these identifiers in it to show how the query results are combined.
      Parameters:
      formula - String formula

    • getFormulaType

      public String getFormulaType()
      Return the specification language for the formula.
      Returns:
      string description

    • setFormulaType

      public void setFormulaType(String formulaType)
      Set up the specification language for the formula.
      Parameters:
      formulaType - string description

    • getQueries

      public List<org.odpi.openmetadata.frameworks.openmetadata.properties.schema.DerivedSchemaTypeQueryTargetProperties> getQueries()
      Return the list of individual query targets for a derived column.
      Returns:
      list of queries and their target element

    • setQueries

      public void setQueries(List<org.odpi.openmetadata.frameworks.openmetadata.properties.schema.DerivedSchemaTypeQueryTargetProperties> queries)
      Set up the list of individual query targets for a derived column.
      Parameters:
      queries - list of queries and their target element

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Object
      Returns:
      return string containing the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class Object
      Returns:
      int hash code