mascoptLib.graphs
Class PathSet

java.lang.Object
  mascoptLib.util.ObservableObject
      mascoptLib.abstractGraph.MascoptObject
          mascoptLib.abstractGraph.MascoptFixedSet
              mascoptLib.abstractGraph.MascoptSet
                  mascoptLib.abstractGraph.AbstractGraphSet
                      mascoptLib.abstractGraph.AbstractPathSet
                          mascoptLib.graphs.PathSet

All Implemented Interfaces:

Cloneable, Collection, MascoptObjectInterface, MascoptWritableInterface, Observer, Set

public class PathSet

extends AbstractPathSet

The PathSet class is derivated from PathSet. 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

Fields inherited from class mascoptLib.util.ObservableObject

stopNotifyValueMechanism

Constructor Summary

PathSet()
Default Constructor.

PathSet(PathSet superSet)
Constructor creating a sub set of the PathSet.

PathSet(PathSet originalSet, boolean copyElements)
Constructor for copy sets.

Method Summary

boolean	add(Path o) Add a path in the set.
String	getDOMTagHierarchy() Returns the XML hierarchy tag names.
String	getDOMTagName() Returns the XML tag name for this object.
AbstractGraphFactory	getFactory() Give the factory creating objects not abstract.
boolean	remove(Path o) Remove a path in the set.

Methods inherited from class mascoptLib.abstractGraph.AbstractPathSet

add, remove

Methods inherited from class mascoptLib.abstractGraph.AbstractGraphSet

add, countAllAbstractGraphSets, remove, update

Methods inherited from class mascoptLib.abstractGraph.MascoptSet

add, add, addAll, clear, remove, remove, removeAll, 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, toDOMTree, 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, removeAllValues, setDoubleValue, setDoubleValue, setDouValue, setDouValue, setIntegerValue, setIntegerValue, setIntValue, setIntValue, setName, setValue, setValue, setValue, setValue, setValue, setValue, toDOMTreeAsRef

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

PathSet

public PathSet()

Default Constructor.

PathSet

public PathSet(PathSet superSet)

Constructor creating a sub set of the PathSet. The sub set created is empty. The set can easily be filled with the method add or addAll.

Parameters:

superSet - the set of paths on which is based the path set created.

PathSet

public PathSet(PathSet originalSet,
               boolean copyElements)

Constructor for copy sets. Creates a new PathSet 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 AbstractGraphFactory getFactory()

Give the factory creating objects not abstract. As all the library is abstract, we need a factory that determines the type of paths the user manipulates. Then the factory is able to create each type of object when necessary.

Specified by:

getFactory in class AbstractGraphSet

add

public boolean add(Path o)

Add a path in the set.

Parameters:

o - the path that must be added in the set.

Returns:

true if the path has been added in the set.

remove

public boolean remove(Path o)

Remove a path in the set.

Parameters:

o - the path that must be removed in the set.

Returns:

true if the path has been removed in the set.

getDOMTagHierarchy

public String getDOMTagHierarchy()

Returns the XML hierarchy tag names.

Specified by:

getDOMTagHierarchy in interface MascoptWritableInterface

Overrides:

getDOMTagHierarchy in class MascoptFixedSet

Returns:

a string TAG1/TAG2/TAG3/TAG4...

getDOMTagName

public String getDOMTagName()

Returns the XML tag name for this object.

Specified by:

getDOMTagName in interface MascoptWritableInterface

Overrides:

getDOMTagName in class MascoptFixedSet

Returns:

a string TAG