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

Class Node

java.lang.Object

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

All Implemented Interfaces:

Serializable, OmasObject

Direct Known Subclasses:

Category, Glossary, GovernedNode, Project

public class Node
extends Object
implements Serializable, OmasObject

A Node is an entity in the subject area omas that has a type NodeType, name, qualified name and description. A node may be in one or more projects.

Nodes can be connected with Relationship s to form graphs. As they may be visualised, so a node has an associated icon.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Classification>	classifications
protected NodeType	nodeType

Constructor Summary

Constructors

Constructor	Description
Node()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Map<String,String>	getAdditionalProperties()	Get the additional properties The additional properties are OMRS attributes that exist in the Node.
List<Classification>	getClassifications()	List of associated classifications
String	getDescription()	Description of the node
Long	getEffectiveFromTime()	Return the date/time that this node should start to be used (null means it can be used from creationTime).
Long	getEffectiveToTime()	Return the date/time that this node should no longer be used.
Map<String,Object>	getExtendedProperties()	Get the extended properties.
Set<IconSummary>	getIcons()	icon summary
String	getName()	The name of the node
NodeType	getNodeType()	Node type
String	getQualifiedName()	The qualified name of the node.
SystemAttributes	getSystemAttributes()
String	getTypeName()	The name of the type of the node
int	hashCode()
boolean	isReadOnly()	The Node is readOnly
protected void	processClassification(Classification classification)
void	setAdditionalProperties(Map<String,String> additionalProperties)	Set the additional properties.
void	setClassifications(List<Classification> classifications)	If governance action classifications (Retention, Confidence, Confidentiality or Criticality) are supplied then remove them from the classifications and add to the appropriate named field.
void	setDescription(String description)
void	setEffectiveFromTime(Long effectiveFromTime)
void	setEffectiveToTime(Long effectiveToTime)
void	setExtendedProperties(Map<String,Object> extendedProperties)	Set the extended properties.
void	setIcons(Set<IconSummary> icons)
void	setName(String name)
void	setNodeType(NodeType nodeType)
void	setQualifiedName(String qualifiedName)
void	setReadOnly(boolean readOnly)	set whether the node is readOnly
void	setSystemAttributes(SystemAttributes systemAttributes)
void	setTypeName(String typeName)
String	toString()
StringBuilder	toString(StringBuilder sb)

Methods inherited from class java.lang.Object

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

Field Detail

nodeType

protected NodeType nodeType

classifications

protected List<Classification> classifications

Constructor Detail

Node

public Node()

Method Detail

getNodeType

public NodeType getNodeType()

Node type

Returns:

the type of the node

setNodeType

public void setNodeType(NodeType nodeType)

getName

public String getName()

The name of the node

Returns:

name

setName

public void setName(String name)

getTypeName

public String getTypeName()

The name of the type of the node

Returns:

name

setTypeName

public void setTypeName(String typeName)

getQualifiedName

public String getQualifiedName()

The qualified name of the node.

Returns:

qualified name

setQualifiedName

public void setQualifiedName(String qualifiedName)

getSystemAttributes

public SystemAttributes getSystemAttributes()

setSystemAttributes

public void setSystemAttributes(SystemAttributes systemAttributes)

getDescription

public String getDescription()

Description of the node

Returns:

description

setDescription

public void setDescription(String description)

isReadOnly

public boolean isReadOnly()

The Node is readOnly

Returns:

whether read only

setReadOnly

public void setReadOnly(boolean readOnly)

set whether the node is readOnly

Parameters:

readOnly - readonly flag

getClassifications

public List<Classification> getClassifications()

List of associated classifications

Returns:

List<Classification>

setClassifications

public void setClassifications(List<Classification> classifications)

If governance action classifications (Retention, Confidence, Confidentiality or Criticality) are supplied then remove them from the classifications and add to the appropriate named field. e.g. Retention will be set in the retention field.

Parameters:

classifications - list of classifications to set on the Node.

getIcons

public Set<IconSummary> getIcons()

icon summary

Returns:

icon

setIcons

public void setIcons(Set<IconSummary> icons)

getEffectiveFromTime

public Long getEffectiveFromTime()

Return the date/time that this node should start to be used (null means it can be used from creationTime).

Returns:

Date the node becomes effective.

setEffectiveFromTime

public void setEffectiveFromTime(Long effectiveFromTime)

getEffectiveToTime

public Long getEffectiveToTime()

Return the date/time that this node should no longer be used.

Returns:

Date the node stops being effective.

setEffectiveToTime

public void setEffectiveToTime(Long effectiveToTime)

toString

public StringBuilder toString(StringBuilder sb)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

processClassification

protected void processClassification(Classification classification)

setAdditionalProperties

public void setAdditionalProperties(Map<String,String> additionalProperties)

Set the additional properties. The additional properties are OMRS attributes that exist in the Node These additional properties should be supplied on calls for this node - or they will be lost.

Parameters:

additionalProperties - the additional properties

getAdditionalProperties

public Map<String,String> getAdditionalProperties()

Get the additional properties The additional properties are OMRS attributes that exist in the Node. These additional properties should be supplied on calls for this node - or they will be lost.

Returns:

the additional properties

getExtendedProperties

public Map<String,Object> getExtendedProperties()

Get the extended properties. The extended properties. are OMRS attributes that exist in the Node. Extended properties should be supplied on calls for this node - or they will be lost.

Returns:

the extended properties

setExtendedProperties

public void setExtendedProperties(Map<String,Object> extendedProperties)

Set the extended properties. The extended properties are OMRS attributes that come from subtypes These extended properties should be supplied on calls for this node - or they will be lost.

Parameters:

extendedProperties - extended properties