Class SchemaType
- java.lang.Object
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
-
- 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
public class SchemaType extends SchemaElement
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:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected Stringauthorprotected StringencodingStandardprotected Stringformulaprotected Stringnamespaceprotected List<DerivedSchemaTypeQueryTarget>queriesprotected Stringusageprotected StringversionNumber-
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.SchemaElement
anchorGUID, description, displayName, expression, isCalculatedValue, isDeprecated
-
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
additionalProperties, confidenceGovernanceClassification, confidentialityGovernanceClassification, criticalityGovernanceClassification, latestChange, latestChangeDetails, meanings, qualifiedName, retentionGovernanceClassification, searchKeywords, securityTags
-
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
classifications, extendedProperties, guid, type, url
-
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
CURRENT_AUDIT_HEADER_VERSION
-
-
Constructor Summary
Constructors Constructor Description SchemaType()Default constructorSchemaType(SchemaType template)Copy/clone Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SchemaElementcloneSchemaElement()Returns a clone of this object as the abstract SchemaElement class.SchemaTypecloneSchemaType()Return a clone of this schema type.booleanequals(Object objectToCompare)Compare the values of the supplied object with those stored in the current object.StringgetAuthor()Return the name of the author of the schema element.StringgetEncodingStandard()Return the format (encoding standard) used for this schema.StringgetFormula()Return the formula used to combine the values of the queries.StringgetNamespace()Return the name of the namespace that this type belongs to.List<DerivedSchemaTypeQueryTarget>getQueries()Return the list of queries that are used to create the derived schema element.StringgetUsage()Return the usage guidance for this schema element.StringgetVersionNumber()Return the version number of the schema element - null means no version number.inthashCode()Hash of propertiesvoidsetAuthor(String author)Set up the name of the author of the schema element.voidsetEncodingStandard(String encodingStandard)Set up the format (encoding standard) used for this schema.voidsetFormula(String formula)Set up the formula used to combine the values of the queries.voidsetNamespace(String namespace)Set up the name of the namespace that this type belongs to.voidsetQueries(List<DerivedSchemaTypeQueryTarget> queries)Set up the list of queries that are used to create the derived schema element.voidsetUsage(String usage)Set up the usage guidance for this schema element.voidsetVersionNumber(String versionNumber)Set up the version number of the schema element - null means no version number.StringtoString()Standard toString method.-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.SchemaElement
getAnchorGUID, getDescription, getDisplayName, getExpression, getIsDeprecated, isCalculatedValue, setAnchorGUID, setCalculatedValue, setDescription, setDisplayName, setExpression, setIsDeprecated
-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
getAdditionalProperties, getConfidenceGovernanceClassification, getConfidentialityGovernanceClassification, getCriticalityGovernanceClassification, getLatestChange, getLatestChangeDetails, getMeanings, getQualifiedName, getRetentionGovernanceClassification, getSearchKeywords, getSecurityTags, setAdditionalProperties, setConfidenceGovernanceClassification, setConfidentialityGovernanceClassification, setCriticalityGovernanceClassification, setLatestChange, setLatestChangeDetails, setMeanings, setQualifiedName, setRetentionGovernanceClassification, setSearchKeywords, setSecurityTags
-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
getClassifications, getExtendedProperties, getGUID, getType, getURL, setClassifications, setExtendedProperties, setGUID, setType, setURL
-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
getHeaderVersion, setHeaderVersion
-
-
-
-
Constructor Detail
-
SchemaType
public SchemaType()
Default constructor
-
SchemaType
public SchemaType(SchemaType template)
Copy/clone Constructor.- Parameters:
template- template object to copy.
-
-
Method Detail
-
getFormula
public String 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
public void setFormula(String formula)
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
-
getQueries
public List<DerivedSchemaTypeQueryTarget> getQueries()
Return the list of queries that are used to create the derived schema element.- Returns:
- list of queries
-
setQueries
public void setQueries(List<DerivedSchemaTypeQueryTarget> queries)
Set up the list of queries that are used to create the derived schema element.- Parameters:
queries- list of queries
-
cloneSchemaElement
public SchemaElement cloneSchemaElement()
Returns a clone of this object as the abstract SchemaElement class.- Specified by:
cloneSchemaElementin classSchemaElement- Returns:
- SchemaElement
-
cloneSchemaType
public SchemaType cloneSchemaType()
Return a clone of this schema type.- Returns:
- Clone of subclass.
-
getVersionNumber
public String getVersionNumber()
Return the version number of the schema element - null means no version number.- Returns:
- String version number
-
setVersionNumber
public void setVersionNumber(String versionNumber)
Set up the version number of the schema element - null means no version number.- Parameters:
versionNumber- String version number
-
getAuthor
public String getAuthor()
Return the name of the author of the schema element. Null means the author is unknown.- Returns:
- String author name
-
setAuthor
public void setAuthor(String author)
Set up the name of the author of the schema element. Null means the author is unknown.- Parameters:
author- String author name
-
getUsage
public String getUsage()
Return the usage guidance for this schema element. Null means no guidance available.- Returns:
- String usage guidance
-
setUsage
public void setUsage(String usage)
Set up the usage guidance for this schema element. Null means no guidance available.- Parameters:
usage- String usage guidance
-
getEncodingStandard
public String 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
public void setEncodingStandard(String encodingStandard)
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
public String getNamespace()
Return the name of the namespace that this type belongs to.- Returns:
- string name
-
setNamespace
public void setNamespace(String namespace)
Set up the name of the namespace that this type belongs to.- Parameters:
namespace- string name
-
toString
public String toString()
Standard toString method.- Overrides:
toStringin classSchemaElement- 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:
equalsin classSchemaElement- Parameters:
objectToCompare- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()
Hash of properties- Overrides:
hashCodein classSchemaElement- Returns:
- int
-
-