org.odpi.openmetadata.frameworks.connectors.properties.beans

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, BoundedSchemaType, ComplexSchemaType, MapSchemaType, PrimitiveSchemaType

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
• BoundedSchemaType is for sets and arrays
• APIOperation is for operations in an API

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	author
protected String	displayName
protected String	encodingStandard
protected String	usage
protected String	versionNumber

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

additionalProperties, meanings, qualifiedName

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

classifications, extendedProperties, guid, type, url

Constructor Summary

Constructors

Constructor and Description
SchemaType() Default constructor
SchemaType(SchemaType templateSchema) Copy/clone Constructor - the parentAsset is passed separately to the template because it is also likely to be being cloned in the same operation and we want the definitions clone to point to the asset clone and not the original asset.

Method Summary

Modifier and Type	Method and Description
SchemaElement	cloneSchemaElement() Return a clone of this schema element.
SchemaType	cloneSchemaType() Return a clone of this schema type.
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
String	getAuthor() Return the name of the author of the schema element.
String	getDisplayName() Return the simple name of the schema type.
String	getEncodingStandard() Return the format (encoding standard) used for this schema.
String	getUsage() Return the usage guidance for this schema element.
String	getVersionNumber() Return the version number of the schema element - null means no version number.
void	setAuthor(String author) Set up the name of the author of the schema element.
void	setDisplayName(String name) Set up the simple name of the schema type.
void	setEncodingStandard(String encodingStandard) Set up the format (encoding standard) used for this schema.
void	setUsage(String usage) 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.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

getAdditionalProperties, getMeanings, getQualifiedName, hashCode, setAdditionalProperties, setMeanings, setQualifiedName

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 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

displayName

protected String displayName

versionNumber

protected String versionNumber

author

protected String author

usage

protected String usage

encodingStandard

protected String encodingStandard

Constructor Detail

SchemaType

public SchemaType()

Default constructor

SchemaType

public SchemaType(SchemaType templateSchema)

Copy/clone Constructor - the parentAsset is passed separately to the template because it is also likely to be being cloned in the same operation and we want the definitions clone to point to the asset clone and not the original asset.

Parameters:

templateSchema - template object to copy.

Method Detail

cloneSchemaElement

public SchemaElement cloneSchemaElement()

Return a clone of this schema element. This method is needed because schema element is abstract.

Specified by:

cloneSchemaElement in class SchemaElement

Returns:

Clone of subclass.

cloneSchemaType

public SchemaType cloneSchemaType()

Return a clone of this schema type. This method is needed because schema type is abstract.

Returns:

Clone of subclass.

getDisplayName

public String getDisplayName()

Return the simple name of the schema type.

Returns:

string name

setDisplayName

public void setDisplayName(String name)

Set up the simple name of the schema type.

Parameters:

name - String display name

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

equals

public boolean equals(Object objectToCompare)

Compare the values of the supplied object with those stored in the current object.

Overrides:

equals in class Referenceable

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

toString

public String toString()

Standard toString method.

Overrides:

toString in class SchemaElement

Returns:

print out of variables in a JSON-style