Package org.odpi.openmetadata.accessservices.assetmanager.properties

Class GlossaryTermProperties

java.lang.Object

org.odpi.openmetadata.accessservices.assetmanager.properties.ReferenceableProperties

org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermProperties

All Implemented Interfaces:

Serializable

public class GlossaryTermProperties
extends ReferenceableProperties

GlossaryTermProperties contains the semantic definition (meaning) of a word or phrase (term - collectively called terminology).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
GlossaryTermProperties()	Default constructor
GlossaryTermProperties(GlossaryTermProperties 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.
String	getAbbreviation()	Return the abbreviation used for this term.
String	getDescription()	Returns the stored description property for the term.
String	getDisplayName()	Returns the stored display name property for the term.
String	getExamples()	Set up the description of one or more examples.
String	getSummary()	Return the short (1-2 sentence) description of the term.
String	getUsage()	Return details of the expected usage of this term.
int	hashCode()	Return hash code for this object
void	setAbbreviation(String abbreviation)	Set up the abbreviation used for this term.
void	setDescription(String description)	Set up the stored description property for the term.
void	setDisplayName(String displayName)	Set up the stored display name property for the term.
void	setExamples(String examples)	Return the description of one or more examples.
void	setSummary(String summary)	Set up the short (1-2 sentence) description of the term.
void	setUsage(String usage)	Set up details of the expected usage of this term.
String	toString()	JSON-style toString

Methods inherited from class org.odpi.openmetadata.accessservices.assetmanager.properties.ReferenceableProperties

getAdditionalProperties, getEffectiveFrom, getEffectiveTo, getExtendedProperties, getQualifiedName, getTypeName, getVendorProperties, setAdditionalProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setQualifiedName, setTypeName, setVendorProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

GlossaryTermProperties

public GlossaryTermProperties()

Default constructor

GlossaryTermProperties

public GlossaryTermProperties(GlossaryTermProperties template)

Copy/clone constructor.

Parameters:

template - object to copy

Method Detail

getDisplayName

public String getDisplayName()

Returns the stored display name property for the term. If no display name is available then null is returned.

Returns:

String name

setDisplayName

public void setDisplayName(String displayName)

Set up the stored display name property for the term.

Parameters:

displayName - String name

getSummary

public String getSummary()

Return the short (1-2 sentence) description of the term.

Returns:

string text

setSummary

public void setSummary(String summary)

Set up the short (1-2 sentence) description of the term.

Parameters:

summary - string text

getDescription

public String getDescription()

Returns the stored description property for the term. If no description is provided then null is returned.

Returns:

String text

setDescription

public void setDescription(String description)

Set up the stored description property for the term.

Parameters:

description - String text

getExamples

public String getExamples()

Set up the description of one or more examples.

Returns:

string text

setExamples

public void setExamples(String examples)

Return the description of one or more examples.

Parameters:

examples - string text

getAbbreviation

public String getAbbreviation()

Return the abbreviation used for this term.

Returns:

string text

setAbbreviation

public void setAbbreviation(String abbreviation)

Set up the abbreviation used for this term.

Parameters:

abbreviation - string text

getUsage

public String getUsage()

Return details of the expected usage of this term.

Returns:

string text

setUsage

public void setUsage(String usage)

Set up details of the expected usage of this term.

Parameters:

usage - string text

toString

public String toString()

JSON-style toString

Overrides:

toString in class ReferenceableProperties

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 ReferenceableProperties

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class ReferenceableProperties

Returns:

int hash code