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

Direct Known Subclasses:

AssetDerivedSchemaAttribute

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 StructSchemaType, MapSchemaType or PrimitiveSchemaType).

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected AssetSchemaLink	externalSchemaLink
protected AssetSchemaType	localSchemaType
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

Modifier	Constructor and Description
	AssetSchemaAttribute(AssetDescriptor parentAsset, AssetSchemaAttribute template) Copy/clone constructor.
protected	AssetSchemaAttribute(AssetDescriptor parentAsset, SchemaAttribute schemaAttributeBean) Bean constructor with parent asset
	AssetSchemaAttribute(AssetDescriptor parentAsset, SchemaAttribute schemaAttributeBean, AssetSchemaLink externalSchemaLink) Bean constructor with parent asset and fully constructed link to external schema type.
	AssetSchemaAttribute(AssetDescriptor parentAsset, SchemaAttribute schemaAttributeBean, AssetSchemaType localSchemaType) Bean constructor with parent asset and fully constructed local schema type.
protected	AssetSchemaAttribute(SchemaAttribute schemaAttributeBean) Bean constructor used by subclasses
	AssetSchemaAttribute(SchemaAttribute schemaAttributeBean, AssetSchemaLink externalSchemaLink) Bean constructor with fully constructed link to external schema type.
	AssetSchemaAttribute(SchemaAttribute schemaAttributeBean, AssetSchemaType localSchemaType) Bean constructor with fully constructed local schema type.

Method Summary

Modifier and Type	Method and Description
AssetSchemaAttribute	cloneAssetSchemaAttribute(AssetDescriptor parentAsset) Returns a clone of this object.
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.
List<SchemaAttributeRelationship>	getAttributeRelationships() Return any relationships to other schema attributes.
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.
AssetSchemaLink	getExternalSchemaLink() Return the SchemaType that relates to the type of this attribute.
AssetSchemaType	getLocalSchemaType() Return the SchemaType that relates to the type of this attribute.
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, getMeanings, getQualifiedName, getReferenceableBean, setBean

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

getAssetClassifications, getElementHeaderBean, getExtendedProperties, getGUID, getType, getURL, hashCode, setBean

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

localSchemaType

protected AssetSchemaType localSchemaType

externalSchemaLink

protected AssetSchemaLink externalSchemaLink

Constructor Detail

AssetSchemaAttribute

protected AssetSchemaAttribute(SchemaAttribute schemaAttributeBean)

Bean constructor used by subclasses

Parameters:

schemaAttributeBean - bean containing all of the properties

AssetSchemaAttribute

public AssetSchemaAttribute(SchemaAttribute schemaAttributeBean,
                            AssetSchemaType localSchemaType)

Bean constructor with fully constructed local schema type.

Parameters:

schemaAttributeBean - bean containing all of the properties

localSchemaType - type for this schema attribute

AssetSchemaAttribute

public AssetSchemaAttribute(SchemaAttribute schemaAttributeBean,
                            AssetSchemaLink externalSchemaLink)

Bean constructor with fully constructed link to external schema type.

Parameters:

schemaAttributeBean - bean containing all of the properties

externalSchemaLink - indirect link to the type for this schema attribute

AssetSchemaAttribute

protected AssetSchemaAttribute(AssetDescriptor parentAsset,
                               SchemaAttribute schemaAttributeBean)

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

AssetSchemaAttribute

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

Bean constructor with parent asset and fully constructed local schema type.

Parameters:

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

schemaAttributeBean - bean containing all of the properties

localSchemaType - type for this schema attribute

AssetSchemaAttribute

public AssetSchemaAttribute(AssetDescriptor parentAsset,
                            SchemaAttribute schemaAttributeBean,
                            AssetSchemaLink externalSchemaLink)

Bean constructor with parent asset and fully constructed link to external schema type.

Parameters:

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

schemaAttributeBean - bean containing all of the properties

externalSchemaLink - indirect link to the 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

cloneAssetSchemaAttribute

public AssetSchemaAttribute cloneAssetSchemaAttribute(AssetDescriptor parentAsset)

Returns a clone of this object.

Parameters:

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

Returns:

clone of this object

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

getLocalSchemaType

public AssetSchemaType getLocalSchemaType()

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

Returns:

SchemaElement

getExternalSchemaLink

public AssetSchemaLink getExternalSchemaLink()

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

Returns:

SchemaElement

getAttributeRelationships

public List<SchemaAttributeRelationship> getAttributeRelationships()

Return any relationships to other schema attributes.

Returns:

list of attribute relationships

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