Class SchemaTypeProperties
- java.lang.Object
-
- org.odpi.openmetadata.accessservices.datamanager.properties.ReferenceableProperties
-
- org.odpi.openmetadata.accessservices.datamanager.properties.SchemaElementProperties
-
- org.odpi.openmetadata.accessservices.datamanager.properties.SchemaTypeProperties
-
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
ComplexSchemaTypeProperties
,LiteralSchemaTypeProperties
,MapSchemaTypeProperties
,SchemaTypeChoiceProperties
,SchemaTypeRequestBody
,SimpleSchemaTypeProperties
public class SchemaTypeProperties extends SchemaElementProperties
SchemaTypeProperties carries the common parameters for creating or updating schema types.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description SchemaTypeProperties()
Default constructorSchemaTypeProperties(SchemaTypeProperties template)
Copy/clone Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object objectToCompare)
Compare the values of the supplied object with those stored in the current object.String
getAuthor()
Return the name of the author of the schema element.String
getEncodingStandard()
Return the format (encoding standard) used for this schema.String
getNamespace()
Return the name of the namespace that this type belongs to.String
getUsage()
Return the usage guidance for this schema element.String
getVersionNumber()
Return the version number of the schema element - null means no version number.int
hashCode()
Return hash code based on properties.void
setAuthor(String author)
Set up the name of the author of the schema element.void
setEncodingStandard(String encodingStandard)
Set up the format (encoding standard) used for this schema.void
setNamespace(String namespace)
Set up the name of the namespace that this type belongs to.void
setUsage(String usage)
Set up the usage guidance for this schema element.void
setVersionNumber(String versionNumber)
Set up the version number of the schema element - null means no version number.String
toString()
Standard toString method.-
Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.SchemaElementProperties
getDescription, getDisplayName, getIsDeprecated, setDescription, setDisplayName, setIsDeprecated
-
Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.ReferenceableProperties
getAdditionalProperties, getEffectiveFrom, getEffectiveTo, getExtendedProperties, getQualifiedName, getTypeName, getVendorProperties, setAdditionalProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setQualifiedName, setTypeName, setVendorProperties
-
-
-
-
Constructor Detail
-
SchemaTypeProperties
public SchemaTypeProperties()
Default constructor
-
SchemaTypeProperties
public SchemaTypeProperties(SchemaTypeProperties template)
Copy/clone Constructor.- Parameters:
template
- template object to copy.
-
-
Method Detail
-
getVersionNumber
public String getVersionNumber()
Return the version number of the schema element - null means no version number.- Returns:
- String version number
-
setVersionNumber
public void setVersionNumber(String versionNumber)
Set up the version number of the schema element - null means no version number.- Parameters:
versionNumber
- String version number
-
getAuthor
public String getAuthor()
Return the name of the author of the schema element. Null means the author is unknown.- Returns:
- String author name
-
setAuthor
public void setAuthor(String author)
Set up the name of the author of the schema element. Null means the author is unknown.- Parameters:
author
- String author name
-
getUsage
public String getUsage()
Return the usage guidance for this schema element. Null means no guidance available.- Returns:
- String usage guidance
-
setUsage
public void setUsage(String usage)
Set up the usage guidance for this schema element. Null means no guidance available.- Parameters:
usage
- String usage guidance
-
getEncodingStandard
public String getEncodingStandard()
Return the format (encoding standard) used for this schema. It may be XML, JSON, SQL DDL or something else. Null means the encoding standard is unknown or there are many choices.- Returns:
- String encoding standard
-
setEncodingStandard
public void setEncodingStandard(String encodingStandard)
Set up the format (encoding standard) used for this schema. It may be XML, JSON, SQL DDL or something else. Null means the encoding standard is unknown or there are many choices.- Parameters:
encodingStandard
- String encoding standard
-
getNamespace
public String getNamespace()
Return the name of the namespace that this type belongs to.- Returns:
- string name
-
setNamespace
public void setNamespace(String namespace)
Set up the name of the namespace that this type belongs to.- Parameters:
namespace
- string name
-
toString
public String toString()
Standard toString method.- Overrides:
toString
in classSchemaElementProperties
- 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 classSchemaElementProperties
- Parameters:
objectToCompare
- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()
Return hash code based on properties.- Overrides:
hashCode
in classSchemaElementProperties
- Returns:
- int
-
-