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

Class InformalTag

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

All Implemented Interfaces:

Serializable

public class InformalTag
extends ElementHeader

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 String	description
protected boolean	isPrivateTag
protected boolean	isPublic
protected String	name
protected String	user

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
InformalTag() Default constructor
InformalTag(InformalTag 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.
String	getDescription() Return the tag description null means no description is available.
boolean	getIsPrivateTag() Return boolean flag to say whether the tag is private or not.
boolean	getIsPublic() Return if the link to the tag is private to the creating user.
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
void	setDescription(String tagDescription) Set up the tag description null means no description is available.
void	setIsPrivateTag(boolean privateTag) Set up boolean flag to say whether the tag is private or not.
void	setIsPublic(boolean aPublic) Set up whether the link to the tag is private to the creating user or not.
void	setName(String name) Set up the name of the tag.
void	setUser(String user) Set up the user id of the person who created the tag.
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

isPublic

protected boolean isPublic

isPrivateTag

protected boolean isPrivateTag

name

protected String name

description

protected String description

user

protected String user

Constructor Detail

InformalTag

public InformalTag()

Default constructor

InformalTag

public InformalTag(InformalTag template)

Copy/clone constructor.

Parameters:

template - element to copy

Method Detail

getIsPublic

public boolean getIsPublic()

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

Returns:

boolean

setIsPublic

public void setIsPublic(boolean aPublic)

Set up whether the link to the tag is private to the creating user or not.

Parameters:

aPublic - boolean

getIsPrivateTag

public boolean getIsPrivateTag()

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.

Returns:

boolean is private flag

setIsPrivateTag

public void setIsPrivateTag(boolean privateTag)

Set up 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.

Parameters:

privateTag - indicator of a private tag

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

setUser

public void setUser(String user)

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

Parameters:

user - String identifier of the creator of the tag.

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 yet set, so null is a possible response.

Returns:

String tag name

setName

public void setName(String name)

Set up 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 yet set, so null is a possible response.

Parameters:

name - String tag name

getDescription

public String getDescription()

Return the tag description null means no description is available.

Returns:

String tag description

setDescription

public void setDescription(String tagDescription)

Set up the tag description null means no description is available.

Parameters:

tagDescription - tag description

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()

Hash of properties

Overrides:

hashCode in class ElementHeader

Returns:

int