org.odpi.openmetadata.accessservices.datamanager.properties

Class TabularColumnProperties

java.lang.Object

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

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

org.odpi.openmetadata.accessservices.datamanager.properties.SchemaAttributeProperties

org.odpi.openmetadata.accessservices.datamanager.properties.TabularColumnProperties

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DatabaseColumnProperties

public class TabularColumnProperties
extends SchemaAttributeProperties

TabularColumnProperties is a class for representing a column within a table type structure. Tabular columns are schema attributes with a simple type attached

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TabularColumnProperties() Default constructor used by subclasses
TabularColumnProperties(TabularColumnProperties 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	getDataType() Return the data type for this element.
String	getDefaultValue() Return the default value for the element.
String	getExternalTypeGUID() Return the unique identifier of this column's type.
String	getFixedValue() Return a fixed literal value - an alternative to default value.
String	getValidValuesSetGUID() Return the set of valid values for this column.
int	hashCode() Return has code based on properties.
void	setDataType(String dataType) Set up the data type for this element.
void	setDefaultValue(String defaultValue) Set up the default value for the element.
void	setExternalTypeGUID(String externalTypeGUID) If the type of this column is represented by an external (standard type) put its value here.
void	setFixedValue(String fixedValue) If the column contains a fixed literal value, set this value here - an alternative to default value.
void	setValidValuesSetGUID(String validValuesSetGUID) If the type is controlled by a fixed set of values, set up the unique identifier of the valid values set that lists the valid values.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.SchemaAttributeProperties

getAliases, getAllowsDuplicateValues, getDefaultValueOverride, getElementPosition, getIsNullable, getLength, getMaxCardinality, getMinCardinality, getMinimumLength, getNativeJavaClass, getOrderedValues, getPrecision, getSchemaType, getSortOrder, setAliases, setAllowsDuplicateValues, setDefaultValueOverride, setElementPosition, setIsNullable, setLength, setMaxCardinality, setMinCardinality, setMinimumLength, setNativeJavaClass, setOrderedValues, setPrecision, setSchemaType, setSortOrder

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, getExtendedProperties, getQualifiedName, getTypeName, getVendorProperties, setAdditionalProperties, setExtendedProperties, setQualifiedName, setTypeName, setVendorProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

TabularColumnProperties

public TabularColumnProperties()

Default constructor used by subclasses

TabularColumnProperties

public TabularColumnProperties(TabularColumnProperties template)

Copy/clone Constructor.

Parameters:

template - template object to copy.

Method Detail

getDataType

public String getDataType()

Return the data type for this element. Null means unknown data type.

Returns:

string data type name

setDataType

public void setDataType(String dataType)

Set up the data type for this element. Null means unknown data type.

Parameters:

dataType - data type name

getDefaultValue

public String getDefaultValue()

Return the default value for the element. Null means no default value set up.

Returns:

string containing default value

setDefaultValue

public void setDefaultValue(String defaultValue)

Set up the default value for the element. Null means no default value set up.

Parameters:

defaultValue - String containing default value

getFixedValue

public String getFixedValue()

Return a fixed literal value - an alternative to default value.

Returns:

string value

setFixedValue

public void setFixedValue(String fixedValue)

If the column contains a fixed literal value, set this value here - an alternative to default value.

Parameters:

fixedValue - string

getExternalTypeGUID

public String getExternalTypeGUID()

Return the unique identifier of this column's type.

Returns:

unique identifier (guid) of the external schema type

setExternalTypeGUID

public void setExternalTypeGUID(String externalTypeGUID)

If the type of this column is represented by an external (standard type) put its value here. No need to set dataType, FixedType or defaultType

Parameters:

externalTypeGUID - unique identifier (guid) of the external schema type

getValidValuesSetGUID

public String getValidValuesSetGUID()

Return the set of valid values for this column.

Returns:

unique identifier (guid) of the valid values set

setValidValuesSetGUID

public void setValidValuesSetGUID(String validValuesSetGUID)

If the type is controlled by a fixed set of values, set up the unique identifier of the valid values set that lists the valid values.

Parameters:

validValuesSetGUID - unique identifier (guid) of the valid values set

toString

public String toString()

Standard toString method.

Overrides:

toString in class SchemaAttributeProperties

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 SchemaAttributeProperties

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return has code based on properties.

Overrides:

hashCode in class SchemaAttributeProperties

Returns:

int