org.odpi.openmetadata.frameworks.connectors.properties

Class AssetSchemaElement

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyElementBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

org.odpi.openmetadata.frameworks.connectors.properties.AssetSchemaElement

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AssetMapSchemaElement, AssetPrimitiveSchemaElement, AssetSchema

public abstract class AssetSchemaElement
extends AssetReferenceable

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 AssetMeanings	assetMeanings

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

referenceableBean

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

parentAsset

Constructor Summary

Constructors

Constructor and Description
AssetSchemaElement(AssetDescriptor parentAsset, AssetSchemaElement 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.
AssetSchemaElement(AssetDescriptor parentAsset, SchemaElement schemaElementBean, AssetMeanings assetMeanings) Bean constructor with parent asset
AssetSchemaElement(SchemaElement schemaElementBean, AssetMeanings assetMeanings) Bean constructor

Method Summary

Modifier and Type	Method and Description
protected abstract AssetSchemaElement	cloneAssetSchemaElement(AssetDescriptor parentAsset) 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.
AssetMeanings	getAssetMeanings() Return a list of the glossary terms attached to this referenceable object.
String	getAuthor() Return the name of the author of the schema element.
String	getEncodingStandard() Return the format (encoding standard) used for this schema.
protected abstract SchemaElement	getSchemaElementBean() Return this schema element bean.
AdditionalProperties	getSchemaProperties() Return the properties that come from the technology-specific subtypes of SchemaElement.
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.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

getAdditionalProperties, getQualifiedName, getReferenceableBean

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

getAssetClassifications, getElementHeaderBean, getGUID, getType, getURL, hashCode

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

getParentAsset, getParentAssetName, getParentAssetTypeName

Methods inherited from class java.lang.Object

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

Field Detail

assetMeanings

protected AssetMeanings assetMeanings

Constructor Detail

AssetSchemaElement

public AssetSchemaElement(SchemaElement schemaElementBean,
                          AssetMeanings assetMeanings)

Bean constructor

Parameters:

schemaElementBean - bean containing the schema element properties

assetMeanings - iterator for the asset assetMeanings

AssetSchemaElement

public AssetSchemaElement(AssetDescriptor parentAsset,
                          SchemaElement schemaElementBean,
                          AssetMeanings assetMeanings)

Bean constructor with parent asset

Parameters:

parentAsset - descriptor for parent asset

schemaElementBean - bean containing the schema element properties

assetMeanings - iterator for the asset assetMeanings

AssetSchemaElement

public AssetSchemaElement(AssetDescriptor parentAsset,
                          AssetSchemaElement 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:

parentAsset - description of the asset that this schema element is attached to.

templateSchema - template object to copy.

Method Detail

getAssetMeanings

public AssetMeanings getAssetMeanings()

Return a list of the glossary terms attached to this referenceable object. Null means no terms available.

Returns:

list of glossary terms (summary)

cloneAssetSchemaElement

protected abstract AssetSchemaElement cloneAssetSchemaElement(AssetDescriptor parentAsset)

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

Parameters:

parentAsset - description of the asset that this schema element is attached to.

Returns:

An instance of the this object's subclass

getSchemaElementBean

protected abstract SchemaElement getSchemaElementBean()

Return this schema element bean. This method is needed because SchemaElement is abstract.

Returns:

An instance of the appropriate subclass of SchemaElement bean

getVersionNumber

public String getVersionNumber()

Return the version number of the schema element - null means no version number.

Returns:

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

getUsage

public String getUsage()

Return the usage guidance for this schema element. Null means no guidance available.

Returns:

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

getSchemaProperties

public AdditionalProperties getSchemaProperties()

Return the properties that come from the technology-specific subtypes of SchemaElement.

Returns:

AdditionalProperties object

toString

public String toString()

Standard toString method.

Overrides:

toString in class AssetReferenceable

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:

equals in class AssetReferenceable

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison