org.odpi.openmetadata.frameworks.connectors.properties

Class AssetSchemaAttribute

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyElementBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

org.odpi.openmetadata.frameworks.connectors.properties.AssetSchemaAttribute

All Implemented Interfaces:

Serializable

public class AssetSchemaAttribute
extends AssetReferenceable

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, MapSchemaElement 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 AssetSchemaType	assetSchemaType
protected SchemaAttribute	schemaAttributeBean

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

referenceableBean

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

parentAsset

Constructor Summary

Constructors

Constructor and Description
AssetSchemaAttribute(AssetDescriptor parentAsset, AssetSchemaAttribute template) Copy/clone constructor.
AssetSchemaAttribute(AssetDescriptor parentAsset, SchemaAttribute schemaAttributeBean, AssetSchemaType assetSchemaType) Bean constructor with parent asset
AssetSchemaAttribute(SchemaAttribute schemaAttributeBean, AssetSchemaType assetSchemaType) Bean 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.
AssetSchemaType	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.
protected SchemaAttribute	getSchemaAttributeBean() Return the bean with all of the properties.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

getAdditionalProperties, getQualifiedName, getReferenceableBean

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

getAssetClassifications, getElementHeaderBean, getGUID, getType, getURL, hashCode

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

getParentAsset, getParentAssetName, getParentAssetTypeName

Methods inherited from class java.lang.Object

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

Field Detail

schemaAttributeBean

protected SchemaAttribute schemaAttributeBean

assetSchemaType

protected AssetSchemaType assetSchemaType

Constructor Detail

AssetSchemaAttribute

public AssetSchemaAttribute(SchemaAttribute schemaAttributeBean,
                            AssetSchemaType assetSchemaType)

Bean constructor

Parameters:

schemaAttributeBean - bean containing all of the properties

assetSchemaType - type for this schema attribute

AssetSchemaAttribute

public AssetSchemaAttribute(AssetDescriptor parentAsset,
                            SchemaAttribute schemaAttributeBean,
                            AssetSchemaType assetSchemaType)

Bean constructor with parent asset

Parameters:

parentAsset - description of the asset that this schema attribute is attached to.

schemaAttributeBean - bean containing all of the properties

assetSchemaType - type for this schema attribute

AssetSchemaAttribute

public AssetSchemaAttribute(AssetDescriptor parentAsset,
                            AssetSchemaAttribute template)

Copy/clone constructor.

Parameters:

parentAsset - description of the asset that this schema attribute is attached to.

template - template schema attribute to copy.

Method Detail

getSchemaAttributeBean

protected SchemaAttribute getSchemaAttributeBean()

Return the bean with all of the properties.

Returns:

schema attribute bean

getAttributeName

public String getAttributeName()

Return the name of this schema attribute.

Returns:

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

getCardinality

public String getCardinality()

Return the cardinality defined for this schema attribute.

Returns:

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

getAttributeType

public AssetSchemaType getAttributeType()

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

Returns:

SchemaElement

toString

public String toString()

Standard toString method.

Overrides:

toString in class AssetReferenceable

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 AssetReferenceable

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison