org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs

Class CollectionDef

java.lang.Object

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefElementHeader

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.CollectionDef

All Implemented Interfaces:

Serializable

public class CollectionDef
extends AttributeTypeDef

CollectionDef supports the definition of a collection type. This information about the generic collection type is managed in the CollectionDefCategory. It is instantiated with specific primitive types when it is linked to a specific TypeDefAttribute.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef

category, description, descriptionGUID, guid, name, version, versionName

Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefElementHeader

CURRENT_TYPE_DEF_HEADER_VERSION

Constructor Summary

Constructors

Constructor and Description
CollectionDef() Default constructor for Jackson (JSON parsing)
CollectionDef(CollectionDef template) Copy/clone constructor creates a copy of the supplied template.
CollectionDef(CollectionDefCategory collectionDefCategory) Typical constructor initializes the CollectionDef based on the supplied category.

Method Summary

Modifier and Type	Method and Description
AttributeTypeDef	cloneFromSubclass() Delegate the process of cloning to the subclass.
boolean	equals(Object objectToCompare) Verify that supplied object has the same properties.
int	getArgumentCount() Return the number of arguments needed to set up the collection type name.
List<PrimitiveDefCategory>	getArgumentTypes() Return the list of argument types set up for this collection.
CollectionDefCategory	getCollectionDefCategory() Return the type category for this collection type.
void	setArgumentCount(int argumentCount) Set upi the number of arguments needed to set upi the collection type name.
void	setArgumentTypes(List<PrimitiveDefCategory> argumentTypes) Set up the list of argument types.
void	setCollectionDefCategory(CollectionDefCategory collectionDefCategory)
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef

getCategory, getDescription, getDescriptionGUID, getGUID, getName, getVersion, getVersionName, hashCode, setCategory, setDescription, setDescriptionGUID, setGUID, setName, setVersion, setVersionName

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefElementHeader

getHeaderVersion, setHeaderVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionDef

public CollectionDef()

Default constructor for Jackson (JSON parsing)

CollectionDef

public CollectionDef(CollectionDefCategory collectionDefCategory)

Typical constructor initializes the CollectionDef based on the supplied category.

Parameters:

collectionDefCategory - CollectionDefCategory Enum

CollectionDef

public CollectionDef(CollectionDef template)

Copy/clone constructor creates a copy of the supplied template.

Parameters:

template - CollectionDef to copy

Method Detail

cloneFromSubclass

public AttributeTypeDef cloneFromSubclass()

Delegate the process of cloning to the subclass.

Specified by:

cloneFromSubclass in class AttributeTypeDef

Returns:

subclass of AttributeTypeDef

getCollectionDefCategory

public CollectionDefCategory getCollectionDefCategory()

Return the type category for this collection type.

Returns:

CollectionDefCategory Enum

setCollectionDefCategory

public void setCollectionDefCategory(CollectionDefCategory collectionDefCategory)

getArgumentCount

public int getArgumentCount()

Return the number of arguments needed to set up the collection type name.

Returns:

int count

setArgumentCount

public void setArgumentCount(int argumentCount)

Set upi the number of arguments needed to set upi the collection type name.

Parameters:

argumentCount - int count

getArgumentTypes

public List<PrimitiveDefCategory> getArgumentTypes()

Return the list of argument types set up for this collection.

Returns:

list of argument type

setArgumentTypes

public void setArgumentTypes(List<PrimitiveDefCategory> argumentTypes)

Set up the list of argument types.

Parameters:

argumentTypes - list of argument types

toString

public String toString()

Standard toString method.

Overrides:

toString in class AttributeTypeDef

Returns:

JSON style description of variables.

equals

public boolean equals(Object objectToCompare)

Verify that supplied object has the same properties.

Overrides:

equals in class AttributeTypeDef

Parameters:

objectToCompare - object to test

Returns:

result