mascoptLib.graphs
Class VertexSet

java.lang.Object
  |
  +--mascoptLib.util.ObservableObject
        |
        +--mascoptLib.abstractGraph.MascoptObject
              |
              +--mascoptLib.abstractGraph.MascoptFixedSet
                    |
                    +--mascoptLib.abstractGraph.MascoptSet
                          |
                          +--mascoptLib.abstractGraph.AbstractVertexSet
                                |
                                +--mascoptLib.graphs.VertexSet
All Implemented Interfaces:
Cloneable, Collection, MascoptObjectInterface, Observer, Set

public class VertexSet
extends AbstractVertexSet

The NodeSet class is derivated from MascoptSet. It allow to group Node objects in a set.

Author:
Jean-Francois Lalande (Jean-Francois.Lalande@sophia.inria.fr)

Field Summary
 
Fields inherited from class mascoptLib.abstractGraph.MascoptFixedSet
initialCapacity, loadFactor
 
Constructor Summary
VertexSet()
          Default Constructor.
VertexSet(mascoptLib.graphs.VertexSet superSet)
          Constructor creating a sub set of the NodeSet.
VertexSet(mascoptLib.graphs.VertexSet originalSet, boolean copyElements)
          Constructor for copy sets.
 
Method Summary
 boolean add(mascoptLib.graphs.Vertex o)
          Add a node in the set.
 mascoptLib.abstractGraph.AbstractVertexSetFactory getFactory()
          Give the factory creating objects not abstract.
 boolean remove(mascoptLib.graphs.Vertex o)
          Remove a node in the set.
 
Methods inherited from class mascoptLib.abstractGraph.AbstractVertexSet
add, countAllAbstractVertexSets, remove, update
 
Methods inherited from class mascoptLib.abstractGraph.MascoptSet
add, add, addAll, clear, remove, remove, removeAll, removeAllValues, removeAllValuesOnElementsOfset, retainAll, setValueForAllElements, setValueForAllElements
 
Methods inherited from class mascoptLib.abstractGraph.MascoptFixedSet
contains, containsAll, countAllSets, equals, free, getSuperSet, hashCode, isEmpty, isSubSet, iterator, setSuperSet, size, toArray, toArray, toArray, toString
 
Methods inherited from class mascoptLib.abstractGraph.MascoptObject
copyValues, countAllObjects, deleteValue, deleteValue, existValue, existValue, getDoubleValue, getDoubleValue, getDouValue, getDouValue, getId, getIntegerValue, getIntegerValue, getIntValue, getIntValue, getName, getValue, getValue, getValueContexts, getValueDataType, getValueDataType, getValueEntries, notifyOnValueChange, setDoubleValue, setDoubleValue, setDouValue, setDouValue, setIntegerValue, setIntegerValue, setIntValue, setIntValue, setName, setValue, setValue, setValue, setValue, setValue, setValue
 
Methods inherited from class mascoptLib.util.ObservableObject
addAddObserver, addRemoveObserver, addValueObserver, countAddObservers, countRemoveObservers, countValueObservers, deleteAddObserver, deleteAddObserver, deleteRemoveObserver, deleteRemoveObserver, deleteValueObserver, deleteValueObserver
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Set
contains, containsAll, equals, hashCode, isEmpty, iterator, size, toArray, toArray
 

Constructor Detail

VertexSet

public VertexSet()
Default Constructor.


VertexSet

public VertexSet(mascoptLib.graphs.VertexSet superSet)
Constructor creating a sub set of the NodeSet. The sub set created is empty. The set can easily be filled with the method add or addAll.

Parameters:
superSet - the set of node on which is based the node set created.

VertexSet

public VertexSet(mascoptLib.graphs.VertexSet originalSet,
                 boolean copyElements)
Constructor for copy sets. Creates a new NodeSet similar to originalSet. If copyElements is set to true then all the elements of originalSet are duplicated (and of course their id is changed) and the structure of the set is preserved (there exists an isomorphism between originalSet and the new set). In that case, the simple values are also copied, but those depending on a context are dropped. If copyElements is set to false, then the new set's elements point to those of originalSet but the set is not a subset of originalSet.

Parameters:
originalSet - - the set to be copied.
copyElements - - indicates if the elements of the set have to be duplicated
Method Detail

getFactory

public mascoptLib.abstractGraph.AbstractVertexSetFactory getFactory()
Give the factory creating objects not abstract. As all the library is abstract, we need a factory that determines the type of graphs the user manipulates. Then the factory is able to create each type of object when necessary.

Specified by:
getFactory in class AbstractVertexSet

add

public boolean add(mascoptLib.graphs.Vertex o)
Add a node in the set.

Parameters:
o - the node that must be added in the set.
Returns:
true if the node has been added in the set.

remove

public boolean remove(mascoptLib.graphs.Vertex o)
Remove a node in the set.

Parameters:
o - the node that must be removed in the set.
Returns:
true if the node has been removed in the set.