Class OpenMetadataTypeDef
java.lang.Object
org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataTypeDefElementHeader
org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataTypeDefLink
org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataTypeDefSummary
org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataTypeDef
- Direct Known Subclasses:
OpenMetadataClassificationDef
,OpenMetadataEntityDef
,OpenMetadataRelationshipDef
The OpenMetadataTypeDef is the base class for objects that store the properties of an open metadata type
definition (call ed a OpenMetadataTypeDef).
The different categories of Typedefs are listed in OpenMetadataTypeDefCategory.
-
Field Summary
Modifier and TypeFieldDescriptionprotected List<OpenMetadataTypeDefAttribute>
protected String
protected Date
protected String
protected String
protected String
protected List<ExternalStandardTypeMapping>
protected ElementStatus
protected String
protected OpenMetadataTypeDefLink
protected String
protected Date
protected List<ElementStatus>
Fields inherited from class org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataTypeDefSummary
category, version, versionName
Fields inherited from class org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataTypeDefLink
guid, name, replacedByTypeGUID, replacedByTypeName, status
Fields inherited from class org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataTypeDefElementHeader
CURRENT_TYPE_DEF_HEADER_VERSION
-
Constructor Summary
ModifierConstructorDescriptionprotected
Default constructorprotected
OpenMetadataTypeDef
(OpenMetadataTypeDef template) Copy/clone constructor copies the values from the supplied template.protected
Minimal constructor is passed the category of the typedef being constructed. -
Method Summary
Modifier and TypeMethodDescriptionabstract OpenMetadataTypeDef
Delegate the process of cloning to the subclass.boolean
Validate that an object is equal depending on their stored values.Return the list of typeDefAttributes that are either new or changing.Return the user name of the person that created this OpenMetadataTypeDef.Return the date/time that this OpenMetadataTypeDef was created.Return the description of this OpenMetadataTypeDef.Return the unique identifier (guid) of the valid value that describes this OpenMetadataTypeDef.Return the URL to the wiki page that gives more information for this type.Return the list of mappings to external standards.Return the initial status setting for an instance of this type.Return the options for this OpenMetadataTypeDef.Return the unique identifier for metadata collection id where this OpenMetadataTypeDef came from.Return the super type for the OpenMetadataTypeDef (or null if top-level)Return the user name of the person that last updated this OpenMetadataTypeDef.Return the date/time that this OpenMetadataTypeDef was last updated.Return the list of valid statuses for an instance of this OpenMetadataTypeDef.int
hashCode()
Return a hash code based on the values of this object.void
setAttributeDefinitions
(List<OpenMetadataTypeDefAttribute> attributeDefinitions) Set up the list of AttributeDefs that define the valid properties for this type of classification.void
setCreatedBy
(String createdBy) Set up the user name of the person that created this OpenMetadataTypeDef.void
setCreateTime
(Date createTime) Set up the date/time that this OpenMetadataTypeDef was created.void
setDescription
(String description) Set up the description of this OpenMetadataTypeDef.void
setDescriptionGUID
(String descriptionGUID) Set up the unique identifier (guid) of the valid value definition that describes this OpenMetadataTypeDef.void
setDescriptionWiki
(String descriptionWiki) Set up the URL to the wiki page that gives more information for this type.void
setExternalStandardMappings
(List<ExternalStandardTypeMapping> externalStandardTypeMappings) Set up the list of mappings to external standards.void
setInitialStatus
(ElementStatus initialStatus) Set up the initial status setting for an instance of this type.void
setOptions
(Map<String, String> options) Set up the options for this OpenMetadataTypeDef.void
Set up the unique identifier for metadata collection id where this OpenMetadataTypeDef came from.void
setSuperType
(OpenMetadataTypeDefLink superType) Set up supertype for the OpenMetadataTypeDef.void
setUpdatedBy
(String updatedBy) Set up the user name of the person that last updated this OpenMetadataTypeDef.void
setUpdateTime
(Date updateTime) Set up the date/time that this OpenMetadataTypeDef was last updated.void
setValidElementStatusList
(List<ElementStatus> validElementStatusList) Set up the list of valid instance statuses supported by this OpenMetadataTypeDef.toString()
Standard toString method.Methods inherited from class org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataTypeDefSummary
getCategory, getVersion, getVersionName, setCategory, setVersion, setVersionName
Methods inherited from class org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataTypeDefLink
getGUID, getName, getReplacedByTypeGUID, getReplacedByTypeName, getStatus, setGUID, setName, setReplacedByTypeGUID, setReplacedByTypeName, setStatus
-
Field Details
-
superType
-
description
-
descriptionGUID
-
descriptionWiki
-
origin
-
createdBy
-
updatedBy
-
createTime
-
updateTime
-
options
-
externalStandardTypeMappings
-
validElementStatusList
-
initialStatus
-
attributeDefinitions
-
-
Constructor Details
-
OpenMetadataTypeDef
protected OpenMetadataTypeDef()Default constructor -
OpenMetadataTypeDef
Minimal constructor is passed the category of the typedef being constructed. The rest of the properties are null.- Parameters:
category
- OpenMetadataTypeDefCategory enum
-
OpenMetadataTypeDef
Copy/clone constructor copies the values from the supplied template.- Parameters:
template
- OpenMetadataTypeDef
-
-
Method Details
-
cloneFromSubclass
Delegate the process of cloning to the subclass.- Returns:
- subclass of OpenMetadataTypeDef
-
getSuperType
Return the super type for the OpenMetadataTypeDef (or null if top-level)- Returns:
- OpenMetadataTypeDefLink for the super type
-
setSuperType
Set up supertype for the OpenMetadataTypeDef. Only single inheritance is supported. Use null if this type is top-level.- Parameters:
superType
- OpenMetadataTypeDefLink for the super type
-
getDescription
Return the description of this OpenMetadataTypeDef.- Returns:
- String description
-
setDescription
Set up the description of this OpenMetadataTypeDef.- Parameters:
description
- String
-
getDescriptionGUID
Return the unique identifier (guid) of the valid value that describes this OpenMetadataTypeDef.- Returns:
- String guid
-
setDescriptionGUID
Set up the unique identifier (guid) of the valid value definition that describes this OpenMetadataTypeDef.- Parameters:
descriptionGUID
- String guid
-
getDescriptionWiki
Return the URL to the wiki page that gives more information for this type.- Returns:
- url string
-
setDescriptionWiki
Set up the URL to the wiki page that gives more information for this type.- Parameters:
descriptionWiki
- url string
-
getOrigin
Return the unique identifier for metadata collection id where this OpenMetadataTypeDef came from.- Returns:
- String guid
-
setOrigin
Set up the unique identifier for metadata collection id where this OpenMetadataTypeDef came from.- Parameters:
origin
- String guid
-
getCreatedBy
Return the user name of the person that created this OpenMetadataTypeDef.- Returns:
- String name
-
setCreatedBy
Set up the user name of the person that created this OpenMetadataTypeDef.- Parameters:
createdBy
- String name
-
getUpdatedBy
Return the user name of the person that last updated this OpenMetadataTypeDef.- Returns:
- String name
-
setUpdatedBy
Set up the user name of the person that last updated this OpenMetadataTypeDef.- Parameters:
updatedBy
- String name
-
getCreateTime
Return the date/time that this OpenMetadataTypeDef was created.- Returns:
- Date
-
setCreateTime
Set up the date/time that this OpenMetadataTypeDef was created.- Parameters:
createTime
- Date
-
getUpdateTime
Return the date/time that this OpenMetadataTypeDef was last updated.- Returns:
- Date
-
setUpdateTime
Set up the date/time that this OpenMetadataTypeDef was last updated.- Parameters:
updateTime
- Date
-
getOptions
Return the options for this OpenMetadataTypeDef. These are private properties used by the processors of this OpenMetadataTypeDef and ignored by the OMRS.- Returns:
- Map from String to String
-
setOptions
Set up the options for this OpenMetadataTypeDef. These are private properties used by the processors of this OpenMetadataTypeDef and ignored by the OMRS.- Parameters:
options
- Map from String to String
-
getExternalStandardMappings
Return the list of mappings to external standards.- Returns:
- ExternalStandardMappings list
-
setExternalStandardMappings
public void setExternalStandardMappings(List<ExternalStandardTypeMapping> externalStandardTypeMappings) Set up the list of mappings to external standards.- Parameters:
externalStandardTypeMappings
- ExternalStandardMappings list
-
getValidElementStatusList
Return the list of valid statuses for an instance of this OpenMetadataTypeDef.- Returns:
- list of valid statuses
-
setValidElementStatusList
Set up the list of valid instance statuses supported by this OpenMetadataTypeDef.- Parameters:
validElementStatusList
- InstanceStatus Array
-
getInitialStatus
Return the initial status setting for an instance of this type.- Returns:
- InstanceStatus enum
-
setInitialStatus
Set up the initial status setting for an instance of this type.- Parameters:
initialStatus
- InstanceStatus enum
-
getAttributeDefinitions
Return the list of typeDefAttributes that are either new or changing.- Returns:
- list of OpenMetadataTypeDefAttribute
-
setAttributeDefinitions
Set up the list of AttributeDefs that define the valid properties for this type of classification.- Parameters:
attributeDefinitions
- AttributeDefs list
-
toString
Standard toString method.- Overrides:
toString
in classOpenMetadataTypeDefSummary
- Returns:
- JSON style description of variables.
-
equals
Validate that an object is equal depending on their stored values.- Overrides:
equals
in classOpenMetadataTypeDefSummary
- Parameters:
objectToCompare
- object- Returns:
- boolean result
-
hashCode
public int hashCode()Return a hash code based on the values of this object.- Overrides:
hashCode
in classOpenMetadataTypeDefSummary
- Returns:
- in hash code
-