org.odpi.openmetadata.accessservices.subjectarea.properties.relationships

Class RelatedTerm

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Line

org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm

All Implemented Interfaces:

Serializable

public class RelatedTerm
extends Line

RelatedTerm is a relationship between an entity of type GlossaryTerm and an entity of type GlossaryTerm. The ends of the relationship are stored as entity proxies, where there is a 'proxy' name by which the entity type is known. The first entity proxy has seeAlso as the proxy name for entity type GlossaryTerm. The second entity proxy has seeAlso as the proxy name for entity type GlossaryTerm. Each entity proxy also stores the entities guid. Link between similar glossary terms.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	ATTRIBUTE_NAMES_SET
static String[]	ATTRIBUTE_NAMES_SET_VALUES
static Set<String>	ENUM_NAMES_SET
static String[]	ENUM_NAMES_SET_VALUES
static Set<String>	MAP_NAMES_SET
static String[]	MAP_NAMES_SET_VALUES
static Set<String>	PROPERTY_NAMES_SET
static String[]	PROPERTY_NAMES_SET_VALUES
protected String	relatedTerm1Guid
protected String	relatedTerm2Guid

Fields inherited from class org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Line

entity1Name, entity1Type, entity2Name, entity2Type, lineType, name, serialVersionUID, typeDefGuid

Constructor Summary

Constructors

Constructor and Description
RelatedTerm()
RelatedTerm(Line template)
RelatedTerm(Relationship omrsRelationship)

Method Summary

Modifier and Type	Method and Description
String	getDescription() {@literal Description of the relationship.
String	getExpression() {@literal An expression that explains the relationship.
String	getRelatedTerm1Guid() {@literal Get the guid of related term at end 1 of the relationship.
String	getRelatedTerm2Guid() {@literal Get the guid of related term at end 2 of the relationship.
String	getSource() {@literal Person, organization or automated process that created the relationship.
TermRelationshipStatus	getStatus() {@literal The status of or confidence in the relationship.
String	getSteward() {@literal Person responsible for the relationship.
void	setDescription(String description)
void	setExpression(String expression)
void	setRelatedTerm1Guid(String relatedTerm1Guid)
void	setRelatedTerm2Guid(String relatedTerm2Guid)
void	setSource(String source)
void	setStatus(TermRelationshipStatus status)
void	setSteward(String steward)
String	toString()
StringBuilder	toString(StringBuilder sb)

Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Line

createOmrsRelationship, getEffectiveFromTime, getEffectiveToTime, getExtraAttributes, getGuid, getLineType, getName, getSerialVersionUID, getSystemAttributes, getTypeDefGuid, setEffectiveFromTime, setExtraAttributes, setGuid, setLineType, setSystemAttributes, setTypeDefGuid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTY_NAMES_SET_VALUES

public static final String[] PROPERTY_NAMES_SET_VALUES

ATTRIBUTE_NAMES_SET_VALUES

public static final String[] ATTRIBUTE_NAMES_SET_VALUES

ENUM_NAMES_SET_VALUES

public static final String[] ENUM_NAMES_SET_VALUES

MAP_NAMES_SET_VALUES

public static final String[] MAP_NAMES_SET_VALUES

PROPERTY_NAMES_SET

public static final Set<String> PROPERTY_NAMES_SET

ATTRIBUTE_NAMES_SET

public static final Set<String> ATTRIBUTE_NAMES_SET

ENUM_NAMES_SET

public static final Set<String> ENUM_NAMES_SET

MAP_NAMES_SET

public static final Set<String> MAP_NAMES_SET

relatedTerm1Guid

protected String relatedTerm1Guid

relatedTerm2Guid

protected String relatedTerm2Guid

Constructor Detail

RelatedTerm

public RelatedTerm()

RelatedTerm

public RelatedTerm(Line template)

RelatedTerm

public RelatedTerm(Relationship omrsRelationship)

Method Detail

getRelatedTerm1Guid

public String getRelatedTerm1Guid()

Get the guid of related term at end 1 of the relationship.

Returns:

String

setRelatedTerm1Guid

public void setRelatedTerm1Guid(String relatedTerm1Guid)

getRelatedTerm2Guid

public String getRelatedTerm2Guid()

Get the guid of related term at end 2 of the relationship.

Returns:

String

setRelatedTerm2Guid

public void setRelatedTerm2Guid(String relatedTerm2Guid)

getDescription

public String getDescription()

Description of the relationship.

Returns:

String

setDescription

public void setDescription(String description)

getExpression

public String getExpression()

An expression that explains the relationship.

Returns:

String

setExpression

public void setExpression(String expression)

getStatus

public TermRelationshipStatus getStatus()

The status of or confidence in the relationship.

Returns:

TermRelationshipStatus

setStatus

public void setStatus(TermRelationshipStatus status)

getSteward

public String getSteward()

Person responsible for the relationship.

Returns:

String

setSteward

public void setSteward(String steward)

getSource

public String getSource()

Person, organization or automated process that created the relationship.

Returns:

String

setSource

public void setSource(String source)

toString

public StringBuilder toString(StringBuilder sb)

Overrides:

toString in class Line

toString

public String toString()

Overrides:

toString in class Object