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

Class SearchKeyword

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

All Implemented Interfaces:

Serializable

public class SearchKeyword
extends ElementHeader

SearchKeyword stores information about a keyword connected to an asset. SearchKeyword provide informal classifications to assets and can be added at any time - typically by the asset owner or curator.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description
protected String	name

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
SearchKeyword() Default constructor
SearchKeyword(SearchKeyword 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 keyword description null means no description is available.
String	getName() Return the name of the keyword.
int	hashCode() Return code value representing the contents of this object.
void	setDescription(String keywordDescription) Set up the keyword description null means no description is available.
void	setName(String name) Set up the name of the keyword.
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

name

protected String name

description

protected String description

Constructor Detail

SearchKeyword

public SearchKeyword()

Default constructor

SearchKeyword

public SearchKeyword(SearchKeyword template)

Copy/clone constructor.

Parameters:

template - element to copy

Method Detail

getName

public String getName()

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

Returns:

String keyword name

setName

public void setName(String name)

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

Parameters:

name - String keyword name

getDescription

public String getDescription()

Return the keyword description null means no description is available.

Returns:

String keyword description

setDescription

public void setDescription(String keywordDescription)

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

Parameters:

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

Return code value representing the contents of this object.

Overrides:

hashCode in class ElementHeader

Returns:

int