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

Class ElementHeader

java.lang.Object

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

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GovernanceClassificationBase, InformalTag, LatestChange, Like, Meaning, Rating, Referenceable, SearchKeyword

public class ElementHeader
extends PropertyBase

ElementHeader provides the common identifier and type information for all properties objects that link off of the asset and have a guid associated with them. This typically means it is represented by an entity in the metadata repository.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ElementClassification>	classifications
protected Map<String,Object>	extendedProperties
protected String	guid
protected ElementType	type
protected String	url

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

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

Constructor	Description
ElementHeader()	Default constructor used by subclasses
ElementHeader(ElementHeader template)	Copy/clone constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Compare the values of the supplied object with those stored in the current object.
List<ElementClassification>	getClassifications()	Return the list of classifications associated with the asset.
Map<String,Object>	getExtendedProperties()	Return the properties that have been defined for a subtype of this object that are not supported explicitly by this bean.
String	getGUID()	Return the unique id for the properties object.
ElementType	getType()	Return the element type properties for this properties object.
String	getURL()	Returns the URL to access the properties object in the metadata repository.
int	hashCode()	Create a hash code for this element type.
void	setClassifications(List<ElementClassification> classifications)	Set up the classifications associated with this connection.
void	setExtendedProperties(Map<String,Object> extendedProperties)	Set up the properties that have been defined for a subtype of this object that are not supported explicitly by this bean.
void	setGUID(String guid)	Set up the guid for the element.
void	setType(ElementType type)	Set up the type of this element.
void	setURL(String url)	Set up the URL of this element.
String	toString()	Standard toString method.

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

getHeaderVersion, setHeaderVersion

Methods inherited from class java.lang.Object

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

Field Detail

type

protected ElementType type

guid

protected String guid

url

protected String url

classifications

protected List<ElementClassification> classifications

extendedProperties

protected Map<String,Object> extendedProperties

Constructor Detail

ElementHeader

public ElementHeader()

Default constructor used by subclasses

ElementHeader

public ElementHeader(ElementHeader template)

Copy/clone constructor.

Parameters:

template - element to copy

Method Detail

getType

public ElementType getType()

Return the element type properties for this properties object. These values are set up by the metadata repository and define details to the metadata entity used to represent this element.

Returns:

ElementType type information.

setType

public void setType(ElementType type)

Set up the type of this element.

Parameters:

type - element type properties

getGUID

public String getGUID()

Return the unique id for the properties object. Null means no guid is assigned.

Returns:

String unique id

setGUID

public void setGUID(String guid)

Set up the guid for the element.

Parameters:

guid - String unique identifier

getURL

public String getURL()

Returns the URL to access the properties object in the metadata repository. If no url is available then null is returned.

Returns:

String URL

setURL

public void setURL(String url)

Set up the URL of this element.

Parameters:

url - String

getClassifications

public List<ElementClassification> getClassifications()

Return the list of classifications associated with the asset. This is an list and the pointers are set to the start of the list of classifications

Returns:

Classifications list of classifications

setClassifications

public void setClassifications(List<ElementClassification> classifications)

Set up the classifications associated with this connection.

Parameters:

classifications - list of classifications

getExtendedProperties

public Map<String,Object> getExtendedProperties()

Return the properties that have been defined for a subtype of this object that are not supported explicitly by this bean.

Returns:

property map

setExtendedProperties

public void setExtendedProperties(Map<String,Object> extendedProperties)

Set up the properties that have been defined for a subtype of this object that are not supported explicitly by this bean.

Parameters:

extendedProperties - property map

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

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 PropertyBase

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 PropertyBase

Returns:

int hash code