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

Class SchemaElement

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MapSchemaElement, PrimitiveSchemaElement, Schema

public abstract class SchemaElement
extends Referenceable

The SchemaElement 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.

SchemaElement is an abstract class - used to enable the most accurate and precise mapping of the elements in a schema to the asset.

• PrimitiveSchemaElement is for a leaf element in a schema.
• Schema is a complex structure of nested schema elements.
• MapSchemaElement is for an attribute of type Map
• DerivedSchemaElement is for an attribute that is derived from other schema attributes

Most assets will be linked to a Schema.

Schema elements can be linked to one another using SchemaLink.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	author
protected String	encodingStandard
protected Map<String,Object>	schemaProperties
protected String	usage
protected String	versionNumber

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.ElementHeader

classifications, guid, type, url

Constructor Summary

Constructors

Constructor and Description
SchemaElement() Default constructor
SchemaElement(SchemaElement 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
abstract SchemaElement	cloneSchemaElement() Return a clone of this schema element.
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	getEncodingStandard() Return the format (encoding standard) used for this schema.
Map<String,Object>	getSchemaProperties() Return Set up schema properties - these are properties introduced in the implementation specific subclasses of schema element.
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	setEncodingStandard(String encodingStandard) Set up the format (encoding standard) used for this schema.
void	setSchemaProperties(Map<String,Object> schemaProperties) Set up schema properties - these are properties introduced in the implementation specific subclasses of schema element.
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, getQualifiedName, setAdditionalProperties, setQualifiedName

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

getClassifications, getGUID, getType, getURL, hashCode, setClassifications, setGUID, setType, setURL

Methods inherited from class java.lang.Object

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

Field Detail

versionNumber

protected String versionNumber

author

protected String author

usage

protected String usage

encodingStandard

protected String encodingStandard

schemaProperties

protected Map<String,Object> schemaProperties

Constructor Detail

SchemaElement

public SchemaElement()

Default constructor

SchemaElement

public SchemaElement(SchemaElement 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 abstract SchemaElement cloneSchemaElement()

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

Returns:

Either a Schema or a PrimitiveSchemaElement depending on the type of the template.

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

setSchemaProperties

public void setSchemaProperties(Map<String,Object> schemaProperties)

Set up schema properties - these are properties introduced in the implementation specific subclasses of schema element.

Parameters:

schemaProperties - properties map

getSchemaProperties

public Map<String,Object> getSchemaProperties()

Return Set up schema properties - these are properties introduced in the implementation specific subclasses of schema element. Null means no properties are available.

Returns:

property map

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 Referenceable

Returns:

print out of variables in a JSON-style