Package org.odpi.openmetadata.frameworks.openmetadata.metadataelements

Class CollectionElement

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.metadataelements.AttributedMetadataElement

org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CollectionElement

All Implemented Interfaces:

MetadataElement

Direct Known Subclasses:

CollectionGraph

public class CollectionElement
extends AttributedMetadataElement

CollectionElement contains the properties and header for a collection retrieved from the metadata repository.

Constructor Summary

Constructors

Constructor	Description
CollectionElement()	Default constructor
CollectionElement(CollectionElement 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.
CollectionProperties	getProperties()	Return the properties of the collection.
RelatedBy	getRelatedBy()	Return details of the relationship used to retrieve this element.
int	hashCode()	Return hash code for this object
void	setProperties(CollectionProperties properties)	Set up the collection properties.
void	setRelatedBy(RelatedBy relatedBy)	Set up details of the relationship used to retrieve this element.
String	toString()	JSON-style toString

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.AttributedMetadataElement

getElementHeader, getExternalReferences, getMermaidGraph, getOtherRelatedElements, setElementHeader, setExternalReferences, setMermaidGraph, setOtherRelatedElements

Methods inherited from class java.lang.Object

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

Constructor Details

CollectionElement

public CollectionElement()

Default constructor

CollectionElement

public CollectionElement(CollectionElement template)

Copy/clone constructor

Parameters:

template - object to copy

Method Details

getProperties

public CollectionProperties getProperties()

Return the properties of the collection.

Returns:

properties

setProperties

public void setProperties(CollectionProperties properties)

Set up the collection properties.

Parameters:

properties - properties

getRelatedBy

public RelatedBy getRelatedBy()

Return details of the relationship used to retrieve this element. Will be null if the element was retrieved directly rather than via a relationship.

Returns:

list of element stubs

setRelatedBy

public void setRelatedBy(RelatedBy relatedBy)

Set up details of the relationship used to retrieve this element. Will be null if the element was retrieved directly rather than via a relationship.

Parameters:

relatedBy - relationship details

toString

public String toString()

JSON-style toString

Overrides:

toString in class AttributedMetadataElement

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 AttributedMetadataElement

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class AttributedMetadataElement

Returns:

int hash code