Class Node

  • All Implemented Interfaces:
    java.io.Serializable, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.OmasObject

    public class Node
    extends java.lang.Object
    implements java.io.Serializable, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.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 java.util.List<org.odpi.openmetadata.accessservices.subjectarea.properties.classifications.Classification> classifications  
      protected NodeType nodeType  
    • Constructor Summary

      Constructors 
      Constructor Description
      Node()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)  
      java.util.Map<java.lang.String,​java.lang.String> getAdditionalProperties()
      Get the additional properties The additional properties are OMRS attributes that exist in the Node.
      java.util.List<org.odpi.openmetadata.accessservices.subjectarea.properties.classifications.Classification> getClassifications()
      List of associated classifications
      java.lang.String getDescription()
      Description of the node
      java.lang.Long getEffectiveFromTime()
      Return the date/time that this node should start to be used (null means it can be used from creationTime).
      java.lang.Long getEffectiveToTime()
      Return the date/time that this node should no longer be used.
      java.util.Map<java.lang.String,​java.lang.Object> getExtendedProperties()
      Get the extended properties.
      java.util.Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.nodesummary.IconSummary> getIcons()
      icon summary
      java.lang.String getName()
      The name of the node
      NodeType getNodeType()
      Node type
      java.lang.String getQualifiedName()
      The qualified name of the node.
      org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.SystemAttributes getSystemAttributes()  
      java.lang.String getTypeName()
      The name of the type of the node
      int hashCode()  
      boolean isReadOnly()
      The Node is readOnly
      protected void processClassification​(org.odpi.openmetadata.accessservices.subjectarea.properties.classifications.Classification classification)  
      void setAdditionalProperties​(java.util.Map<java.lang.String,​java.lang.String> additionalProperties)
      Set the additional properties.
      void setClassifications​(java.util.List<org.odpi.openmetadata.accessservices.subjectarea.properties.classifications.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​(java.lang.String description)  
      void setEffectiveFromTime​(java.lang.Long effectiveFromTime)  
      void setEffectiveToTime​(java.lang.Long effectiveToTime)  
      void setExtendedProperties​(java.util.Map<java.lang.String,​java.lang.Object> extendedProperties)
      Set the extended properties.
      void setIcons​(java.util.Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.nodesummary.IconSummary> icons)  
      void setName​(java.lang.String name)  
      void setNodeType​(NodeType nodeType)  
      void setQualifiedName​(java.lang.String qualifiedName)  
      void setReadOnly​(boolean readOnly)
      set whether the node is readOnly
      void setSystemAttributes​(org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.SystemAttributes systemAttributes)  
      void setTypeName​(java.lang.String typeName)  
      java.lang.String toString()  
      java.lang.StringBuilder toString​(java.lang.StringBuilder sb)  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • classifications

        protected java.util.List<org.odpi.openmetadata.accessservices.subjectarea.properties.classifications.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 java.lang.String getName()
        The name of the node
        Returns:
        name
      • setName

        public void setName​(java.lang.String name)
      • getTypeName

        public java.lang.String getTypeName()
        The name of the type of the node
        Returns:
        name
      • setTypeName

        public void setTypeName​(java.lang.String typeName)
      • getQualifiedName

        public java.lang.String getQualifiedName()
        The qualified name of the node.
        Returns:
        qualified name
      • setQualifiedName

        public void setQualifiedName​(java.lang.String qualifiedName)
      • getSystemAttributes

        public org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.SystemAttributes getSystemAttributes()
      • setSystemAttributes

        public void setSystemAttributes​(org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.SystemAttributes systemAttributes)
      • getDescription

        public java.lang.String getDescription()
        Description of the node
        Returns:
        description
      • setDescription

        public void setDescription​(java.lang.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 java.util.List<org.odpi.openmetadata.accessservices.subjectarea.properties.classifications.Classification> getClassifications()
        List of associated classifications
        Returns:
        List<Classification>
      • setClassifications

        public void setClassifications​(java.util.List<org.odpi.openmetadata.accessservices.subjectarea.properties.classifications.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 java.util.Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.nodesummary.IconSummary> getIcons()
        icon summary
        Returns:
        icon
      • setIcons

        public void setIcons​(java.util.Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.nodesummary.IconSummary> icons)
      • getEffectiveFromTime

        public java.lang.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​(java.lang.Long effectiveFromTime)
      • getEffectiveToTime

        public java.lang.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​(java.lang.Long effectiveToTime)
      • toString

        public java.lang.StringBuilder toString​(java.lang.StringBuilder sb)
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • processClassification

        protected void processClassification​(org.odpi.openmetadata.accessservices.subjectarea.properties.classifications.Classification classification)
      • setAdditionalProperties

        public void setAdditionalProperties​(java.util.Map<java.lang.String,​java.lang.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 java.util.Map<java.lang.String,​java.lang.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 java.util.Map<java.lang.String,​java.lang.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​(java.util.Map<java.lang.String,​java.lang.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