Class ConnectionSet

  • All Implemented Interfaces:
    java.io.Serializable

    public class ConnectionSet
    extends java.lang.Object
    implements java.io.Serializable
    An object that represents a set of connections. Connections are equal, if equals returns true. Connections that are added later replace earlier connections.
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ConnectionSet.Connection
      Object that represents the connection between an edge and a port.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.Set connections
      Contents of the connection set.
      protected java.util.Set edges
      Set of changed edges for the connection set.
    • Constructor Summary

      Constructors 
      Constructor Description
      ConnectionSet()
      Constructs an empty ConnectionSet.
      ConnectionSet​(java.lang.Object edge, java.lang.Object port, boolean source)
      Constructs a ConnectionSet with one Connection.
      ConnectionSet​(java.lang.Object edge, java.lang.Object source, java.lang.Object target)
      Constructs a ConnectionSet with two Connections (to the source and target port of the edge).
      ConnectionSet​(java.util.Set connections)
      Constructs a connection set containing the specified connections and updates the set of changed edges.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addConnections​(CellView[] views)
      Adds the connections in views to the connection set.
      ConnectionSet clone​(java.util.Map map)
      Creates a new connection set based on this connection set, where the edges, and ports are mapped using map.
      void connect​(java.lang.Object edge, java.lang.Object port, boolean source)
      Connect edge to port passed in.
      void connect​(java.lang.Object edge, java.lang.Object source, java.lang.Object target)
      Connect edge to source and target in the connection set.
      protected static void connect​(ConnectionSet cs, java.lang.Object edge, java.lang.Object port, boolean source, boolean disconnect)
      Connect or disconnect edge from source and target in cs based on disconnect.
      java.util.Iterator connections()
      Returns an Iterator for the connections in this set.
      static ConnectionSet create​(GraphModel m, java.lang.Object[] cells, boolean disconnect)
      Returns a connection set that represents the connection or disconnection of cells in model based on disconnect.
      void disconnect​(java.lang.Object edge)
      Disconnect edge from source and target in the connection set.
      void disconnect​(java.lang.Object edge, boolean source)
      Disconnect edge from port.
      java.util.Set getChangedEdges()
      Deprecated.
      Use getEdges
      java.util.Set getConnections()  
      java.util.Set getEdges()  
      java.lang.Object getPort​(java.lang.Object edge, boolean source)
      Returns the source or target of the specified edge in this connection set or null if the connection set contains no corresponding entry for the edge.
      boolean isEmpty()
      Returns true if the connection set is empty.
      void setConnections​(java.util.Set set)  
      void setEdges​(java.util.Set set)  
      int size()
      Returns the number of (edge, port)-pairs.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • connections

        protected java.util.Set connections
        Contents of the connection set.
      • edges

        protected java.util.Set edges
        Set of changed edges for the connection set.
    • Constructor Detail

      • ConnectionSet

        public ConnectionSet()
        Constructs an empty ConnectionSet.
      • ConnectionSet

        public ConnectionSet​(java.lang.Object edge,
                             java.lang.Object port,
                             boolean source)
        Constructs a ConnectionSet with one Connection.
      • ConnectionSet

        public ConnectionSet​(java.util.Set connections)
        Constructs a connection set containing the specified connections and updates the set of changed edges.
      • ConnectionSet

        public ConnectionSet​(java.lang.Object edge,
                             java.lang.Object source,
                             java.lang.Object target)
        Constructs a ConnectionSet with two Connections (to the source and target port of the edge).
    • Method Detail

      • create

        public static ConnectionSet create​(GraphModel m,
                                           java.lang.Object[] cells,
                                           boolean disconnect)
        Returns a connection set that represents the connection or disconnection of cells in model based on disconnect.
      • connect

        protected static void connect​(ConnectionSet cs,
                                      java.lang.Object edge,
                                      java.lang.Object port,
                                      boolean source,
                                      boolean disconnect)
        Connect or disconnect edge from source and target in cs based on disconnect.
      • addConnections

        public void addConnections​(CellView[] views)
        Adds the connections in views to the connection set.
      • connect

        public void connect​(java.lang.Object edge,
                            java.lang.Object source,
                            java.lang.Object target)
        Connect edge to source and target in the connection set. The previous connections between edge and its source and target are replaced in the set.
      • connect

        public void connect​(java.lang.Object edge,
                            java.lang.Object port,
                            boolean source)
        Connect edge to port passed in. The source indicates if port is the source of edge object. The previous connections between edge and its source or target in the set is replaced.
      • disconnect

        public void disconnect​(java.lang.Object edge)
        Disconnect edge from source and target in the connection set. The previous connections between edge and its source and target are replaced in the set.
      • disconnect

        public void disconnect​(java.lang.Object edge,
                               boolean source)
        Disconnect edge from port. source indicates if port is the source of edge. The previous connections between edge and its source or target in the set is replaced.
      • isEmpty

        public boolean isEmpty()
        Returns true if the connection set is empty.
      • size

        public int size()
        Returns the number of (edge, port)-pairs.
      • connections

        public java.util.Iterator connections()
        Returns an Iterator for the connections in this set.
      • getChangedEdges

        public java.util.Set getChangedEdges()
        Deprecated.
        Use getEdges
        Returns a Set for the edges in this connection set.
      • getPort

        public java.lang.Object getPort​(java.lang.Object edge,
                                        boolean source)
        Returns the source or target of the specified edge in this connection set or null if the connection set contains no corresponding entry for the edge.
      • clone

        public ConnectionSet clone​(java.util.Map map)
        Creates a new connection set based on this connection set, where the edges, and ports are mapped using map. If a port is not found, the old port is used. If both, the edge and the port are not in map, the entry is ignored.

        Note: Consequently, unselected edges are only reconnected at the first "paste" after a "cut", because in this case the ConnectionSet is not cloned.

      • getConnections

        public java.util.Set getConnections()
        Returns:
        the set of connections
      • getEdges

        public java.util.Set getEdges()
        Returns:
        the edges making us this connection set
      • setConnections

        public void setConnections​(java.util.Set set)
        Parameters:
        set -
      • setEdges

        public void setEdges​(java.util.Set set)
        Parameters:
        set -