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

Class SchemaLink

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

All Implemented Interfaces:

Serializable

public class SchemaLink
extends SchemaElement

SchemaLink defines a relationship between a SchemaAttribute and a SchemaType defined in an external schema. It is used in schemas that include external (standard) schema types in their definition.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	linkedSchemaTypeGUID
protected String	linkedSchemaTypeName
protected String	linkName
protected Map<String,String>	linkProperties
protected String	linkType

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

anchorGUID, description, displayName, 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
SchemaLink() Default constructor
SchemaLink(SchemaLink template) Copy/clone constructor makes a copy of the supplied object.

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.
String	getLinkedSchemaTypeGUID() Return the GUID of the schema type that this link connects together.
String	getLinkedSchemaTypeName() Return the name of the schema type that this link connects together.
String	getLinkName() Return the name of this link
Map<String,String>	getLinkProperties() Return the properties associated with this schema link.
String	getLinkType() Return the type of the link - this is related to the type of the schema it is a part of.
int	hashCode() Create a hash code for this element type.
void	setLinkedSchemaTypeGUID(String linkedSchemaTypeGUID) Set up the GUID of the schema type that this link connects together.
void	setLinkedSchemaTypeName(String linkedSchemaTypeName) Set up the name of the schema type that this link connects together.
void	setLinkName(String linkName) Set up the name of this link.
void	setLinkProperties(Map<String,String> linkProperties) Set up the properties associated with this schema link.
void	setLinkType(String linkType) Set up the type of the link - this is related to the type of the schema it is a part of.
String	toString() Standard toString method.

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

getAnchorGUID, getDescription, getDisplayName, isDeprecated, setAnchorGUID, setDeprecated, setDescription, setDisplayName

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

getAdditionalProperties, getMeanings, getQualifiedName, 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

linkType

protected String linkType

linkName

protected String linkName

linkProperties

protected Map<String,String> linkProperties

linkedSchemaTypeGUID

protected String linkedSchemaTypeGUID

linkedSchemaTypeName

protected String linkedSchemaTypeName

Constructor Detail

SchemaLink

public SchemaLink()

Default constructor

SchemaLink

public SchemaLink(SchemaLink template)

Copy/clone constructor makes a copy of the supplied object.

Parameters:

template - template object to copy

Method Detail

cloneSchemaElement

public SchemaElement cloneSchemaElement()

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

Specified by:

cloneSchemaElement in class SchemaElement

Returns:

SchemaElement

getLinkType

public String getLinkType()

Return the type of the link - this is related to the type of the schema it is a part of.

Returns:

String link type

setLinkType

public void setLinkType(String linkType)

Set up the type of the link - this is related to the type of the schema it is a part of.

Parameters:

linkType - String link type

getLinkName

public String getLinkName()

Return the name of this link

Returns:

String name

setLinkName

public void setLinkName(String linkName)

Set up the name of this link.

Parameters:

linkName - String name

getLinkProperties

public Map<String,String> getLinkProperties()

Return the properties associated with this schema link.

Returns:

property map

setLinkProperties

public void setLinkProperties(Map<String,String> linkProperties)

Set up the properties associated with this schema link.

Parameters:

linkProperties - property map

getLinkedSchemaTypeGUID

public String getLinkedSchemaTypeGUID()

Return the GUID of the schema type that this link connects together.

Returns:

unique identifier

setLinkedSchemaTypeGUID

public void setLinkedSchemaTypeGUID(String linkedSchemaTypeGUID)

Set up the GUID of the schema type that this link connects together.

Parameters:

linkedSchemaTypeGUID - unique identifier

getLinkedSchemaTypeName

public String getLinkedSchemaTypeName()

Return the name of the schema type that this link connects together.

Returns:

unique name

setLinkedSchemaTypeName

public void setLinkedSchemaTypeName(String linkedSchemaTypeName)

Set up the name of the schema type that this link connects together.

Parameters:

linkedSchemaTypeName - unique name

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 Referenceable

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Create a hash code for this element type.

Overrides:

hashCode in class Referenceable

Returns:

int hash code