Package org.odpi.openmetadata.accessservices.datamanager.metadataelements

Class SchemaTypeElement

java.lang.Object

org.odpi.openmetadata.accessservices.datamanager.metadataelements.SchemaTypeElement

All Implemented Interfaces:

Serializable, MetadataElement

public class SchemaTypeElement
extends Object
implements MetadataElement, Serializable

SchemaTypeElement contains the properties and header for a reference data asset retrieved from the metadata repository.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SchemaTypeElement()	Default constructor
SchemaTypeElement(SchemaTypeElement template)	Copy/clone constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Return comparison result based on the content of the properties.
int	getAttributeCount()	Return the count of attributes in this schema type.
ElementHeader	getElementHeader()	Return the element header associated with the properties.
SchemaTypeElement	getExternalSchemaType()	Return the schema type that is reusable amongst assets.
String	getFormula()	Return the formula used to combine the values of the queries.
SchemaTypeElement	getMapFromElement()	Return the type of schema element that represents the key or property name for the map.
SchemaTypeElement	getMapToElement()	Return the type of schema element that represents the property value for the map.
List<DerivedSchemaTypeQueryTargetProperties>	getQueries()	Return the list of individual query targets for a derived column.
List<SchemaTypeElement>	getSchemaOptions()	Return the list of alternative schema types that this attribute or asset may use.
SchemaTypeProperties	getSchemaTypeProperties()	Return the properties for the schema.
int	hashCode()	Return hash code for this object
void	setAttributeCount(int attributeCount)	Set up the count of attributes in this schema type
void	setElementHeader(ElementHeader elementHeader)	Set up the element header associated with the properties.
void	setExternalSchemaType(SchemaTypeElement externalSchemaType)	Set up the schema type that is reusable amongst assets.
void	setFormula(String formula)	Set up the formula used to combine the values of the queries.
void	setMapFromElement(SchemaTypeElement mapFromElement)	Set up the type of schema element that represents the key or property name for the map.
void	setMapToElement(SchemaTypeElement mapToElement)	Set up the type of schema element that represents the property value for the map.
void	setQueries(List<DerivedSchemaTypeQueryTargetProperties> queries)	Set up the list of individual query targets for a derived column.
void	setSchemaOptions(List<SchemaTypeElement> schemaOptions)	Set up the list of alternative schema types that this attribute or asset may use.
void	setSchemaTypeProperties(SchemaTypeProperties schemaTypeProperties)	Set up the properties for the schema.
String	toString()	JSON-style toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaTypeElement

public SchemaTypeElement()

Default constructor

SchemaTypeElement

public SchemaTypeElement(SchemaTypeElement template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getElementHeader

public ElementHeader getElementHeader()

Return the element header associated with the properties.

Specified by:

getElementHeader in interface MetadataElement

Returns:

element header object

setElementHeader

public void setElementHeader(ElementHeader elementHeader)

Set up the element header associated with the properties.

Specified by:

setElementHeader in interface MetadataElement

Parameters:

elementHeader - element header object

getSchemaTypeProperties

public SchemaTypeProperties getSchemaTypeProperties()

Return the properties for the schema.

Returns:

schema properties (using appropriate subclass)

setSchemaTypeProperties

public void setSchemaTypeProperties(SchemaTypeProperties schemaTypeProperties)

Set up the properties for the schema.

Parameters:

schemaTypeProperties - schema properties

getAttributeCount

public int getAttributeCount()

Return the count of attributes in this schema type.

Returns:

String data type name

setAttributeCount

public void setAttributeCount(int attributeCount)

Set up the count of attributes in this schema type

Parameters:

attributeCount - data type name

getMapFromElement

public SchemaTypeElement getMapFromElement()

Return the type of schema element that represents the key or property name for the map. This is also called the domain of the map.

Returns:

SchemaElement

setMapFromElement

public void setMapFromElement(SchemaTypeElement mapFromElement)

Set up the type of schema element that represents the key or property name for the map. This is also called the domain of the map.

Parameters:

mapFromElement - SchemaElement

getMapToElement

public SchemaTypeElement getMapToElement()

Return the type of schema element that represents the property value for the map. This is also called the range of the map.

Returns:

SchemaElement

setMapToElement

public void setMapToElement(SchemaTypeElement mapToElement)

Set up the type of schema element that represents the property value for the map. This is also called the range of the map.

Parameters:

mapToElement - SchemaType

getExternalSchemaType

public SchemaTypeElement getExternalSchemaType()

Return the schema type that is reusable amongst assets.

Returns:

bean describing external schema

setExternalSchemaType

public void setExternalSchemaType(SchemaTypeElement externalSchemaType)

Set up the schema type that is reusable amongst assets.

Parameters:

externalSchemaType - bean describing external schema

getSchemaOptions

public List<SchemaTypeElement> getSchemaOptions()

Return the list of alternative schema types that this attribute or asset may use.

Returns:

list of schema types

setSchemaOptions

public void setSchemaOptions(List<SchemaTypeElement> schemaOptions)

Set up the list of alternative schema types that this attribute or asset may use.

Parameters:

schemaOptions - list of schema types

getFormula

public String getFormula()

Return the formula used to combine the values of the queries. Each query is has a identifier and the formula has placeholders for these identifiers 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 has a identifier and the formula has placeholders for these identifiers in it to show how the query results are combined.

Parameters:

formula - String formula

getQueries

public List<DerivedSchemaTypeQueryTargetProperties> getQueries()

Return the list of individual query targets for a derived column.

Returns:

list of queries and their target element

setQueries

public void setQueries(List<DerivedSchemaTypeQueryTargetProperties> queries)

Set up the list of individual query targets for a derived column.

Parameters:

queries - list of queries and their target element

toString

public String toString()

JSON-style toString

Overrides:

toString in class Object

Returns:

return string containing the property names and values

equals

public boolean equals(Object objectToCompare)

Return comparison result based on the content of the properties.

Overrides:

equals in class Object

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class Object

Returns:

int hash code