Class SchemaType
java.lang.Object
org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
org.odpi.openmetadata.frameworks.connectors.properties.beans.GovernedReferenceable
org.odpi.openmetadata.frameworks.connectors.properties.beans.SchemaElement
org.odpi.openmetadata.frameworks.connectors.properties.beans.SchemaType
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
APIOperation
,APISchemaType
,ComplexSchemaType
,ExternalSchemaType
,LiteralSchemaType
,MapSchemaType
,SchemaTypeChoice
,SimpleSchemaType
The SchemaType object provides a base class for the pieces that make up a schema for a data asset. A schema provides information about how the data is structured in the asset. Schemas are typically described as nested structures of linked schema elements. Schemas can also be reused in other schemas.
Schema type has a number of subtypes that hold additional properties.
- PrimitiveSchemaType is for a leaf element in a schema.
- MapSchemaType is for an attribute of type Map
- APIOperation is for operations in an API
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
protected String
protected String
protected String
protected String
protected List<DerivedSchemaTypeQueryTarget>
protected String
protected String
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.SchemaElement
description, displayName, expression, expressionType, isCalculatedValue, isDeprecated
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.GovernedReferenceable
meanings, searchKeywords
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
additionalProperties, qualifiedName
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
extendedProperties, url
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
CURRENT_AUDIT_HEADER_VERSION
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns a clone of this object as the abstract SchemaElement class.Return a clone of this schema type.boolean
Compare the values of the supplied object with those stored in the current object.Return the name of the author of the schema element.Return the format (encoding standard) used for this schema.Return the formula used to combine the values of the queries.Return the specification language for the formula.Return the name of the namespace that this type belongs to.Return the list of queries that are used to create the derived schema element.getUsage()
Return the usage guidance for this schema element.Return the version number of the schema element - null means no version number.int
hashCode()
Hash of propertiesvoid
Set up the name of the author of the schema element.void
setEncodingStandard
(String encodingStandard) Set up the format (encoding standard) used for this schema.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
setNamespace
(String namespace) Set up the name of the namespace that this type belongs to.void
setQueries
(List<DerivedSchemaTypeQueryTarget> queries) Set up the list of queries that are used to create the derived schema element.void
Set up the usage guidance for this schema element.void
setVersionNumber
(String versionNumber) Set up the version number of the schema element - null means no version number.toString()
Standard toString method.Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.SchemaElement
getDescription, getDisplayName, getExpression, getExpressionType, getIsCalculatedValue, getIsDeprecated, setDescription, setDisplayName, setExpression, setExpressionType, setIsCalculatedValue, setIsDeprecated
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.GovernedReferenceable
getMeanings, getSearchKeywords, setMeanings, setSearchKeywords
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
getAdditionalProperties, getQualifiedName, setAdditionalProperties, setQualifiedName
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
getExtendedProperties, getURL, setExtendedProperties, setURL
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
getClassifications, getGUID, setClassifications, setGUID
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
getOrigin, getStatus, getType, getVersions, setOrigin, setStatus, setType, setVersions
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
getHeaderVersion, setHeaderVersion
-
Field Details
-
versionNumber
-
author
-
usage
-
encodingStandard
-
namespace
-
formula
-
formulaType
-
queries
-
-
Constructor Details
-
SchemaType
public SchemaType()Default constructor -
SchemaType
Copy/clone Constructor.- Parameters:
template
- template object to copy.
-
-
Method Details
-
getFormula
Return the formula used to combine the values of the queries. Each query is numbers 0, 1, ... and the formula has placeholders in it to show how the query results are combined.- Returns:
- String formula
-
setFormula
Set up the formula used to combine the values of the queries. Each query is numbers 0, 1, ... and the formula has placeholders in it to show how the query results are combined.- Parameters:
formula
- String formula
-
getFormulaType
Return the specification language for the formula.- Returns:
- string description
-
setFormulaType
Set up the specification language for the formula.- Parameters:
formulaType
- string description
-
getQueries
Return the list of queries that are used to create the derived schema element.- Returns:
- list of queries
-
setQueries
Set up the list of queries that are used to create the derived schema element.- Parameters:
queries
- list of queries
-
cloneSchemaElement
Returns a clone of this object as the abstract SchemaElement class.- Specified by:
cloneSchemaElement
in classSchemaElement
- Returns:
- SchemaElement
-
cloneSchemaType
Return a clone of this schema type.- Returns:
- Clone of subclass.
-
getVersionNumber
Return the version number of the schema element - null means no version number.- Returns:
- String version number
-
setVersionNumber
Set up the version number of the schema element - null means no version number.- Parameters:
versionNumber
- String version number
-
getAuthor
Return the name of the author of the schema element. Null means the author is unknown.- Returns:
- String author name
-
setAuthor
Set up the name of the author of the schema element. Null means the author is unknown.- Parameters:
author
- String author name
-
getUsage
Return the usage guidance for this schema element. Null means no guidance available.- Returns:
- String usage guidance
-
setUsage
Set up the usage guidance for this schema element. Null means no guidance available.- Parameters:
usage
- String usage guidance
-
getEncodingStandard
Return the format (encoding standard) used for this schema. It may be XML, JSON, SQL DDL or something else. Null means the encoding standard is unknown or there are many choices.- Returns:
- String encoding standard
-
setEncodingStandard
Set up the format (encoding standard) used for this schema. It may be XML, JSON, SQL DDL or something else. Null means the encoding standard is unknown or there are many choices.- Parameters:
encodingStandard
- String encoding standard
-
getNamespace
Return the name of the namespace that this type belongs to.- Returns:
- string name
-
setNamespace
Set up the name of the namespace that this type belongs to.- Parameters:
namespace
- string name
-
toString
Standard toString method.- Overrides:
toString
in classSchemaElement
- Returns:
- print out of variables in a JSON-style
-
equals
Compare the values of the supplied object with those stored in the current object.- Overrides:
equals
in classSchemaElement
- Parameters:
objectToCompare
- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Hash of properties- Overrides:
hashCode
in classSchemaElement
- Returns:
- int
-