Package org.odpi.openmetadata.frameworks.governanceaction.properties

Class OpenMetadataRelationshipDef

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

org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataRelationshipDef

public class OpenMetadataRelationshipDef
extends OpenMetadataTypeDef

OpenMetadataRelationshipDef describes the type of a relationship. A relationships links two entities together. The OpenMetadataRelationshipDef defines the types of those entities in the RelationshipEndDefs. It also defines if this relationship allows classifications to propagate through it.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataTypeDef

attributeDefinitions, createdBy, createTime, description, descriptionGUID, descriptionWiki, externalStandardTypeMappings, initialStatus, options, origin, superType, updatedBy, updateTime, validElementStatusList

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

Constructors

Constructor	Description
OpenMetadataRelationshipDef()	Minimal constructor builds an empty OpenMetadataRelationshipDef
OpenMetadataRelationshipDef(OpenMetadataRelationshipDef templateTypeDef)	Copy/clone constructor creates a copy of the supplied template.
OpenMetadataRelationshipDef(OpenMetadataTypeDefCategory category, String guid, String name, long version, String versionName)	Typical constructor is passed the properties of the typedef's super class being constructed.

Method Summary

Modifier and Type	Method	Description
OpenMetadataTypeDef	cloneFromSubclass()	Delegate the process of cloning to the subclass.
boolean	equals(Object objectToCompare)	Validate that an object is equal depending on their stored values.
OpenMetadataRelationshipEndDef	getEndDef1()	Return the details associated with the first end of the relationship.
OpenMetadataRelationshipEndDef	getEndDef2()	Return the details associated with the second end of the relationship.
boolean	getMultiLink()	Return whether multiple relationships of this type are allowed between the same two entities.
OpenMetadataClassificationPropagationRule	getPropagationRule()	Return the rule that determines if classifications are propagated across this relationship.
int	hashCode()	Return a hash code based on the values of this object.
void	setEndDef1(OpenMetadataRelationshipEndDef endDef1)	Set up the details associated with the first end of the relationship.
void	setEndDef2(OpenMetadataRelationshipEndDef endDef2)	Set up the details associated with the second end of the relationship.
void	setMultiLink(boolean multiLink)	Set up whether multiple relationships of this type are allowed between the same two entities.
void	setPropagationRule(OpenMetadataClassificationPropagationRule propagationRule)	Set up the rule that determines if classifications are propagated across this relationship.
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataTypeDef

getAttributeDefinitions, getCreatedBy, getCreateTime, getDescription, getDescriptionGUID, getDescriptionWiki, getExternalStandardMappings, getInitialStatus, getOptions, getOrigin, getSuperType, getUpdatedBy, getUpdateTime, getValidElementStatusList, setAttributeDefinitions, setCreatedBy, setCreateTime, setDescription, setDescriptionGUID, setDescriptionWiki, setExternalStandardMappings, setInitialStatus, setOptions, setOrigin, setSuperType, setUpdatedBy, setUpdateTime, setValidElementStatusList

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

Methods inherited from class java.lang.Object

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

Constructor Details

OpenMetadataRelationshipDef

public OpenMetadataRelationshipDef()

Minimal constructor builds an empty OpenMetadataRelationshipDef

OpenMetadataRelationshipDef

public OpenMetadataRelationshipDef(OpenMetadataTypeDefCategory category,
 String guid,
 String name,
 long version,
 String versionName)

Typical constructor is passed the properties of the typedef's super class being constructed.

Parameters:

category - category of this OpenMetadataTypeDef

guid - unique id for the OpenMetadataTypeDef

name - unique name for the OpenMetadataTypeDef

version - active version number for the OpenMetadataTypeDef

versionName - name for the active version of the OpenMetadataTypeDef

OpenMetadataRelationshipDef

public OpenMetadataRelationshipDef(OpenMetadataRelationshipDef templateTypeDef)

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

Parameters:

templateTypeDef - template to copy

Method Details

cloneFromSubclass

public OpenMetadataTypeDef cloneFromSubclass()

Delegate the process of cloning to the subclass.

Specified by:

cloneFromSubclass in class OpenMetadataTypeDef

Returns:

subclass of OpenMetadataTypeDef

getPropagationRule

public OpenMetadataClassificationPropagationRule getPropagationRule()

Return the rule that determines if classifications are propagated across this relationship.

Returns:

OpenMetadataClassificationPropagationRule Enum

setPropagationRule

public void setPropagationRule(OpenMetadataClassificationPropagationRule propagationRule)

Set up the rule that determines if classifications are propagated across this relationship.

Parameters:

propagationRule - OpenMetadataClassificationPropagationRule Enum

getEndDef1

public OpenMetadataRelationshipEndDef getEndDef1()

Return the details associated with the first end of the relationship.

Returns:

endDef1 OpenMetadataRelationshipEndDef

setEndDef1

public void setEndDef1(OpenMetadataRelationshipEndDef endDef1)

Set up the details associated with the first end of the relationship.

Parameters:

endDef1 - OpenMetadataRelationshipEndDef

getEndDef2

public OpenMetadataRelationshipEndDef getEndDef2()

Return the details associated with the second end of the relationship.

Returns:

endDef2 OpenMetadataRelationshipEndDef

setEndDef2

public void setEndDef2(OpenMetadataRelationshipEndDef endDef2)

Set up the details associated with the second end of the relationship.

Parameters:

endDef2 - OpenMetadataRelationshipEndDef

getMultiLink

public boolean getMultiLink()

Return whether multiple relationships of this type are allowed between the same two entities.

Returns:

boolean flag

setMultiLink

public void setMultiLink(boolean multiLink)

Set up whether multiple relationships of this type are allowed between the same two entities.

Parameters:

multiLink - boolean flag

toString

public String toString()

Standard toString method.

Overrides:

toString in class OpenMetadataTypeDef

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 OpenMetadataTypeDef

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 OpenMetadataTypeDef

Returns:

in hash code