Package org.odpi.openmetadata.accessservices.datamanager.properties

Class SchemaElementProperties

java.lang.Object

org.odpi.openmetadata.accessservices.datamanager.properties.ReferenceableProperties

org.odpi.openmetadata.accessservices.datamanager.properties.SchemaElementProperties

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DatabaseTableProperties, DataContainerProperties, SchemaAttributeProperties, SchemaTypeProperties

public class SchemaElementProperties
extends ReferenceableProperties

SchemaElementProperties is a bean containing the common attributes for schema types and schema attributes

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SchemaElementProperties()	Default constructor
SchemaElementProperties(SchemaElementProperties template)	Copy/clone Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Compare the values of the supplied object with those stored in the current object.
String	getDescription()	Returns the stored description property for the schema element.
String	getDisplayName()	Return the simple name of the schema element.
boolean	getIsDeprecated()	Is the schema element deprecated?
int	hashCode()	Return hash code based on properties.
void	setDescription(String description)	Set up the stored description property for the schema element.
void	setDisplayName(String name)	Set up the simple name of the schema element.
void	setIsDeprecated(boolean deprecated)	Set whether the schema element deprecated or not.
String	toString()	Standard toString method.

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaElementProperties

public SchemaElementProperties()

Default constructor

SchemaElementProperties

public SchemaElementProperties(SchemaElementProperties template)

Copy/clone Constructor.

Parameters:

template - template object to copy.

Method Detail

getIsDeprecated

public boolean getIsDeprecated()

Is the schema element deprecated?

Returns:

boolean flag

setIsDeprecated

public void setIsDeprecated(boolean deprecated)

Set whether the schema element deprecated or not. Default is false.

Parameters:

deprecated - boolean flag

getDisplayName

public String getDisplayName()

Return the simple name of the schema element.

Returns:

string name

setDisplayName

public void setDisplayName(String name)

Set up the simple name of the schema element.

Parameters:

name - String display name

getDescription

public String getDescription()

Returns the stored description property for the schema element.

Returns:

string description

setDescription

public void setDescription(String description)

Set up the stored description property for the schema element.

Parameters:

description - string description

toString

public String toString()

Standard toString method.

Overrides:

toString in class ReferenceableProperties

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 ReferenceableProperties

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return hash code based on properties.

Overrides:

hashCode in class ReferenceableProperties

Returns:

int