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
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:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Get the additional properties The additional properties are OMRS attributes that exist in the Node.List of associated classificationsDescription of the nodeReturn the date/time that this node should start to be used (null means it can be used from creationTime).Return the date/time that this node should no longer be used.Get the extended properties.getIcons()
icon summarygetName()
The name of the nodeNode typeThe qualified name of the node.The name of the type of the nodeint
hashCode()
boolean
The Node is readOnlyprotected 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
void
setNodeType
(NodeType nodeType) void
setQualifiedName
(String qualifiedName) void
setReadOnly
(boolean readOnly) set whether the node is readOnlyvoid
setSystemAttributes
(SystemAttributes systemAttributes) void
setTypeName
(String typeName) toString()
-
Field Details
-
nodeType
-
classifications
-
-
Constructor Details
-
Node
public Node()
-
-
Method Details
-
getNodeType
Node type- Returns:
- the type of the node
-
setNodeType
-
getName
The name of the node- Returns:
- name
-
setName
-
getTypeName
The name of the type of the node- Returns:
- name
-
setTypeName
-
getQualifiedName
The qualified name of the node.- Returns:
- qualified name
-
setQualifiedName
-
getSystemAttributes
-
setSystemAttributes
-
getDescription
Description of the node- Returns:
- description
-
setDescription
-
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
List of associated classifications- Returns:
List<Classification>
-
setClassifications
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
icon summary- Returns:
- icon
-
setIcons
-
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
-
getEffectiveToTime
Return the date/time that this node should no longer be used.- Returns:
- Date the node stops being effective.
-
setEffectiveToTime
-
toString
-
toString
-
equals
-
hashCode
public int hashCode() -
processClassification
-
setAdditionalProperties
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
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
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
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
-