org.odpi.openmetadata.frameworks.connectors.properties.beans

Class SchemaAttribute

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

org.odpi.openmetadata.frameworks.connectors.properties.beans.SchemaAttribute

All Implemented Interfaces:

Serializable

public class SchemaAttribute
extends Referenceable

SchemaAttribute describes a single attribute within a schema. The attribute has a name, order in the schema and cardinality. Its type is another SchemaElement (either Schema or PrimitiveSchemaElement).

If it is a PrimitiveSchemaElement it may have an override for the default value within.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	attributeName
protected SchemaElement	attributeType
protected String	cardinality
protected String	defaultValueOverride
protected int	elementPosition

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

additionalProperties, qualifiedName

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

classifications, guid, type, url

Constructor Summary

Constructors

Constructor and Description
SchemaAttribute() Default constructor
SchemaAttribute(SchemaAttribute 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	getAttributeName() Return the name of this schema attribute.
SchemaElement	getAttributeType() Return the SchemaElement that relates to the type of this attribute.
String	getCardinality() Return the cardinality defined for this schema 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.
void	setAttributeName(String attributeName) Set up the name of this schema attribute.
void	setAttributeType(SchemaElement attributeType) Set up the SchemaElement that relates to the type of this attribute.
void	setCardinality(String cardinality) Set up the cardinality defined for this schema 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.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

getAdditionalProperties, getQualifiedName, setAdditionalProperties, setQualifiedName

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

getClassifications, getGUID, getType, getURL, hashCode, setClassifications, setGUID, setType, setURL

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

cardinality

protected String cardinality

defaultValueOverride

protected String defaultValueOverride

attributeType

protected SchemaElement attributeType

Constructor Detail

SchemaAttribute

public SchemaAttribute()

Default constructor

SchemaAttribute

public SchemaAttribute(SchemaAttribute template)

Copy/clone constructor.

Parameters:

template - template schema attribute to copy.

Method Detail

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

getCardinality

public String getCardinality()

Return the cardinality defined for this schema attribute.

Returns:

String cardinality defined for this schema attribute.

setCardinality

public void setCardinality(String cardinality)

Set up the cardinality defined for this schema attribute.

Parameters:

cardinality - String cardinality defined for this schema attribute.

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 SchemaElement getAttributeType()

Return the SchemaElement that relates to the type of this attribute.

Returns:

SchemaElement

setAttributeType

public void setAttributeType(SchemaElement attributeType)

Set up the SchemaElement that relates to the type of this attribute.

Parameters:

attributeType - SchemaElement

toString

public String toString()

Standard toString method.

Overrides:

toString in class Referenceable

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 Referenceable

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison