org.odpi.openmetadata.accessservices.dataengine.model

Class Attribute

java.lang.Object

org.odpi.openmetadata.accessservices.dataengine.model.Referenceable

org.odpi.openmetadata.accessservices.dataengine.model.Attribute

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

RelationalColumn

public class Attribute
extends Referenceable

The type Attribute.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Attribute()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<String>	getAliases() Return a list of alternative names for the attribute.
boolean	getAllowsDuplicateValues() Return whether the same value can be used by more than one instance of this attribute.
String	getAnchorGUID() Gets anchor guid.
String	getDataType() Return the data type for this element.
String	getDefaultValue() Return the default value for the element.
String	getDefaultValueOverride() Return any default value for this attribute that would override the default defined in the schema element for this attribute's type (note only used is type is primitive).
String	getDescription() Returns the stored description property for the schema element.
String	getDisplayName() Return the simple name of the schema element.
String	getExternalTypeGUID() Return the unique identifier of this column's type.
String	getFixedValue() Return a fixed literal value - an alternative to default value.
int	getLength() Return the length of the data field.
int	getMaxCardinality() Return the maximum number of instances allowed for this attribute.
int	getMinCardinality() Return this minimum number of instances allowed for this attribute.
int	getMinimumLength() Return the minimum length of the data.
String	getNativeClass() Return the name of the Java class to use to represent this type.
boolean	getOrderedValues() Return whether the attribute instances are arranged in an order.
int	getPosition() Return the position of this schema attribute in its parent schema.
int	getPrecision() Return the number of significant digits to the right of decimal point.
DataItemSortOrder	getSortOrder() Return the order that the attribute instances are arranged in - if any.
String	getValidValuesSetGUID() Return the set of valid values for this column.
int	hashCode()
boolean	isDeprecated() Returns true if the schema element deprecated
boolean	isNullable() Return whether the field is nullable or not.
void	setAliases(List<String> aliases) Set up a list of alternative names for the attribute.
void	setAllowsDuplicateValues(boolean allowsDuplicateValues) Set up whether the same value can be used by more than one instance of this attribute.
void	setAnchorGUID(String anchorGUID) Sets anchor guid.
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	setDefaultValueOverride(String defaultValueOverride) Set up any default value for this attribute that would override the default defined in the schema element for this attribute's type (note only used is type is primitive).
void	setDeprecated(boolean deprecated) Set whether the schema element deprecated or not.
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	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	setLength(int length) Set up the length of the data field.
void	setMaxCardinality(int maxCardinality) Set up the maximum number of instances allowed for this attribute.
void	setMinCardinality(int minCardinality) Set up the minimum number of instances allowed for this attribute.
void	setMinimumLength(int minimumLength) Set up the minimum length of the data.
void	setNativeClass(String nativeClass) Set up the name of the Java class to use to represent this type.
void	setNullable(boolean nullable) Set up whether the field is nullable or not.
void	setOrderedValues(boolean orderedValues) Set up whether the attribute instances are arranged in an order.
void	setPosition(int position) Set up the position of this schema attribute in its parent schema.
void	setPrecision(int precision) Set up the number of significant digits to the right of decimal point.
void	setSortOrder(DataItemSortOrder sortOrder) Set up the order that the attribute instances are arranged in - if any.
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()

Methods inherited from class org.odpi.openmetadata.accessservices.dataengine.model.Referenceable

getAdditionalProperties, getQualifiedName, setAdditionalProperties, setQualifiedName

Methods inherited from class java.lang.Object

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

Constructor Detail

Attribute

public Attribute()

Method Detail

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

isDeprecated

public boolean isDeprecated()

Returns true if the schema element deprecated

Returns:

boolean flag

setDeprecated

public void setDeprecated(boolean deprecated)

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

Parameters:

deprecated - boolean flag

getPosition

public int getPosition()

Return the position of this schema attribute in its parent schema.

Returns:

int position in schema - 0 means first

setPosition

public void setPosition(int position)

Set up the position of this schema attribute in its parent schema.

Parameters:

position - int position in schema - 0 means first

getMinCardinality

public int getMinCardinality()

Return this minimum number of instances allowed for this attribute.

Returns:

int

setMinCardinality

public void setMinCardinality(int minCardinality)

Set up the minimum number of instances allowed for this attribute.

Parameters:

minCardinality - int

getMaxCardinality

public int getMaxCardinality()

Return the maximum number of instances allowed for this attribute.

Returns:

int (-1 means infinite)

setMaxCardinality

public void setMaxCardinality(int maxCardinality)

Set up the maximum number of instances allowed for this attribute.

Parameters:

maxCardinality - int (-1 means infinite)

getAllowsDuplicateValues

public boolean getAllowsDuplicateValues()

Return whether the same value can be used by more than one instance of this attribute.

Returns:

boolean flag

setAllowsDuplicateValues

public void setAllowsDuplicateValues(boolean allowsDuplicateValues)

Set up whether the same value can be used by more than one instance of this attribute.

Parameters:

allowsDuplicateValues - boolean flag

getOrderedValues

public boolean getOrderedValues()

Return whether the attribute instances are arranged in an order.

Returns:

boolean flag

setOrderedValues

public void setOrderedValues(boolean orderedValues)

Set up whether the attribute instances are arranged in an order.

Parameters:

orderedValues - boolean flag

getSortOrder

public DataItemSortOrder getSortOrder()

Return the order that the attribute instances are arranged in - if any.

Returns:

DataItemSortOrder enum

setSortOrder

public void setSortOrder(DataItemSortOrder sortOrder)

Set up the order that the attribute instances are arranged in - if any.

Parameters:

sortOrder - DataItemSortOrder enum

getMinimumLength

public int getMinimumLength()

Return the minimum length of the data.

Returns:

int

setMinimumLength

public void setMinimumLength(int minimumLength)

Set up the minimum length of the data.

Parameters:

minimumLength - int

getLength

public int getLength()

Return the length of the data field.

Returns:

int

setLength

public void setLength(int length)

Set up the length of the data field.

Parameters:

length - int

getPrecision

public int getPrecision()

Return the number of significant digits to the right of decimal point.

Returns:

int

setPrecision

public void setPrecision(int precision)

Set up the number of significant digits to the right of decimal point.

Parameters:

precision - int

isNullable

public boolean isNullable()

Return whether the field is nullable or not.

Returns:

boolean

setNullable

public void setNullable(boolean nullable)

Set up whether the field is nullable or not.

Parameters:

nullable - boolean

getDefaultValueOverride

public String getDefaultValueOverride()

Return any default value for this attribute that would override the default defined in the schema element for this attribute's type (note only used is type is primitive).

Returns:

String default value override

setDefaultValueOverride

public void setDefaultValueOverride(String defaultValueOverride)

Set up any default value for this attribute that would override the default defined in the schema element for this attribute's type (note only used is type is primitive).

Parameters:

defaultValueOverride - String default value override

getNativeClass

public String getNativeClass()

Return the name of the Java class to use to represent this type.

Returns:

fully qualified Java class name

setNativeClass

public void setNativeClass(String nativeClass)

Set up the name of the Java class to use to represent this type.

Parameters:

nativeClass - fully qualified Java class name

getAliases

public List<String> getAliases()

Return a list of alternative names for the attribute.

Returns:

list of names

setAliases

public void setAliases(List<String> aliases)

Set up a list of alternative names for the attribute.

Parameters:

aliases - list of names

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

getAnchorGUID

public String getAnchorGUID()

Gets anchor guid.

Returns:

the anchor guid

setAnchorGUID

public void setAnchorGUID(String anchorGUID)

Sets anchor guid.

Parameters:

anchorGUID - the anchor guid

toString

public String toString()

Overrides:

toString in class Referenceable

equals

public boolean equals(Object o)

Overrides:

equals in class Referenceable

hashCode

public int hashCode()

Overrides:

hashCode in class Referenceable