org.odpi.openmetadata.frameworks.connectors.properties

Class AssetReferenceable

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyElementBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AssetCertification, AssetExternalIdentifier, AssetExternalReference, AssetLicense, AssetLocation, AssetNote, AssetNoteLog, AssetRelatedAsset, AssetSchemaAttribute, AssetSchemaElement, ConnectionProperties, ConnectorTypeProperties, EndpointProperties

public class AssetReferenceable
extends AssetElementHeader

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. There is also the possibility that referenceable may have meanings (glossary terms) and security tags assigned. Asset meanings are extracted on demand by the caller.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Referenceable	referenceableBean

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

parentAsset

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AssetReferenceable(AssetDescriptor parentAsset) Constructor used by the subclasses
	AssetReferenceable(AssetDescriptor parentAsset, AssetReferenceable template) Copy/clone constructor with parent asset.
protected	AssetReferenceable(AssetDescriptor parentAsset, Referenceable referenceableBean) Bean constructor with parent asset
protected	AssetReferenceable(Referenceable referenceableBean) Bean 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.
AdditionalProperties	getAdditionalProperties() Return a copy of the additional properties.
List<AssetMeaning>	getMeanings() Return a list of the glossary terms attached to this referenceable object.
String	getQualifiedName() Returns the stored qualified name property for the metadata entity.
protected Referenceable	getReferenceableBean() Return the bean for this referenceable.
AssetSecurityTags	getSecurityTags() Return the information used by security engines to secure access to the asset's content.
int	hashCode() Hash of properties
protected void	setBean(Referenceable referenceableBean) Set up the bean that contains the properties of the referenceable.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

getAssetClassifications, getElementHeaderBean, getExtendedProperties, getGUID, getType, getURL, setBean

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

getParentAsset, getParentAssetName, getParentAssetTypeName

Methods inherited from class java.lang.Object

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

Field Detail

referenceableBean

protected Referenceable referenceableBean

Constructor Detail

AssetReferenceable

protected AssetReferenceable(AssetDescriptor parentAsset)

Constructor used by the subclasses

Parameters:

parentAsset - descriptor of asset that this property relates to.

AssetReferenceable

protected AssetReferenceable(Referenceable referenceableBean)

Bean constructor

Parameters:

referenceableBean - bean containing all of the properties

AssetReferenceable

protected AssetReferenceable(AssetDescriptor parentAsset,
                             Referenceable referenceableBean)

Bean constructor with parent asset

Parameters:

parentAsset - descriptor for parent asset

referenceableBean - bean containing properties

AssetReferenceable

public AssetReferenceable(AssetDescriptor parentAsset,
                          AssetReferenceable template)

Copy/clone constructor with parent asset.

Parameters:

parentAsset - descriptor for parent asset

template - element to copy

Method Detail

setBean

protected void setBean(Referenceable referenceableBean)

Set up the bean that contains the properties of the referenceable.

Parameters:

referenceableBean - bean containing all of the properties

getReferenceableBean

protected Referenceable getReferenceableBean()

Return the bean for this referenceable.

Returns:

Referenceable object with all of the properties

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

getMeanings

public List<AssetMeaning> getMeanings()

Return a list of the glossary terms attached to this referenceable object. Null means no terms available.

Returns:

list of glossary terms (summary)

getSecurityTags

public AssetSecurityTags getSecurityTags()

Return the information used by security engines to secure access to the asset's content. Null means no tags available.

Returns:

security labels and properties

getAdditionalProperties

public AdditionalProperties getAdditionalProperties()

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

Returns:

AdditionalProperties

toString

public String toString()

Standard toString method.

Overrides:

toString in class AssetElementHeader

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 AssetElementHeader

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Hash of properties

Overrides:

hashCode in class AssetElementHeader

Returns:

int