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

Class InstanceHeader

java.lang.Object

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceElementHeader

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceAuditHeader

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

EntitySummary, Relationship

public abstract class InstanceHeader
extends InstanceAuditHeader

InstanceHeader manages the attributes that are common to entities and relationship instances. This includes information abut its type, provenance and change history.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceAuditHeader

createdBy, createTime, currentStatus, statusOnDelete, type, updatedBy, updateTime, version

Constructor Summary

Constructors

Constructor and Description
InstanceHeader() Default Constructor sets the instance to nulls.
InstanceHeader(InstanceHeader template) Copy/clone constructor set the value to those supplied in the template.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Validate that an object is equal depending on their stored values.
String	getGUID() Return the unique identifier for this instance.
InstanceProvenanceType	getInstanceProvenanceType() Return the type of the provenance for this instance (UNKNOWN, LOCAL_COHORT, EXPORT_ARCHIVE, CONTENT_PACK, DEREGISTERED_REPOSITORY, CONFIGURATION).
String	getInstanceURL() Return the URL for this instance (or null if the metadata repository does not support instance URLs).
String	getMetadataCollectionId() Return the unique identifier for the metadata collection that is the home for this instance.
int	hashCode() Return a hash code based on the values of this object.
void	setGUID(String guid) Set up the unique identifier for this instance.
void	setInstanceProvenanceType(InstanceProvenanceType instanceProvenanceType) Set up the type of the provenance for this instance (UNKNOWN, LOCAL_COHORT, EXPORT_ARCHIVE, CONTENT_PACK, DEREGISTERED_REPOSITORY, CONFIGURATION).
void	setInstanceURL(String instanceURL) Set up the URL for this instance (or null if the metadata repository does not support instance URLs).
void	setMetadataCollectionId(String metadataCollectionId) Set up the unique identifier for the home metadata collection for this instance.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceAuditHeader

getCreatedBy, getCreateTime, getStatus, getStatusOnDelete, getType, getUpdatedBy, getUpdateTime, getVersion, setCreatedBy, setCreateTime, setStatus, setStatusOnDelete, setType, setUpdatedBy, setUpdateTime, setVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

InstanceHeader

public InstanceHeader()

Default Constructor sets the instance to nulls.

InstanceHeader

public InstanceHeader(InstanceHeader template)

Copy/clone constructor set the value to those supplied in the template.

Parameters:

template - Instance header

Method Detail

getInstanceProvenanceType

public InstanceProvenanceType getInstanceProvenanceType()

Return the type of the provenance for this instance (UNKNOWN, LOCAL_COHORT, EXPORT_ARCHIVE, CONTENT_PACK, DEREGISTERED_REPOSITORY, CONFIGURATION).

Returns:

InstanceProvenanceType enum

setInstanceProvenanceType

public void setInstanceProvenanceType(InstanceProvenanceType instanceProvenanceType)

Set up the type of the provenance for this instance (UNKNOWN, LOCAL_COHORT, EXPORT_ARCHIVE, CONTENT_PACK, DEREGISTERED_REPOSITORY, CONFIGURATION).

Parameters:

instanceProvenanceType - InstanceProvenanceType enum

getMetadataCollectionId

public String getMetadataCollectionId()

Return the unique identifier for the metadata collection that is the home for this instance. If the metadataCollectionId is null it means this instance belongs to the local metadata collection.

Returns:

metadataCollectionId String unique identifier for the repository

setMetadataCollectionId

public void setMetadataCollectionId(String metadataCollectionId)

Set up the unique identifier for the home metadata collection for this instance. If the metadataCollectionId is null it means this instance belongs to the local metadata collection.

Parameters:

metadataCollectionId - String unique identifier for the repository

getInstanceURL

public String getInstanceURL()

Return the URL for this instance (or null if the metadata repository does not support instance URLs).

Returns:

String URL

setInstanceURL

public void setInstanceURL(String instanceURL)

Set up the URL for this instance (or null if the metadata repository does not support instance URLs).

Parameters:

instanceURL - String URL

getGUID

public String getGUID()

Return the unique identifier for this instance.

Returns:

guid String unique identifier

setGUID

public void setGUID(String guid)

Set up the unique identifier for this instance.

Parameters:

guid - String unique identifier

toString

public String toString()

Standard toString method.

Overrides:

toString in class InstanceAuditHeader

Returns:

JSON style description of variables.

equals

public boolean equals(Object objectToCompare)

Validate that an object is equal depending on their stored values.

Overrides:

equals in class InstanceAuditHeader

Parameters:

objectToCompare - object

Returns:

boolean result

hashCode

public int hashCode()

Return a hash code based on the values of this object.

Overrides:

hashCode in class InstanceAuditHeader

Returns:

in hash code