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

Class Schema

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

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

All Implemented Interfaces:

Serializable

public class Schema
extends SchemaElement

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 int	maximumElements
protected SchemaType	schemaType

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

author, encodingStandard, schemaProperties, usage, versionNumber

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
Schema() Default constructor
Schema(Schema 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.

Method Summary

Modifier and Type	Method and Description
SchemaElement	cloneSchemaElement() Returns a clone of this object as the abstract SchemaElement class.
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.
SchemaType	getSchemaType() Return the type of the schema.
void	setMaximumElements(int maximumElements) Set up the maximum elements that can be stored in this schema.
void	setSchemaType(SchemaType schemaType) Set up the type of schema.
String	toString() Standard toString method.

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

getAuthor, getEncodingStandard, getSchemaProperties, getUsage, getVersionNumber, setAuthor, setEncodingStandard, setSchemaProperties, setUsage, setVersionNumber

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

schemaType

protected SchemaType schemaType

maximumElements

protected int maximumElements

Constructor Detail

Schema

public Schema()

Default constructor

Schema

public Schema(Schema 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:

templateSchema - template object to copy.

Method Detail

getSchemaType

public SchemaType getSchemaType()

Return the type of the schema.

Returns:

SchemaType enum

setSchemaType

public void setSchemaType(SchemaType schemaType)

Set up the type of schema.

Parameters:

schemaType - SchemaType enum

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 structure and this value is ignored.

Returns:

int maximum number of elements

setMaximumElements

public void setMaximumElements(int maximumElements)

Set up 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 structure and this value is ignored.

Parameters:

maximumElements - int maximum number of elements

cloneSchemaElement

public SchemaElement cloneSchemaElement()

Returns a clone of this object as the abstract SchemaElement class.

Specified by:

cloneSchemaElement in class SchemaElement

Returns:

a copy of this schema as a SchemaElement

toString

public String toString()

Standard toString method.

Overrides:

toString in class SchemaElement

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 SchemaElement

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison