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

Class Referenceable

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Asset, Certification, Comment, Connection, ConnectorType, Endpoint, ExternalIdentifier, ExternalReference, License, Location, Note, NoteLog, SchemaElement, SoftwareServerCapability, ValidValue

public class Referenceable
extends ElementHeader

Many open metadata entities are referenceable. It means that they have a qualified name and additional properties. In addition the Referenceable class adds support for the parent asset, guid, url and type for the entity through extending ElementHeader.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	additionalProperties
protected List<Meaning>	meanings
protected String	qualifiedName

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

classifications, extendedProperties, guid, type, url

Constructor Summary

Constructors

Constructor and Description
Referenceable() Default constructor
Referenceable(Referenceable template) Copy/clone constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
Map<String,String>	getAdditionalProperties() Return a copy of the additional properties.
List<Meaning>	getMeanings() Return the assigned meanings for this metadata entity.
String	getQualifiedName() Returns the stored qualified name property for the metadata entity.
int	hashCode() Return has code based on properties.
void	setAdditionalProperties(Map<String,String> additionalProperties) Set up additional properties.
void	setMeanings(List<Meaning> meanings) Set up the assigned meanings for this metadata entity.
void	setQualifiedName(String qualifiedName) Set up the fully qualified name.
String	toString() Standard toString method.

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

qualifiedName

protected String qualifiedName

additionalProperties

protected Map<String,String> additionalProperties

meanings

protected List<Meaning> meanings

Constructor Detail

Referenceable

public Referenceable()

Default constructor

Referenceable

public Referenceable(Referenceable template)

Copy/clone constructor. Retrieves values from the supplied template

Parameters:

template - element to copy

Method Detail

setQualifiedName

public void setQualifiedName(String qualifiedName)

Set up the fully qualified name.

Parameters:

qualifiedName - String name

getQualifiedName

public String getQualifiedName()

Returns the stored qualified name property for the metadata entity. If no qualified name is available then the empty string is returned.

Returns:

qualifiedName

setAdditionalProperties

public void setAdditionalProperties(Map<String,String> additionalProperties)

Set up additional properties.

Parameters:

additionalProperties - Additional properties object

getAdditionalProperties

public Map<String,String> getAdditionalProperties()

Return a copy of the additional properties. Null means no additional properties are available.

Returns:

AdditionalProperties

getMeanings

public List<Meaning> getMeanings()

Return the assigned meanings for this metadata entity.

Returns:

list of meanings

setMeanings

public void setMeanings(List<Meaning> meanings)

Set up the assigned meanings for this metadata entity.

Parameters:

meanings - list of meanings

toString

public String toString()

Standard toString method.

Overrides:

toString in class ElementHeader

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 ElementHeader

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return has code based on properties.

Overrides:

hashCode in class ElementHeader

Returns:

int