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 ConfidenceGovernanceClassification	confidenceGovernanceClassification
protected ConfidentialityGovernanceClassification	confidentialityGovernanceClassification
protected CriticalityGovernanceClassification	criticalityGovernanceClassification
protected String	latestChange
protected LatestChange	latestChangeDetails
protected List<Meaning>	meanings
protected String	qualifiedName
protected RetentionGovernanceClassification	retentionGovernanceClassification
protected List<SearchKeyword>	searchKeywords
protected SecurityTags	securityTags

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

classifications, extendedProperties, guid, type, url

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

CURRENT_AUDIT_HEADER_VERSION

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.
ConfidenceGovernanceClassification	getConfidenceGovernanceClassification() Return the classification that defines how confident a user should be in the quality of the contents of this referenceable are.
ConfidentialityGovernanceClassification	getConfidentialityGovernanceClassification() Return the classification that defines how confidential the contents of this referenceable are.
CriticalityGovernanceClassification	getCriticalityGovernanceClassification() Return the classification that defines how critical this referenceable is to the business.
String	getLatestChange() Return a short description of the last change to the asset.
LatestChange	getLatestChangeDetails() Return full details of the latest change to the asset universe.
List<Meaning>	getMeanings() Return the assigned meanings for this metadata entity.
String	getQualifiedName() Returns the stored qualified name property for the metadata entity.
RetentionGovernanceClassification	getRetentionGovernanceClassification() Return the classification that defines when this referenceable will be archived and then permanently deleted.
List<SearchKeyword>	getSearchKeywords() Return a list of keywords that will help an asset consumer to locate this asset.
SecurityTags	getSecurityTags() Return the information used by security engines to secure access to the asset's content.
int	hashCode() Return has code based on properties.
void	setAdditionalProperties(Map<String,String> additionalProperties) Set up additional properties.
void	setConfidenceGovernanceClassification(ConfidenceGovernanceClassification confidenceGovernanceClassification) Set up the classification that defines how confident a user should be in the quality of the contents of this referenceable are.
void	setConfidentialityGovernanceClassification(ConfidentialityGovernanceClassification confidentialityGovernanceClassification) Set up the classification that defines how confidential the contents of this referenceable are.
void	setCriticalityGovernanceClassification(CriticalityGovernanceClassification criticalityGovernanceClassification) Set up the classification that defines how critical this referenceable is to the business.
void	setLatestChange(String latestChange) Set up a short description of the last change to the asset.
void	setLatestChangeDetails(LatestChange latestChangeDetails) Set up full details of the latest change to the asset universe.
void	setMeanings(List<Meaning> meanings) Set up the assigned meanings for this metadata entity.
void	setQualifiedName(String qualifiedName) Set up the fully qualified name.
void	setRetentionGovernanceClassification(RetentionGovernanceClassification retentionGovernanceClassification) Set up the classification that defines when this referenceable will be archived and then permanently deleted.
void	setSearchKeywords(List<SearchKeyword> searchKeywords) Set up a list of keywords that will help an asset consumer to locate this asset.
void	setSecurityTags(SecurityTags securityTags) Set up the information used by security engines to secure access to the asset's content.
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 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

qualifiedName

protected String qualifiedName

additionalProperties

protected Map<String,String> additionalProperties

meanings

protected List<Meaning> meanings

securityTags

protected SecurityTags securityTags

searchKeywords

protected List<SearchKeyword> searchKeywords

latestChange

protected String latestChange

latestChangeDetails

protected LatestChange latestChangeDetails

confidentialityGovernanceClassification

protected ConfidentialityGovernanceClassification confidentialityGovernanceClassification

confidenceGovernanceClassification

protected ConfidenceGovernanceClassification confidenceGovernanceClassification

criticalityGovernanceClassification

protected CriticalityGovernanceClassification criticalityGovernanceClassification

retentionGovernanceClassification

protected RetentionGovernanceClassification retentionGovernanceClassification

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

getSecurityTags

public SecurityTags getSecurityTags()

Return the information used by security engines to secure access to the asset's content.

Returns:

security labels and properties

setSecurityTags

public void setSecurityTags(SecurityTags securityTags)

Set up the information used by security engines to secure access to the asset's content.

Parameters:

securityTags - security labels and properties

getSearchKeywords

public List<SearchKeyword> getSearchKeywords()

Return a list of keywords that will help an asset consumer to locate this asset.

Returns:

list of strings

setSearchKeywords

public void setSearchKeywords(List<SearchKeyword> searchKeywords)

Set up a list of keywords that will help an asset consumer to locate this asset.

Parameters:

searchKeywords - list of strings

getLatestChange

public String getLatestChange()

Return a short description of the last change to the asset. If it is null it means the agent that last updated the asset did not provide a description.

Returns:

string description

setLatestChange

public void setLatestChange(String latestChange)

Set up a short description of the last change to the asset.

Parameters:

latestChange - string description

getLatestChangeDetails

public LatestChange getLatestChangeDetails()

Return full details of the latest change to the asset universe.

Returns:

latest change properties

setLatestChangeDetails

public void setLatestChangeDetails(LatestChange latestChangeDetails)

Set up full details of the latest change to the asset universe.

Parameters:

latestChangeDetails - latest change properties

getConfidentialityGovernanceClassification

public ConfidentialityGovernanceClassification getConfidentialityGovernanceClassification()

Return the classification that defines how confidential the contents of this referenceable are.

Returns:

confidentiality classification properties

setConfidentialityGovernanceClassification

public void setConfidentialityGovernanceClassification(ConfidentialityGovernanceClassification confidentialityGovernanceClassification)

Set up the classification that defines how confidential the contents of this referenceable are.

Parameters:

confidentialityGovernanceClassification - confidentiality classification properties

getConfidenceGovernanceClassification

public ConfidenceGovernanceClassification getConfidenceGovernanceClassification()

Return the classification that defines how confident a user should be in the quality of the contents of this referenceable are.

Returns:

confidence classification properties

setConfidenceGovernanceClassification

public void setConfidenceGovernanceClassification(ConfidenceGovernanceClassification confidenceGovernanceClassification)

Set up the classification that defines how confident a user should be in the quality of the contents of this referenceable are.

Parameters:

confidenceGovernanceClassification - confidence classification properties

getCriticalityGovernanceClassification

public CriticalityGovernanceClassification getCriticalityGovernanceClassification()

Return the classification that defines how critical this referenceable is to the business.

Returns:

criticality classification properties

setCriticalityGovernanceClassification

public void setCriticalityGovernanceClassification(CriticalityGovernanceClassification criticalityGovernanceClassification)

Set up the classification that defines how critical this referenceable is to the business.

Parameters:

criticalityGovernanceClassification - criticality classification properties

getRetentionGovernanceClassification

public RetentionGovernanceClassification getRetentionGovernanceClassification()

Return the classification that defines when this referenceable will be archived and then permanently deleted.

Returns:

retention classification properties

setRetentionGovernanceClassification

public void setRetentionGovernanceClassification(RetentionGovernanceClassification retentionGovernanceClassification)

Set up the classification that defines when this referenceable will be archived and then permanently deleted.

Parameters:

retentionGovernanceClassification - retention classification properties

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