org.odpi.openmetadata.frameworks.connectors.properties

Class AssetComplexSchemaType

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.AssetSchemaType

org.odpi.openmetadata.frameworks.connectors.properties.AssetComplexSchemaType

All Implemented Interfaces:

Serializable

public class AssetComplexSchemaType
extends AssetSchemaType

The Schema object provides information about how the asset structures the data it supports. Schemas are typically described as nested structures of linked schema elements. Schemas can also be reused in other schemas. The schema object can be used to represent a Struct, Array, Set or Map.

• A Struct has an ordered list of attributes - the position of an attribute is set up as one of its properties.
• An Array has one schema attribute and a maximum size plus element count.
• A Set also has one schema attribute and a maximum size plus element count.
• A Map is a Set of MapSchemaElements

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected AssetSchemaAttributes	schemaAttributes
protected Schema	schemaBean
protected AssetSchemaLinks	schemaLinks

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

assetMeanings

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
AssetComplexSchemaType(AssetDescriptor parentAsset, AssetComplexSchemaType templateSchema) Copy/clone Constructor the parentAsset is passed separately to the template because it is also likely to be being cloned in the same operation and we want the definitions clone to point to the asset clone and not the original asset.
AssetComplexSchemaType(AssetDescriptor parentAsset, Schema schemaBean, AssetMeanings assetMeanings, AssetSchemaAttributes schemaAttributes, AssetSchemaLinks schemaLinks) Bean constructor with parent asset
AssetComplexSchemaType(Schema schemaBean, AssetMeanings assetMeanings, AssetSchemaAttributes schemaAttributes, AssetSchemaLinks schemaLinks) Bean constructor

Method Summary

Modifier and Type	Method and Description
protected AssetSchemaType	cloneAssetSchemaElement(AssetDescriptor parentAsset) Return a clone of this schema element.
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
int	getMaximumElements() Return the maximum elements that can be stored in this schema.
AssetSchemaAttributes	getSchemaAttributes() Return the list of schema attributes in this schema.
protected Schema	getSchemaBean() Return the bean that contains the properties of the schema.
protected SchemaElement	getSchemaElementBean() Return this schema element bean.
AssetSchemaLinks	getSchemaLinks() Return a list of any links that exist between the schema attributes of this schema (or others).
SchemaType	getSchemaType() Return the type of the schema.
String	toString() Standard toString method.

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

getAssetMeanings, getAuthor, getEncodingStandard, getSchemaProperties, getUsage, getVersionNumber

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

schemaBean

protected Schema schemaBean

schemaAttributes

protected AssetSchemaAttributes schemaAttributes

schemaLinks

protected AssetSchemaLinks schemaLinks

Constructor Detail

AssetComplexSchemaType

public AssetComplexSchemaType(Schema schemaBean,
                              AssetMeanings assetMeanings,
                              AssetSchemaAttributes schemaAttributes,
                              AssetSchemaLinks schemaLinks)

Bean constructor

Parameters:

schemaBean - bean containing the schema properties

assetMeanings - iterator for the asset assetMeanings

schemaAttributes - the attributes that make up this schema

schemaLinks - the links to other schema

AssetComplexSchemaType

public AssetComplexSchemaType(AssetDescriptor parentAsset,
                              Schema schemaBean,
                              AssetMeanings assetMeanings,
                              AssetSchemaAttributes schemaAttributes,
                              AssetSchemaLinks schemaLinks)

Bean constructor with parent asset

Parameters:

parentAsset - descriptor for parent asset

schemaBean - bean containing the schema properties

assetMeanings - iterator for the asset assetMeanings

schemaAttributes - the attributes that make up this schema

schemaLinks - the links to other schema

AssetComplexSchemaType

public AssetComplexSchemaType(AssetDescriptor parentAsset,
                              AssetComplexSchemaType templateSchema)

Copy/clone Constructor the parentAsset is passed separately to the template because it is also likely to be being cloned in the same operation and we want the definitions clone to point to the asset clone and not the original asset.

Parameters:

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

templateSchema - template object to copy.

Method Detail

getSchemaBean

protected Schema getSchemaBean()

Return the bean that contains the properties of the schema.

Returns:

schema bean

getSchemaType

public SchemaType getSchemaType()

Return the type of the schema.

Returns:

SchemaType

getSchemaAttributes

public AssetSchemaAttributes getSchemaAttributes()

Return the list of schema attributes in this schema.

Returns:

SchemaAttributes

getMaximumElements

public int getMaximumElements()

Return the maximum elements that can be stored in this schema. This is set up by the caller. Zero means not bounded. For a STRUCT the max elements are the number of elements in the asset attributes and this method returns 0,

Returns:

int maximum number of elements allowed

getSchemaLinks

public AssetSchemaLinks getSchemaLinks()

Return a list of any links that exist between the schema attributes of this schema (or others). These links are typically used for network type schemas such as a grpah schema - or may be used to show linkage to an element in another schema.

Returns:

SchemaLinks list of linked schema attributes

cloneAssetSchemaElement

protected AssetSchemaType cloneAssetSchemaElement(AssetDescriptor parentAsset)

Return a clone of this schema element. This method is needed because AssetSchemaType is abstract.

Specified by:

cloneAssetSchemaElement in class AssetSchemaType

Parameters:

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

Returns:

An instance of the this object's subclass

getSchemaElementBean

protected SchemaElement getSchemaElementBean()

Return this schema element bean. This method is needed because SchemaElement is abstract.

Specified by:

getSchemaElementBean in class AssetSchemaType

Returns:

An instance of the appropriate subclass of SchemaElement bean

toString

public String toString()

Standard toString method.

Overrides:

toString in class AssetSchemaType

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 AssetSchemaType

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison