Node (Subject Area OMAS api 2.9 API)

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 and Description

protected List<Classification> classifications

protected NodeType nodeType

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

Constructor Summary

Constructors
Constructor and Description

Node()

Constructors
Constructor and Description
`Node()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Map<String,String>`	`getAdditionalProperties()` Get the additional properties The additional properties are OMRS attributes that exist in the Node, due to a repository defining a Type that subclasses the open types and adds additional properties.
`List<Classification>`	`getClassifications()` List of associated classifications
`String`	`getDescription()` Description of the node
`Date`	`getEffectiveFromTime()` Return the date/time that this node should start to be used (null means it can be used from creationTime).
`Date`	`getEffectiveToTime()` Return the date/time that this node should no longer be used.
`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()`
`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(Date effectiveFromTime)`
`void`	`setEffectiveToTime(Date effectiveToTime)`
`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)`
`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)
```
  - 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 Date 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(Date effectiveFromTime)
```
  - getEffectiveToTime
```
public Date getEffectiveToTime()
```
    Return the date/time that this node should no longer be used.
    
    Returns:
    
    Date the node stops being effective.
  - setEffectiveToTime
```
public void setEffectiveToTime(Date 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, due to a repository defining a Type that subclasses the open types and adds additional properties. 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, due to a repository defining a Type that subclasses the open types and adds additional properties. These additional properties should be supplied on calls for this node - or they will be lost.
    
    Returns:
    
    the additional properties

Class Node

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

nodeType

classifications

Constructor Detail

Node

Method Detail

getNodeType

setNodeType

getName

setName

getQualifiedName

setQualifiedName

getSystemAttributes

setSystemAttributes

getDescription

setDescription

isReadOnly

setReadOnly

getClassifications

setClassifications

getIcons

setIcons

getEffectiveFromTime

setEffectiveFromTime

getEffectiveToTime

setEffectiveToTime

toString

toString

equals

hashCode

processClassification

setAdditionalProperties

getAdditionalProperties