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

Class TypeDefPatch

java.lang.Object

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

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

All Implemented Interfaces:

Serializable

public class TypeDefPatch
extends TypeDefElementHeader

TypeDefPatch describes a change (patch) to a typeDef's properties, options, external standards mappings or list of valid instance statuses. A patch can be applied to an EntityDef, RelationshipDef or ClassificationDef. Changes to a TypeDef's category or superclasses requires a new type definition. In addition it is not possible to delete an attribute through a patch.

See Also:

Serialized Form

Field Summary

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
TypeDefPatch() Default constructor relies on the initialization of variables in their declaration.
TypeDefPatch(TypeDefPatch template)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object) Validated that the GUID, name and version of a TypeDef are equal.
TypeDefPatchAction	getAction() Return the type of action that this patch requires.
long	getApplyToVersion() Return the version number of the TypeDef that this patch applies to.
String	getDescription() Return the new description for the TypeDef.
String	getDescriptionGUID() Return the unique identifier for the new glossary term that describes the TypeDef.
List<ExternalStandardMapping>	getExternalStandardMappings() Return the list of External Standards Mappings that are either new or changing.
String	getNewVersionName() Return the new version name ot use once the patch is applied.
List<TypeDefAttribute>	getTypeDefAttributes() Return the list of typeDefAttributes that are either new or changing.
String	getTypeDefGUID() Return the unique identifier for the affected TypeDef.
Map<String,String>	getTypeDefOptions() Return the TypeDef options for the patch.
String	getTypeName() Return the unique name for the affected TypeDef.
long	getUpdateToVersion() Return the new version number of the TypeDef.
List<InstanceStatus>	getValidInstanceStatusList() Return the list of valid statuses for an instance of this TypeDefPatch.
int	hashCode() Using the GUID as a hashcode.
void	setAction(TypeDefPatchAction action) Set up the type of action that this patch requires.
void	setApplyToVersion(long applyToVersion) Set up the version number of the TypeDef that this patch applies to.
void	setDescription(String description) Set up the new description for the TypeDef
void	setDescriptionGUID(String descriptionGUID) Set up the unique identifier for the new glossary term that describes the TypeDef.
void	setExternalStandardMappings(List<ExternalStandardMapping> externalStandardMappings) Set up the list of External Standards Mappings that are either new or changing.
void	setNewVersionName(String newVersionName) Set up the new version name ot use once the patch is applied.
void	setTypeDefAttributes(List<TypeDefAttribute> typeDefAttributes) Set up the list of typeDefAttributes that are either new or changing.
void	setTypeDefGUID(String typeDefGUID) Set up the unique identifier for the affected TypeDef.
void	setTypeDefOptions(Map<String,String> typeDefOptions) Set up the TypeDef options for the patch.
void	setTypeName(String typeName) Set up the unique name for the affected TypeDef.
void	setUpdateToVersion(long updateToVersion) Set up the new version of the TypeDef.
void	setValidInstanceStatusList(List<InstanceStatus> validInstanceStatusList) Set up the list of valid statuses for an instance of this TypeDef.
String	toString() Standard toString method.

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

TypeDefPatch

public TypeDefPatch()

Default constructor relies on the initialization of variables in their declaration.

TypeDefPatch

public TypeDefPatch(TypeDefPatch template)

Method Detail

getAction

public TypeDefPatchAction getAction()

Return the type of action that this patch requires.

Returns:

TypeDefPatchAction enum

setAction

public void setAction(TypeDefPatchAction action)

Set up the type of action that this patch requires.

Parameters:

action - TypeDefPatchAction enum

getTypeDefGUID

public String getTypeDefGUID()

Return the unique identifier for the affected TypeDef.

Returns:

String guid

setTypeDefGUID

public void setTypeDefGUID(String typeDefGUID)

Set up the unique identifier for the affected TypeDef.

Parameters:

typeDefGUID - String guid

getTypeName

public String getTypeName()

Return the unique name for the affected TypeDef.

Returns:

String name

setTypeName

public void setTypeName(String typeName)

Set up the unique name for the affected TypeDef.

Parameters:

typeName - String name

getApplyToVersion

public long getApplyToVersion()

Return the version number of the TypeDef that this patch applies to.

Returns:

long version number

setApplyToVersion

public void setApplyToVersion(long applyToVersion)

Set up the version number of the TypeDef that this patch applies to.

Parameters:

applyToVersion - long version number

getUpdateToVersion

public long getUpdateToVersion()

Return the new version number of the TypeDef.

Returns:

long version number

setUpdateToVersion

public void setUpdateToVersion(long updateToVersion)

Set up the new version of the TypeDef.

Parameters:

updateToVersion - long version number

getNewVersionName

public String getNewVersionName()

Return the new version name ot use once the patch is applied.

Returns:

String version name

setNewVersionName

public void setNewVersionName(String newVersionName)

Set up the new version name ot use once the patch is applied.

Parameters:

newVersionName - String version name

getDescription

public String getDescription()

Return the new description for the TypeDef.

Returns:

String description

setDescription

public void setDescription(String description)

Set up the new description for the TypeDef

Parameters:

description - String description

getDescriptionGUID

public String getDescriptionGUID()

Return the unique identifier for the new glossary term that describes the TypeDef.

Returns:

String unique identifier

setDescriptionGUID

public void setDescriptionGUID(String descriptionGUID)

Set up the unique identifier for the new glossary term that describes the TypeDef.

Parameters:

descriptionGUID - String unique identifier

getTypeDefAttributes

public List<TypeDefAttribute> getTypeDefAttributes()

Return the list of typeDefAttributes that are either new or changing.

Returns:

list of TypeDefAttribute

setTypeDefAttributes

public void setTypeDefAttributes(List<TypeDefAttribute> typeDefAttributes)

Set up the list of typeDefAttributes that are either new or changing.

Parameters:

typeDefAttributes - list of AttributeDefs

getTypeDefOptions

public Map<String,String> getTypeDefOptions()

Return the TypeDef options for the patch.

Returns:

map of TypeDef Options that are new or changing.

setTypeDefOptions

public void setTypeDefOptions(Map<String,String> typeDefOptions)

Set up the TypeDef options for the patch.

Parameters:

typeDefOptions - map of TypeDef Options that are new or changing.

getExternalStandardMappings

public List<ExternalStandardMapping> getExternalStandardMappings()

Return the list of External Standards Mappings that are either new or changing.

Returns:

list of external standards mappings

setExternalStandardMappings

public void setExternalStandardMappings(List<ExternalStandardMapping> externalStandardMappings)

Set up the list of External Standards Mappings that are either new or changing.

Parameters:

externalStandardMappings - list of external standards mappings

getValidInstanceStatusList

public List<InstanceStatus> getValidInstanceStatusList()

Return the list of valid statuses for an instance of this TypeDefPatch.

Returns:

list of valid statuses

setValidInstanceStatusList

public void setValidInstanceStatusList(List<InstanceStatus> validInstanceStatusList)

Set up the list of valid statuses for an instance of this TypeDef.

Parameters:

validInstanceStatusList - list of valid statuses

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

Returns:

JSON style description of variables.

equals

public boolean equals(Object object)

Validated that the GUID, name and version of a TypeDef are equal.

Overrides:

equals in class Object

Parameters:

object - to test

Returns:

boolean flag to say object is the same TypeDefPatch

hashCode

public int hashCode()

Using the GUID as a hashcode. It should be unique if all connected metadata repositories are behaving properly.

Overrides:

hashCode in class Object

Returns:

int hash code