Class GlossaryProperties
java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.glossaries.GlossaryProperties
GlossaryProperties is a class for representing a generic glossary.
-
Constructor Summary
ConstructorDescriptionDefault constructorGlossaryProperties
(GlossaryProperties 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 description of the glossary.Return a human memorable name for the glossary.Return the language that the glossary contents are written in.getUsage()
Return the expected usage of the glossary content.int
hashCode()
Return hash code based on properties.void
setDescription
(String description) Set up the description of the glossary.void
setDisplayName
(String displayName) Set up a human memorable name for the glossary.void
setLanguage
(String language) Set up the language that the glossary contents are written in.void
Set up the expected usage of the glossary content.toString()
Standard toString method.Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
getAdditionalProperties, getQualifiedName, getVendorProperties, setAdditionalProperties, setQualifiedName, setVendorProperties
Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
getEffectiveFrom, getEffectiveTo, getExtendedProperties, getTypeName, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setTypeName
-
Constructor Details
-
GlossaryProperties
public GlossaryProperties()Default constructor -
GlossaryProperties
Copy/clone constructor.- Parameters:
template
- object to copy
-
-
Method Details
-
getDisplayName
Return a human memorable name for the glossary.- Returns:
- string name
-
setDisplayName
Set up a human memorable name for the glossary.- Parameters:
displayName
- string name
-
getDescription
Return the description of the glossary.- Returns:
- string text
-
setDescription
Set up the description of the glossary.- Parameters:
description
- string text
-
getLanguage
Return the language that the glossary contents are written in.- Returns:
- string name
-
setLanguage
Set up the language that the glossary contents are written in.- Parameters:
language
- string name
-
getUsage
Return the expected usage of the glossary content.- Returns:
- string description
-
setUsage
Set up the expected usage of the glossary content.- Parameters:
usage
- string description
-
toString
Standard toString method.- Overrides:
toString
in classReferenceableProperties
- 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 classReferenceableProperties
- Parameters:
objectToCompare
- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Return hash code based on properties.- Overrides:
hashCode
in classReferenceableProperties
- Returns:
- int
-