Package org.odpi.openmetadata.commonservices.generichandlers

Class SchemaTypeBuilder

java.lang.Object
org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericBuilder
org.odpi.openmetadata.commonservices.generichandlers.ReferenceableBuilder
org.odpi.openmetadata.commonservices.generichandlers.SchemaTypeBuilder
public class SchemaTypeBuilder extends ReferenceableBuilder
SchemaTypeBuilder manages the properties for a schema type. These properties may be stored in a schema type entity or a type embedded attribute classification (linked off of schema attribute).

  • Constructor Details

    • SchemaTypeBuilder

      public SchemaTypeBuilder(String qualifiedName, String displayName, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)
      Minimal constructor
      Parameters:
      qualifiedName - unique name
      displayName - new value for the display name.
      repositoryHelper - helper methods
      serviceName - name of this OMAS
      serverName - name of local server

    • SchemaTypeBuilder

      public SchemaTypeBuilder(String qualifiedName, String typeId, String typeName, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)
      Simple typed constructor
      Parameters:
      qualifiedName - unique name
      typeName - name of the type for this schema element
      typeId - unique identifier of the type for this schema element
      repositoryHelper - helper methods
      serviceName - name of this OMAS
      serverName - name of local server

    • SchemaTypeBuilder

      public SchemaTypeBuilder(String qualifiedName, String displayName, String description, String versionNumber, boolean isDeprecated, String author, String usage, String encodingStandard, String namespace, Map<String,String> additionalProperties, String typeId, String typeName, Map<String,Object> extendedProperties, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)
      Constructor supporting all common properties.
      Parameters:
      qualifiedName - unique name of schema type itself
      displayName - new value for the display name.
      description - description of the schema type.
      versionNumber - version of the schema type.
      isDeprecated - is the schema type deprecated
      author - name of the author
      usage - guidance on how the schema should be used.
      encodingStandard - format of the schema.
      namespace - namespace where the schema is defined.
      additionalProperties - additional properties
      typeName - unique name of schema sub type
      typeId - unique identifier of the schema subtype
      extendedProperties - properties from the subtype.
      repositoryHelper - helper methods
      serviceName - name of this OMAS
      serverName - name of local server

    • SchemaTypeBuilder

      public SchemaTypeBuilder(String qualifiedName, String displayName, String description, String versionNumber, boolean isDeprecated, String author, String usage, String encodingStandard, String namespace, String formula, Map<String,String> additionalProperties, String typeId, String typeName, Map<String,Object> extendedProperties, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)
      Constructor supporting all common properties and formula.
      Parameters:
      qualifiedName - unique name of schema type itself
      displayName - new value for the display name.
      description - description of the schema type.
      versionNumber - version of the schema type.
      isDeprecated - is the schema type deprecated
      author - name of the author
      usage - guidance on how the schema should be used.
      encodingStandard - format of the schema.
      namespace - namespace where the schema is defined.
      formula - formula for derived properties
      additionalProperties - additional properties
      typeName - unique name of schema sub type
      typeId - unique identifier of the schema subtype
      extendedProperties - properties from the subtype.
      repositoryHelper - helper methods
      serviceName - name of this OMAS
      serverName - name of local server

  • Method Details

    • setDataType

      public void setDataType(String dataType)
      Set up the type of data (for simple and literal types)
      Parameters:
      dataType - string name

    • setDefaultValue

      public void setDefaultValue(String defaultValue)
      Set up the default value of a field (for simple types).
      Parameters:
      defaultValue - string value

    • setFixedValue

      public void setFixedValue(String fixedValue)
      Set up the fixed data value (for literal types).
      Parameters:
      fixedValue - string value

    • setExternalSchemaTypeGUID

      public void setExternalSchemaTypeGUID(String guid)
      Set up the unique identifier for an external schema type.
      Parameters:
      guid - string guid

    • getExternalSchemaTypeGUID

      public String getExternalSchemaTypeGUID()
      Return the unique identifier for an external schema type.
      Returns:
      string guid

    • setValidValuesSetGUID

      public void setValidValuesSetGUID(String validValuesSetGUID)
      Set up the unique identifier of the valid values set that lists the permitted values for the attached schema attribute.
      Parameters:
      validValuesSetGUID - string guid

    • getValidValuesSetGUID

      public String getValidValuesSetGUID()
      Return the unique identifier of the valid values set that lists the permitted values for the attached schema attribute.
      Returns:
      string guid

    • setMapTypes

      public void setMapTypes(SchemaTypeBuilder mapFrom, SchemaTypeBuilder mapTo)
      Set up the builder to support a map type. This needs to point to two other schema types.
      Parameters:
      mapFrom - the type of the value that is in the domain of the map
      mapTo - the type of the value that is in the rage of the map

    • setMapGUIDs

      public void setMapGUIDs(String mapFromGUID, String mapToGUID)
      Set up the builder to support a map type. This needs to point to two other schema types.
      Parameters:
      mapFromGUID - the GUID of the value that is in the domain of the map
      mapToGUID - the GUID of the value that is in the rage of the map

    • getMapFrom

      public SchemaTypeBuilder getMapFrom()
      Return the builder for the type of the value that is in the domain of the map.
      Returns:
      builder for requested type

    • getMapTo

      public SchemaTypeBuilder getMapTo()
      Return the builder for the type of the value that is in the range of the map.
      Returns:
      builder for requested type

    • getMapFromGUID

      public String getMapFromGUID()
      Return the GUID for the type of the value that is in the domain of the map.
      Returns:
      string

    • getMapToGUID

      public String getMapToGUID()
      Return the GUID for the type of the value that is in the range of the map.
      Returns:
      string

    • setSchemaOptions

      public void setSchemaOptions(List<SchemaTypeBuilder> schemaOptions)
      Set up the list of types that are represented by a schema option type.
      Parameters:
      schemaOptions - list of builders

    • getSchemaOptions

      public List<SchemaTypeBuilder> getSchemaOptions()
      Return the list of types that are represented by a schema option type.
      Returns:
      list of builders

    • setDerivedProperties

      public void setDerivedProperties(String formula)
      Set up the properties that indicate that the schema element's value is not stored, it is derived from other values. The formula is stored in the CalculatedValue classification. If it is null, the queries are ignored. The queries are each stored as a DerivedSchemaTypeQueryTarget.
      Parameters:
      formula - expression, possibly with place holders to insert the values returned from the queries

    • isDerived

      public boolean isDerived()
      Return whether the schema has a derived value of not. This is determined from the setting of formula
      Returns:
      boolean

    • getCalculatedValueProperties

      public InstanceProperties getCalculatedValueProperties(String methodName)
      Return the schema type properties in an InstanceProperties object.
      Parameters:
      methodName - name of the calling method
      Returns:
      InstanceProperties object

    • getInstanceProperties

      public InstanceProperties getInstanceProperties(String methodName) throws InvalidParameterException
      Return the supplied bean properties in an InstanceProperties object.
      Overrides:
      getInstanceProperties in class ReferenceableBuilder
      Parameters:
      methodName - name of the calling method
      Returns:
      InstanceProperties object
      Throws:
      InvalidParameterException - there is a problem with the properties

    • getTypeEmbeddedInstanceProperties

      public InstanceProperties getTypeEmbeddedInstanceProperties(String methodName) throws InvalidParameterException
      Return the supplied bean properties in an InstanceProperties object for a TypeEmbeddedAttribute classification. If the caller uses this when there are extended properties defined for the builder then the call to create or add the entity will fail with invalid properties.
      Parameters:
      methodName - name of the calling method
      Returns:
      InstanceProperties object
      Throws:
      InvalidParameterException - there is a problem with the properties