Class SearchKeyword
java.lang.Object
org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.SearchKeyword
- All Implemented Interfaces:
Serializable
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:
-
Field Summary
FieldsFields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
extendedProperties, url
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
CURRENT_AUDIT_HEADER_VERSION
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorSearchKeyword
(SearchKeyword template) Copy/clone constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compare the values of the supplied object with those stored in the current object.Return the keyword description null means no description is available.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
Set up the name of the keyword.toString()
Standard toString method.Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
getExtendedProperties, getURL, setExtendedProperties, setURL
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
getClassifications, getGUID, setClassifications, setGUID
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
getOrigin, getStatus, getType, getVersions, setOrigin, setStatus, setType, setVersions
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
getHeaderVersion, setHeaderVersion
-
Field Details
-
name
-
description
-
-
Constructor Details
-
SearchKeyword
public SearchKeyword()Default constructor -
SearchKeyword
Copy/clone constructor.- Parameters:
template
- element to copy
-
-
Method Details
-
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
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
Return the keyword description null means no description is available.- Returns:
- String keyword description
-
setDescription
Set up the keyword description null means no description is available.- Parameters:
keywordDescription
- keyword description
-
toString
Standard toString method.- Overrides:
toString
in classElementBase
- Returns:
- print out of variables in a JSON-style
-
equals
Compare the values of the supplied object with those stored in the current object.- Overrides:
equals
in classElementBase
- 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 classElementBase
- Returns:
- int
-