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

Class Relationship

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

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

All Implemented Interfaces:

Serializable

public class Relationship
extends InstanceHeader

Relationship is a POJO that manages the properties of an open metadata relationship. This includes information about the relationship type, the two entities it connects and the properties it holds.

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
Relationship() Default constructor creates an empty relationship linked to nothing.
Relationship(Relationship templateElement) Copy/clone constructor builds a relationship from the supplied 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	getEntityOnePropertyName() Deprecated.
EntityProxy	getEntityOneProxy() Return details of the entity at the first end of the relationship.
String	getEntityTwoPropertyName() Deprecated.
EntityProxy	getEntityTwoProxy() Return details of the entity at second end of the relationship.
InstanceProperties	getProperties() Return a copy of all of the properties for this relationship.
int	hashCode() Return a hash code based on the values of this object.
boolean	relatedToEntity(String entityGUID) Test to determine if the supplied entity is linked by this relationship.
String	returnLinkedEntity(String entityGUID) Return the GUID at the other end of the relationship to the supplied entity.
void	setEntityOnePropertyName(String entityOnePropertyName) Deprecated.
void	setEntityOneProxy(EntityProxy entityOneProxy) Set up details of the entity at the first end of the relationship.
void	setEntityTwoPropertyName(String entityTwoPropertyName) Deprecated.
void	setEntityTwoProxy(EntityProxy entityTwoProxy) Set up the identity of the proxy at the other end of the relationship.
void	setProperties(InstanceProperties newProperties) Set up the properties for this relationship.
String	toString() Standard toString method.

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

getGUID, getInstanceProvenanceType, getInstanceURL, getMetadataCollectionId, setGUID, setInstanceProvenanceType, setInstanceURL, setMetadataCollectionId

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

Relationship

public Relationship()

Default constructor creates an empty relationship linked to nothing.

Relationship

public Relationship(Relationship templateElement)

Copy/clone constructor builds a relationship from the supplied template.

Parameters:

templateElement - template relationship to copy

Method Detail

relatedToEntity

public boolean relatedToEntity(String entityGUID)

Test to determine if the supplied entity is linked by this relationship.

Parameters:

entityGUID - unique identifier for the entity to test.

Returns:

boolean indicate whether the supplied entity is linked by this relationship

returnLinkedEntity

public String returnLinkedEntity(String entityGUID)

Return the GUID at the other end of the relationship to the supplied entity.

Parameters:

entityGUID - unique identifier for the entity to test.

Returns:

String guid for the entity at the other end of the relationship. Null if no matching entity found.

getProperties

public InstanceProperties getProperties()

Return a copy of all of the properties for this relationship. Null means no properties exist.

Returns:

InstanceProperties

setProperties

public void setProperties(InstanceProperties newProperties)

Set up the properties for this relationship.

Parameters:

newProperties - InstanceProperties object

getEntityOnePropertyName

@Deprecated
public String getEntityOnePropertyName()

Deprecated.

Return the name of the property for the relationship from the perspective of the entity at the first end of the relationship.

Returns:

entityOnePropertyName String property name

setEntityOnePropertyName

@Deprecated
public void setEntityOnePropertyName(String entityOnePropertyName)

Deprecated.

Set up the property name for the relationship from the perspective of the entity at the first end of the relationship.

Parameters:

entityOnePropertyName - String property name

getEntityOneProxy

public EntityProxy getEntityOneProxy()

Return details of the entity at the first end of the relationship.

Returns:

entityOneProxy EntityProxy object for the first end of the relationship.

setEntityOneProxy

public void setEntityOneProxy(EntityProxy entityOneProxy)

Set up details of the entity at the first end of the relationship.

Parameters:

entityOneProxy - EntityProxy object for the first end of the relationship.

getEntityTwoPropertyName

@Deprecated
public String getEntityTwoPropertyName()

Deprecated.

Return the property name for the relationship from the perspective of the entity at the second end of the relationship.

Returns:

String property name

setEntityTwoPropertyName

@Deprecated
public void setEntityTwoPropertyName(String entityTwoPropertyName)

Deprecated.

Set up the property name for the relationship from the perspective of the entity at the second end of the relationship.

Parameters:

entityTwoPropertyName - String property name

getEntityTwoProxy

public EntityProxy getEntityTwoProxy()

Return details of the entity at second end of the relationship.

Returns:

EntityProxy object for the second end of the relationship

setEntityTwoProxy

public void setEntityTwoProxy(EntityProxy entityTwoProxy)

Set up the identity of the proxy at the other end of the relationship.

Parameters:

entityTwoProxy - EntityProxy

toString

public String toString()

Standard toString method.

Overrides:

toString in class InstanceHeader

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 InstanceHeader

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 InstanceHeader

Returns:

in hash code