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:

SchemaAttribute, SchemaType

public abstract class SchemaElement
extends Referenceable

The SchemaElement object provides a base class for the pieces that make up a schema for an asset. A schema provides information about how the data is structured in the asset. Schemas are typically described as nested structures of schema elements. There are two basic types:

• SchemaType describes the structure of data.
• SchemaAttribute describes the use of another schema as part of the structure within a bigger schema.

Assets are linked to a SchemaType.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description
protected String	displayName
protected boolean	isDeprecated

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
SchemaElement() Default constructor
SchemaElement(SchemaElement template) 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.
String	getDescription() Returns the stored description property for the schema element.
String	getDisplayName() Return the simple name of the schema element.
boolean	isDeprecated() Is the schema element deprecated?
void	setDeprecated(boolean deprecated) Set whether the schema element deprecated or not.
void	setDescription(String description) Set up the stored description property for the schema element.
void	setDisplayName(String name) Set up the simple name of the schema element.
String	toString() Standard toString method.

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

equals, 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

isDeprecated

protected boolean isDeprecated

displayName

protected String displayName

description

protected String description

Constructor Detail

SchemaElement

public SchemaElement()

Default constructor

SchemaElement

public SchemaElement(SchemaElement template)

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:

template - template object to copy.

Method Detail

isDeprecated

public boolean isDeprecated()

Is the schema element deprecated?

Returns:

boolean flag

setDeprecated

public void setDeprecated(boolean deprecated)

Set whether the schema element deprecated or not. Default is false.

Parameters:

deprecated - boolean flag

getDisplayName

public String getDisplayName()

Return the simple name of the schema element.

Returns:

string name

setDisplayName

public void setDisplayName(String name)

Set up the simple name of the schema element.

Parameters:

name - String display name

getDescription

public String getDescription()

Returns the stored description property for the schema element.

Returns:

string description

setDescription

public void setDescription(String description)

Set up the stored description property for the schema element.

Parameters:

description - string description

cloneSchemaElement

public abstract SchemaElement cloneSchemaElement()

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

Returns:

Clone of subclass.

toString

public String toString()

Standard toString method.

Overrides:

toString in class Referenceable

Returns:

print out of variables in a JSON-style