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

Class BoundedSchemaType

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

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

All Implemented Interfaces:

Serializable

public class BoundedSchemaType
extends SchemaType

The BoundedSchemaType object provides structural information for Arrays and Sets.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected BoundedSchemaCategory	boundedSchemaCategory
protected SchemaType	elementType
protected int	maximumElements

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

author, displayName, encodingStandard, usage, versionNumber

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

additionalProperties, meanings, qualifiedName

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

classifications, extendedProperties, guid, type, url

Constructor Summary

Constructors

Constructor and Description
BoundedSchemaType() Default constructor
BoundedSchemaType(BoundedSchemaType template) 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.
SchemaType	cloneSchemaType() Returns a clone of this object as the abstract SchemaType class.
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
BoundedSchemaCategory	getBoundedSchemaCategory() Return the type of the schema.
SchemaType	getElementType() Return the type of the elements nested within this schema.
int	getMaximumElements() Return the maximum elements that can be stored in this schema.
void	setBoundedSchemaCategory(BoundedSchemaCategory boundedSchemaCategory) Set up the type of schema.
void	setElementType(SchemaType elementType) Set up the type of the elements nested within this schema.
void	setMaximumElements(int maximumElements) Set up the maximum elements that can be stored in this schema.
String	toString() Standard toString method.

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

getAuthor, getDisplayName, getEncodingStandard, getUsage, getVersionNumber, setAuthor, setDisplayName, setEncodingStandard, setUsage, setVersionNumber

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

getAdditionalProperties, getMeanings, getQualifiedName, hashCode, setAdditionalProperties, setMeanings, setQualifiedName

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

getClassifications, getExtendedProperties, getGUID, getType, getURL, setClassifications, setExtendedProperties, setGUID, setType, setURL

Methods inherited from class java.lang.Object

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

Field Detail

boundedSchemaCategory

protected BoundedSchemaCategory boundedSchemaCategory

maximumElements

protected int maximumElements

elementType

protected SchemaType elementType

Constructor Detail

BoundedSchemaType

public BoundedSchemaType()

Default constructor

BoundedSchemaType

public BoundedSchemaType(BoundedSchemaType template)

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:

template - template object to copy.

Method Detail

cloneSchemaElement

public SchemaElement cloneSchemaElement()

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

Overrides:

cloneSchemaElement in class SchemaType

Returns:

a copy of this schema as a SchemaElement

cloneSchemaType

public SchemaType cloneSchemaType()

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

Overrides:

cloneSchemaType in class SchemaType

Returns:

a copy of this schema as a SchemaType

getBoundedSchemaCategory

public BoundedSchemaCategory getBoundedSchemaCategory()

Return the type of the schema.

Returns:

BoundedSchemaCategory enum

setBoundedSchemaCategory

public void setBoundedSchemaCategory(BoundedSchemaCategory boundedSchemaCategory)

Set up the type of schema.

Parameters:

boundedSchemaCategory - BoundedSchemaCategory 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

getElementType

public SchemaType getElementType()

Return the type of the elements nested within this schema.

Returns:

schema type

setElementType

public void setElementType(SchemaType elementType)

Set up the type of the elements nested within this schema.

Parameters:

elementType - schema type

toString

public String toString()

Standard toString method.

Overrides:

toString in class SchemaType

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 SchemaType

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison