Package org.odpi.openmetadata.frameworks.openmetadata.properties.governance

Class SemanticAssignmentProperties

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties

org.odpi.openmetadata.frameworks.openmetadata.properties.governance.SemanticAssignmentProperties

public class SemanticAssignmentProperties
extends RelationshipProperties

SemanticAssignmentProperties links an element to a glossary term to indicate that the glossary term describes its meaning.

Constructor Summary

Constructors

Constructor	Description
SemanticAssignmentProperties()	Default constructor
SemanticAssignmentProperties(SemanticAssignmentProperties template)	Copy/clone constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Compare the values of the supplied object with those stored in the current object.
int	getConfidence()	Return the level of confidence that the relationship is correct.
String	getCreatedBy()	Return the name/description of the creator of the relationship.
String	getDescription()	Return the description for the relationship.
String	getExpression()	Returns the expression that describes the relationship.
String	getSource()	Returns the id of the source of the knowledge of the relationship.
GlossaryTermAssignmentStatus	getStatus()	Returns whether this relationship should be used.
String	getSteward()	Returns the id of the steward who assigned the relationship (or approved the discovered value).
int	hashCode()	Return hash code based on properties.
void	setConfidence(int confidence)	Set up the level of confidence that the relationship is correct.
void	setCreatedBy(String createdBy)	Set up the name/description of the creator of the relationship.
void	setDescription(String description)	Set up description of the relationship.
void	setExpression(String expression)	Set up the expression that describes the relationship.
void	setSource(String source)	Set up the id of the source of the knowledge of the relationship.
void	setStatus(GlossaryTermAssignmentStatus status)	Set up whether this relationship should be used.
void	setSteward(String steward)	Set up the id of the steward who assigned the relationship (or approved the discovered value).
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties

getEffectiveFrom, getEffectiveTo, getExtendedProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties

Methods inherited from class java.lang.Object

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

Constructor Details

SemanticAssignmentProperties

public SemanticAssignmentProperties()

Default constructor

SemanticAssignmentProperties

public SemanticAssignmentProperties(SemanticAssignmentProperties template)

Copy/clone constructor.

Parameters:

template - template object to copy.

Method Details

setExpression

public void setExpression(String expression)

Set up the expression that describes the relationship.

Parameters:

expression - String name

getExpression

public String getExpression()

Returns the expression that describes the relationship.

Returns:

String name

setDescription

public void setDescription(String description)

Set up description of the relationship.

Parameters:

description - String

getDescription

public String getDescription()

Return the description for the relationship.

Returns:

String description

setStatus

public void setStatus(GlossaryTermAssignmentStatus status)

Set up whether this relationship should be used.

Parameters:

status - status enum

getStatus

public GlossaryTermAssignmentStatus getStatus()

Returns whether this relationship should be used.

Returns:

status enum

getConfidence

public int getConfidence()

Return the level of confidence that the relationship is correct. 0 means unassigned. Typical assigned values are usually between 1-100 as a percentage scale.

Returns:

int

setConfidence

public void setConfidence(int confidence)

Set up the level of confidence that the relationship is correct. 0 means unassigned. Typical assigned values are usually between 1-100 as a percentage scale.

Parameters:

confidence - int

getCreatedBy

public String getCreatedBy()

Return the name/description of the creator of the relationship. The relationship includes the userId of the creator, so this field is for a more business friendly name.

Returns:

string name

setCreatedBy

public void setCreatedBy(String createdBy)

Set up the name/description of the creator of the relationship. The relationship includes the userId of the creator, so this field is for a more business friendly name.

Parameters:

createdBy - string name

setSteward

public void setSteward(String steward)

Set up the id of the steward who assigned the relationship (or approved the discovered value).

Parameters:

steward - user id or name of steward

getSteward

public String getSteward()

Returns the id of the steward who assigned the relationship (or approved the discovered value).

Returns:

user id or name of steward

setSource

public void setSource(String source)

Set up the id of the source of the knowledge of the relationship.

Parameters:

source - String id

getSource

public String getSource()

Returns the id of the source of the knowledge of the relationship.

Returns:

String id

toString

public String toString()

Standard toString method.

Overrides:

toString in class RelationshipProperties

Returns:

print out of variables in a JSON-style

equals

public boolean equals(Object objectToCompare)

Compare the values of the supplied object with those stored in the current object.

Overrides:

equals in class RelationshipProperties

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return hash code based on properties.

Overrides:

hashCode in class RelationshipProperties

Returns:

int