org.odpi.openmetadata.frameworks.connectors.properties

Class AssetInformalTag

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.AssetInformalTag

All Implemented Interfaces:

Serializable

public class AssetInformalTag
extends AssetElementHeader

InformalTag stores information about a tag connected to an asset. InformalTags provide informal classifications to assets and can be added at any time. InformalTags have the userId of the person who added the tag, the name of the tag and its description. The content of the tag is a personal judgement (which is why the user's id is in the tag) and there is no formal review of the tags. However, they can be used as a basis for crowd-sourcing Glossary terms. Private InformalTags are only returned to the user that created them.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected InformalTag	informalTagBean

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

parentAsset

Constructor Summary

Constructors

Constructor and Description
AssetInformalTag(AssetDescriptor parentAsset, AssetInformalTag templateInformalTag) Copy/clone constructor.
AssetInformalTag(AssetDescriptor parentAsset, InformalTag informalTagBean) Bean constructor with parent asset
AssetInformalTag(InformalTag informalTagBean) 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.
String	getDescription() Return the tag description null means no description is available.
protected InformalTag	getInformalTagBean() Return the bean with all of the properties in it
String	getName() Return the name of the tag.
String	getUser() Return the user id of the person who created the tag.
int	hashCode() Hash of properties
boolean	isPrivateTag() Return boolean flag to say whether the tag is private or not.
boolean	isPublic() Return if the link to the tag is private to the creating user.
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

informalTagBean

protected InformalTag informalTagBean

Constructor Detail

AssetInformalTag

public AssetInformalTag(InformalTag informalTagBean)

Bean constructor

Parameters:

informalTagBean - bean containing the properties

AssetInformalTag

public AssetInformalTag(AssetDescriptor parentAsset,
                        InformalTag informalTagBean)

Bean constructor with parent asset

Parameters:

parentAsset - descriptor for parent asset

informalTagBean - bean containing the properties

AssetInformalTag

public AssetInformalTag(AssetDescriptor parentAsset,
                        AssetInformalTag templateInformalTag)

Copy/clone constructor.

Parameters:

parentAsset - descriptor for parent asset

templateInformalTag - element to copy

Method Detail

getInformalTagBean

protected InformalTag getInformalTagBean()

Return the bean with all of the properties in it

Returns:

informal tag bean

isPublic

public boolean isPublic()

Return if the link to the tag is private to the creating user.

Returns:

boolean

isPrivateTag

public boolean isPrivateTag()

Return boolean flag to say whether the tag is private or not. A private tag is only seen by the person who set it up. Public tags are visible to everyone who can see the asset description.

Returns:

boolean is private flag

getUser

public String getUser()

Return the user id of the person who created the tag. Null means the user id is not known.

Returns:

String tagging user

getName

public String getName()

Return the name of the tag. It is not valid to have a tag with no name. However, there is a point where the tag object is created and the tag name not set, so null is a possible response.

Returns:

String tag name

getDescription

public String getDescription()

Return the tag description null means no description is available.

Returns:

String tag description

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