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

Class MapSchemaElement

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

All Implemented Interfaces:

Serializable

public class MapSchemaElement
extends SchemaElement

MapSchemaElement describes a schema element of type map. It stores the type of schema element for the domain (eg property name) for the map and the schema element for the range (eg property value) for the map.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected SchemaElement	mapFromElement
protected SchemaElement	mapToElement

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

author, encodingStandard, schemaProperties, usage, 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
MapSchemaElement() Default constructor
MapSchemaElement(MapSchemaElement 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() Returns a clone of this object as the abstract SchemaElement class.
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
SchemaElement	getMapFromElement() Return the type of schema element that represents the key or property name for the map.
SchemaElement	getMapToElement() Return the type of schema element that represents the property value for the map.
void	setMapFromElement(SchemaElement mapFromElement) Set up the type of schema element that represents the key or property name for the map.
void	setMapToElement(SchemaElement mapToElement) Set up the type of schema element that represents the property value for the map.
String	toString() Standard toString method.

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

getAuthor, getEncodingStandard, getSchemaProperties, getUsage, getVersionNumber, setAuthor, setEncodingStandard, setSchemaProperties, setUsage, setVersionNumber

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

mapFromElement

protected SchemaElement mapFromElement

mapToElement

protected SchemaElement mapToElement

Constructor Detail

MapSchemaElement

public MapSchemaElement()

Default constructor

MapSchemaElement

public MapSchemaElement(MapSchemaElement 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

getMapFromElement

public SchemaElement 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(SchemaElement 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 SchemaElement 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(SchemaElement 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 - SchemaElement

cloneSchemaElement

public SchemaElement cloneSchemaElement()

Returns a clone of this object as the abstract SchemaElement class.

Specified by:

cloneSchemaElement in class SchemaElement

Returns:

SchemaElement

toString

public String toString()

Standard toString method.

Overrides:

toString in class SchemaElement

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 SchemaElement

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison