Interface NESTGraphObject

All Superinterfaces:
DataObject, PropertyHandler
All Known Subinterfaces:
NESTAbstractWorkflowObject, NESTSequentialWorkflowObject, NESTWorkflowObject
All Known Implementing Classes:
NESTAbstractWorkflowObjectImpl, NESTGraphObjectImpl, NESTSequentialWorkflowObjectImpl, NESTWorkflowObjectImpl

public interface NESTGraphObject extends DataObject
  • Method Details

    • addGraphNode

      void addGraphNode(NESTNodeObject newGraphNode)
      Adds the given graph-node to the internal list of registered graphnodes. Nodes are being bound automatically if they are connected to already bound edges. → Create the graph based on the startnode, so that all nodes/edges get automatically bound.
      Parameters:
      newGraphNode - The graphnode, which should be registered.
    • removeGraphNode

      boolean removeGraphNode(String id)
      Removes the given graph-node from the internal list of registered graphnodes. It is important to remove unused or obsolete nodes from the internal list in order to have a consistent objectmodel.
      Parameters:
      id - The id of the node to remove.
      Returns:
      TRUE, if the removal-process was successfull. FALSE, otherwise.
    • getSemanticallyEqualNode

      <T extends NESTNodeObject> T getSemanticallyEqualNode(T node, SimilarityValuator simVal, String simMeasure)
      Returns the graph node that is identical (due to its similarity value of 1.0) to the given node from the internal list of graphnodes.
      Parameters:
      node - the node that is compared to the other nodes of the graph
      simVal - The similarity valuator to use
      simMeasure - The name of the similarity measure to use
      Returns:
      semantic equal graph node, if exists null otherwise
    • getSemanticallyEqualNode

      <T extends NESTNodeObject> T getSemanticallyEqualNode(T node)
      Returns the graph node that is identical (due to its similarity value of 1.0) to the given node from the internal list of graphnodes. The default similarity valuator and measure are used.
      Parameters:
      node - the node that is compared to the other nodes of the graph
      Returns:
      semantic equal graph node, if exists null otherwise
    • getEqualIdGraphNode

      NESTNodeObject getEqualIdGraphNode(NESTNodeObject node)
      Returns the graph node whose id is equal to the given node from the internal list of graphnodes.
      Parameters:
      node -
      Returns:
      graph node with equal id, if exists null otherwise
    • updateGraphNodeId

      void updateGraphNodeId(String oldId, String newId)
      Updates the internal list of registered graphnodes, when an id of a graph node changed.
      Parameters:
      oldId -
      newId -
    • getGraphNode

      NESTNodeObject getGraphNode(String id)
      Returns the graphnode with the given id from the internal list of graphnodes.
      Parameters:
      id - The id of the graphnode, which should be retrieved.
      Returns:
    • getGraphEdge

      NESTEdgeObject getGraphEdge(String id)
      Returns the graph edge with the specified id.
      Parameters:
      id - the id of the graph edge
      Returns:
      the edge
    • getGraphNodes

      Set<NESTNodeObject> getGraphNodes()
      Returns the complete list of graph nodes registered in the graph.
      Returns:
      list of graph nodes in the graph.
    • getGraphNodes

      Set<NESTNodeObject> getGraphNodes(Predicate<? super NESTNodeObject> filter)
      Returns a list of graph nodes registered in the graph.
      Parameters:
      filter - filter to apply
      Returns:
      list of graph nodes in the graph
    • getGraphEdges

      Set<NESTEdgeObject> getGraphEdges()
      Returns the complete list of graphedges contained in the graph
      Returns:
      List of graphedges in the graph.
    • containsValueFrom

      boolean containsValueFrom(NESTGraphObject graph)
      Checks, whether the given graph is entirely contained in this graph.
      Parameters:
      graph - given graph
      Returns:
      true, if the given graph is entirely contained in this graph
    • containsValueFromWithExceptions

      boolean containsValueFromWithExceptions(NESTGraphObject graph) throws AssertSameValueAsInException
      Checks, whether the given graph is entirely contained in this graph.
      Parameters:
      graph - given graph
      Returns:
      true, if the given graph is entirely contained in this graph
      Throws:
      AssertSameValueAsInException - exception with explanations
    • getIDManager

      NESTGraphIDManager getIDManager()
      Returns the ID-manager for this graph.
      Returns:
    • getNumberOfNodes

      int getNumberOfNodes()
      Returns:
    • getNumberOfEdges

      int getNumberOfEdges()
      Returns:
    • getModifier

      NESTGraphModifier getModifier()
      Returns the modifier.
      Returns:
    • getVisualizer

      NESTGraphVisualizer getVisualizer()
      Returns the default visualizer for this graph.
      Returns:
    • getVisualizer

      NESTGraphVisualizer getVisualizer(Class clazz)