org.odpi.openmetadata.accessservices.assetmanager.properties

Class SchemaAttributeProperties

java.lang.Object

org.odpi.openmetadata.accessservices.assetmanager.properties.ReferenceableProperties

org.odpi.openmetadata.accessservices.assetmanager.properties.SupplementaryProperties

org.odpi.openmetadata.accessservices.assetmanager.properties.SchemaProperties

org.odpi.openmetadata.accessservices.assetmanager.properties.SchemaAttributeProperties

All Implemented Interfaces:

Serializable

public class SchemaAttributeProperties
extends SchemaProperties

SchemaAttributeProperties represents a attribute that is part of a complex schema type.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SchemaAttributeProperties() Default constructor
SchemaAttributeProperties(SchemaAttributeProperties 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.
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	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).
int	getElementPosition() Return the position of this schema attribute in its parent schema.
boolean	getIsNullable() Return whether the field is nullable or not.
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	getNativeJavaClass() 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	getPrecision() Return the number of significant digits to the right of decimal point.
SchemaTypeProperties	getSchemaType() Set up SchemaType for this schema attribute.
DataItemSortOrder	getSortOrder() Return the order that the attribute instances are arranged in - if any.
int	hashCode() Return a number that represents the contents of this object.
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	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	setElementPosition(int elementPosition) Set up the position of this schema attribute in its parent schema.
void	setIsNullable(boolean nullable) Set up whether the field is nullable or not.
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	setNativeJavaClass(String nativeJavaClass) Set up the name of the Java class to use to represent this type.
void	setOrderedValues(boolean orderedValues) Set up whether the attribute instances are arranged in an order.
void	setPrecision(int precision) Set up the number of significant digits to the right of decimal point.
void	setSchemaType(SchemaTypeProperties schemaType) Set up SchemaType for this schema attribute.
void	setSortOrder(DataItemSortOrder sortOrder) Set up the order that the attribute instances are arranged in - if any.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.accessservices.assetmanager.properties.SchemaProperties

getIsDeprecated, getTechnicalDescription, getTechnicalName, setIsDeprecated, setTechnicalDescription, setTechnicalName

Methods inherited from class org.odpi.openmetadata.accessservices.assetmanager.properties.SupplementaryProperties

getAbbreviation, getDescription, getDisplayName, getSummary, getUsage, setAbbreviation, setDescription, setDisplayName, setSummary, setUsage

Methods inherited from class org.odpi.openmetadata.accessservices.assetmanager.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

SchemaAttributeProperties

public SchemaAttributeProperties()

Default constructor

SchemaAttributeProperties

public SchemaAttributeProperties(SchemaAttributeProperties template)

Copy/clone constructor.

Parameters:

template - template schema attribute to copy.

Method Detail

getElementPosition

public int getElementPosition()

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

Returns:

int position in schema - 0 means first

setElementPosition

public void setElementPosition(int elementPosition)

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

Parameters:

elementPosition - 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

getIsNullable

public boolean getIsNullable()

Return whether the field is nullable or not.

Returns:

boolean

setIsNullable

public void setIsNullable(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

getNativeJavaClass

public String getNativeJavaClass()

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

Returns:

fully qualified Java class name

setNativeJavaClass

public void setNativeJavaClass(String nativeJavaClass)

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

Parameters:

nativeJavaClass - 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

getSchemaType

public SchemaTypeProperties getSchemaType()

Set up SchemaType for this schema attribute.

Returns:

schema type properties

setSchemaType

public void setSchemaType(SchemaTypeProperties schemaType)

Set up SchemaType for this schema attribute.

Parameters:

schemaType - schema type properties

toString

public String toString()

Standard toString method.

Overrides:

toString in class SchemaProperties

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 SchemaProperties

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return a number that represents the contents of this object.

Overrides:

hashCode in class SchemaProperties

Returns:

int