SchemaAttributeProperties (Asset Owner OMAS API 2.2 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.assetowner.properties.ReferenceableProperties
- - org.odpi.openmetadata.accessservices.assetowner.properties.SchemaElementProperties
  - - org.odpi.openmetadata.accessservices.assetowner.properties.SchemaAttributeProperties

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DerivedSchemaAttributeProperties, TabularColumnProperties
```
public class SchemaAttributeProperties
extends SchemaElementProperties
```
SchemaAttributeProperties carries the common parameters for creating or updating schema attributes.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<String>`	`aliases`
`protected boolean`	`allowsDuplicateValues`
`protected String`	`attributeName`
`protected List<SchemaAttributeRelationship>`	`attributeRelationships`
`protected SchemaType`	`attributeType`
`protected String`	`defaultValueOverride`
`protected int`	`elementPosition`
`protected SchemaLink`	`externalAttributeType`
`protected boolean`	`isNullable`
`protected int`	`length`
`protected int`	`maxCardinality`
`protected int`	`minCardinality`
`protected int`	`minimumLength`
`protected String`	`nativeJavaClass`
`protected boolean`	`orderedValues`
`protected int`	`significantDigits`
`protected DataItemSortOrder`	`sortOrder`

Fields inherited from class org.odpi.openmetadata.accessservices.assetowner.properties.ReferenceableProperties
additionalProperties, classifications, extendedProperties, meanings, qualifiedName, typeName

Constructor Summary

Constructors
Constructor and Description

SchemaAttributeProperties()
Default constructor

SchemaAttributeProperties(SchemaAttributeProperties template)
Copy/clone constructor.

Constructors
Constructor and Description
`SchemaAttributeProperties()` Default constructor
`SchemaAttributeProperties(SchemaAttributeProperties template)` Copy/clone constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SchemaAttribute`	`cloneProperties(SchemaAttribute objectToFill)` Copy/clone operator.
`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.
`String`	`getAttributeName()` Return the name of this schema attribute.
`List<SchemaAttributeRelationship>`	`getAttributeRelationships()` Return any relationships to other schema attributes.
`SchemaType`	`getAttributeType()` Return the SchemaType that relates to the type 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.
`SchemaLink`	`getExternalAttributeType()` Set up optional link to another attribute.
`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.
`int`	`getSignificantDigits()` 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.
`boolean`	`isAllowsDuplicateValues()` Return whether the same value can be used by more than one instance of this attribute.
`boolean`	`isNullable()` Return whether the field is nullable or not.
`boolean`	`isOrderedValues()` Return whether the attribute instances are arranged in an order.
`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`	`setAttributeName(String attributeName)` Set up the name of this schema attribute.
`void`	`setAttributeRelationships(List<SchemaAttributeRelationship> attributeRelationships)` Set up any relationships to other schema attributes.
`void`	`setAttributeType(SchemaType attributeType)` Set up the SchemaType that relates to the type 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`	`setExternalAttributeType(SchemaLink externalAttributeType)` Set up optional links to another attribute.
`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`	`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`	`setSignificantDigits(int significantDigits)` 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.
`String`	`toString()` Standard toString method.

Methods inherited from class org.odpi.openmetadata.accessservices.assetowner.properties.SchemaElementProperties
getDescription, getDisplayName, hashCode, isDeprecated, setDeprecated, setDescription, setDisplayName

Methods inherited from class org.odpi.openmetadata.accessservices.assetowner.properties.ReferenceableProperties
getAdditionalProperties, getClassifications, getExtendedProperties, getMeanings, getQualifiedName, getTypeName, setAdditionalProperties, setClassifications, setExtendedProperties, setMeanings, setQualifiedName, setTypeName

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - attributeName
```
protected String attributeName
```
  - elementPosition
```
protected int elementPosition
```
  - minCardinality
```
protected int minCardinality
```
  - maxCardinality
```
protected int maxCardinality
```
  - allowsDuplicateValues
```
protected boolean allowsDuplicateValues
```
  - orderedValues
```
protected boolean orderedValues
```
  - defaultValueOverride
```
protected String defaultValueOverride
```
  - sortOrder
```
protected DataItemSortOrder sortOrder
```
  - minimumLength
```
protected int minimumLength
```
  - length
```
protected int length
```
  - significantDigits
```
protected int significantDigits
```
  - isNullable
```
protected boolean isNullable
```
  - attributeType
```
protected SchemaType attributeType
```
  - externalAttributeType
```
protected SchemaLink externalAttributeType
```
  - attributeRelationships
```
protected List<SchemaAttributeRelationship> attributeRelationships
```
  - nativeJavaClass
```
protected String nativeJavaClass
```
  - aliases
```
protected List<String> aliases
```
- Constructor Detail
  - SchemaAttributeProperties
```
public SchemaAttributeProperties()
```
    Default constructor
  - SchemaAttributeProperties
```
public SchemaAttributeProperties(SchemaAttributeProperties template)
```
    Copy/clone constructor.
    
    Parameters:
    
    template - template schema attribute to copy.
- Method Detail
  - cloneProperties
```
public SchemaAttribute cloneProperties(SchemaAttribute objectToFill)
```
    Copy/clone operator.
    
    Parameters:
    
    objectToFill - schema attribute object
    
    Returns:
    
    filled object
  - getAttributeName
```
public String getAttributeName()
```
    Return the name of this schema attribute.
    
    Returns:
    
    String attribute name
  - setAttributeName
```
public void setAttributeName(String attributeName)
```
    Set up the name of this schema attribute.
    
    Parameters:
    
    attributeName - String attribute name
  - 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)
  - isAllowsDuplicateValues
```
public boolean isAllowsDuplicateValues()
```
    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
  - isOrderedValues
```
public boolean isOrderedValues()
```
    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
  - getSignificantDigits
```
public int getSignificantDigits()
```
    Return the number of significant digits to the right of decimal point.
    
    Returns:
    
    int
  - setSignificantDigits
```
public void setSignificantDigits(int significantDigits)
```
    Set up the number of significant digits to the right of decimal point.
    
    Parameters:
    
    significantDigits - 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
  - getAttributeType
```
public SchemaType getAttributeType()
```
    Return the SchemaType that relates to the type of this attribute.
    
    Returns:
    
    SchemaType
  - setAttributeType
```
public void setAttributeType(SchemaType attributeType)
```
    Set up the SchemaType that relates to the type of this attribute.
    
    Parameters:
    
    attributeType - SchemaType
  - getExternalAttributeType
```
public SchemaLink getExternalAttributeType()
```
    Set up optional link to another attribute. For example, a foreign key relationship between relational columns.
    
    Returns:
    
    SchemaLink object
  - setExternalAttributeType
```
public void setExternalAttributeType(SchemaLink externalAttributeType)
```
    Set up optional links to another attribute. For example, a foreign key relationship between relational columns.
    
    Parameters:
    
    externalAttributeType - SchemaLink object
  - getAttributeRelationships
```
public List<SchemaAttributeRelationship> getAttributeRelationships()
```
    Return any relationships to other schema attributes.
    
    Returns:
    
    list of attribute relationships
  - setAttributeRelationships
```
public void setAttributeRelationships(List<SchemaAttributeRelationship> attributeRelationships)
```
    Set up any relationships to other schema attributes.
    
    Parameters:
    
    attributeRelationships - list of attribute relationships
  - 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
  - toString
```
public String toString()
```
    Standard toString method.
    
    Overrides:
    
    toString in class SchemaElementProperties
    
    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 SchemaElementProperties
    
    Parameters:
    
    objectToCompare - supplied object
    
    Returns:
    
    boolean result of comparison

Class SchemaAttributeProperties

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.assetowner.properties.ReferenceableProperties

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.accessservices.assetowner.properties.SchemaElementProperties

Methods inherited from class org.odpi.openmetadata.accessservices.assetowner.properties.ReferenceableProperties

Methods inherited from class java.lang.Object

Field Detail

attributeName

elementPosition

minCardinality

maxCardinality

allowsDuplicateValues

orderedValues

defaultValueOverride

sortOrder

minimumLength

length

significantDigits

isNullable

attributeType

externalAttributeType

attributeRelationships

nativeJavaClass

aliases

Constructor Detail

SchemaAttributeProperties

SchemaAttributeProperties

Method Detail

cloneProperties

getAttributeName

setAttributeName

getElementPosition

setElementPosition

getMinCardinality

setMinCardinality

getMaxCardinality

setMaxCardinality

isAllowsDuplicateValues

setAllowsDuplicateValues

isOrderedValues

setOrderedValues

getSortOrder

setSortOrder

getMinimumLength

setMinimumLength

getLength

setLength

getSignificantDigits

setSignificantDigits

isNullable

setNullable

getDefaultValueOverride

setDefaultValueOverride

getAttributeType

setAttributeType

getExternalAttributeType

setExternalAttributeType

getAttributeRelationships

setAttributeRelationships

getNativeJavaClass

setNativeJavaClass

getAliases

setAliases

toString

equals