org.odpi.openmetadata.frameworks.discovery.properties

Class RelationshipAdviceAnnotation

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

org.odpi.openmetadata.frameworks.discovery.properties.Annotation

org.odpi.openmetadata.frameworks.discovery.properties.DataFieldAnnotation

org.odpi.openmetadata.frameworks.discovery.properties.RelationshipAdviceAnnotation

All Implemented Interfaces:

Serializable

public class RelationshipAdviceAnnotation
extends DataFieldAnnotation

RelationshipAdviceAnnotation is used to record a recommendation that a new relationship should be made from this data field to another object in the open metadata types.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.discovery.properties.Annotation

additionalProperties, analysisStep, annotationStatus, annotationType, confidenceLevel, explanation, expression, jsonProperties, numAttachedAnnotations, reviewComment, reviewDate, steward, summary

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

classifications, extendedProperties, guid, type, url

Constructor Summary

Constructors

Constructor and Description
RelationshipAdviceAnnotation() Default constructor
RelationshipAdviceAnnotation(RelationshipAdviceAnnotation template) Copy/clone constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
String	getRelatedEntityGUID() Return the unique identifier of the object to connect to.
Map<String,String>	getRelationshipProperties() Return the properties that should be stored in the relationship.
String	getRelationshipTypeName() Return the type of relationship to create.
int	hashCode() Create a hash code for this element type.
void	setRelatedEntityGUID(String relatedEntityGUID) Set up the unique identifier of the object to connect to.
void	setRelationshipProperties(Map<String,String> relationshipProperties) Set up the properties that should be stored in the relationship.
void	setRelationshipTypeName(String relationshipTypeName) Set up the type of relationship to create.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.discovery.properties.Annotation

getAdditionalProperties, getAnalysisStep, getAnnotationStatus, getAnnotationType, getConfidenceLevel, getExplanation, getExpression, getJsonProperties, getNumAttachedAnnotations, getReviewComment, getReviewDate, getSteward, getSummary, setAdditionalProperties, setAnalysisStep, setAnnotationStatus, setAnnotationType, setAttachedAnnotations, setConfidenceLevel, setExplanation, setExpression, setJsonProperties, setReviewComment, setReviewDate, setSteward, setSummary

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

getClassifications, getExtendedProperties, getGUID, getType, getURL, setClassifications, setExtendedProperties, setGUID, setType, setURL

Methods inherited from class java.lang.Object

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

Constructor Detail

RelationshipAdviceAnnotation

public RelationshipAdviceAnnotation()

Default constructor

RelationshipAdviceAnnotation

public RelationshipAdviceAnnotation(RelationshipAdviceAnnotation template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getRelatedEntityGUID

public String getRelatedEntityGUID()

Return the unique identifier of the object to connect to.

Returns:

string guid

setRelatedEntityGUID

public void setRelatedEntityGUID(String relatedEntityGUID)

Set up the unique identifier of the object to connect to.

Parameters:

relatedEntityGUID - string guid

getRelationshipTypeName

public String getRelationshipTypeName()

Return the type of relationship to create.

Returns:

type name

setRelationshipTypeName

public void setRelationshipTypeName(String relationshipTypeName)

Set up the type of relationship to create.

Parameters:

relationshipTypeName - type name

getRelationshipProperties

public Map<String,String> getRelationshipProperties()

Return the properties that should be stored in the relationship.

Returns:

map of property names to property values

setRelationshipProperties

public void setRelationshipProperties(Map<String,String> relationshipProperties)

Set up the properties that should be stored in the relationship.

Parameters:

relationshipProperties - map of property names to property values

toString

public String toString()

Standard toString method.

Overrides:

toString in class DataFieldAnnotation

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 Annotation

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Create a hash code for this element type.

Overrides:

hashCode in class Annotation

Returns:

int hash code