com.tensegrity.graph.view
Interface VisualGraphObjectContainer

All Known Subinterfaces:

VisualGraph, VisualGraphView, VisualSubgraph

public interface VisualGraphObjectContainer

This interface holds the methods that define the container role for classes that manage VisualGraphObject instances. This is the parent interface of both the VisualGraph and VisualSubgraph interfaces.

A VisualGraphObjectContainter will manage VisualNode and VisualEdge instances by providing implementations to add and remove objects of these types.

Version:

$Id: VisualGraphObjectContainer.java,v 1.24 2006/04/11 11:45:11 MichaelKegel Exp $

Author:

MichaelKegel, Stepan Rutz

See Also:

VisualGraphObject, VisualNode, VisualEdge, VisualSubgraph, VisualGraph, VisualGraphView

Field Summary

static int	EVENT_MASK_EDGESPLIT Enumeration for setting event masks for the different type of events.
static int	EVENT_MASK_ISOLATED_VISUALEDGE_ADDED Enumeration for setting event masks for the different type of events.
static int	EVENT_MASK_ISOLATED_VISUALEDGE_PRE_ADD Enumeration for setting event masks for the different type of events.
static int	EVENT_MASK_ISOLATED_VISUALEDGE_PRE_REMOVE Enumeration for setting event masks for the different type of events.
static int	EVENT_MASK_ISOLATED_VISUALEDGE_REMOVED Enumeration for setting event masks for the different type of events.
static int	EVENT_MASK_LAYOUT Enumeration for setting event masks for the different type of events.
static int	EVENT_MASK_VISUALEDGE_ADDED Enumeration for setting event masks for the different type of events.
static int	EVENT_MASK_VISUALEDGE_PRE_ADD Enumeration for setting event masks for the different type of events.
static int	EVENT_MASK_VISUALEDGE_PRE_REMOVE Enumeration for setting event masks for the different type of events.
static int	EVENT_MASK_VISUALEDGE_REMOVED Enumeration for setting event masks for the different type of events.
static int	EVENT_MASK_VISUALNODE_ADDED Enumeration for setting event masks for the different type of events.
static int	EVENT_MASK_VISUALNODE_DELETE_CASCADE Enumeration for setting event masks for the different type of events.
static int	EVENT_MASK_VISUALNODE_PRE_ADD Enumeration for setting event masks for the different type of events.
static int	EVENT_MASK_VISUALNODE_PRE_REMOVE Enumeration for setting event masks for the different type of events.
static int	EVENT_MASK_VISUALNODE_REMOVED Enumeration for setting event masks for the different type of events.

Method Summary

void	addIsolatedVisualEdge(VisualEdge visualedge) Adds a the given VisualEdge object as an isolated edge to this VisualGraphObjectContainer.
void	addVisualEdge(VisualEdge visualedge) Adds a the given VisualEdge object to this VisualGraphObjectContainer.
void	addVisualNode(VisualNode visualnode) Adds a the given VisualNode object to this VisualGraphObjectContainer.
void	disableVisualGraphEvents(int eventmask) Disables all of the events specified in the given eventmask.
void	enableVisualGraphEvents(int eventmask) Enables all of the events specified in the given eventmask.
java.util.Iterator	getAllVisualEdges() Retrieves an Iterator for all VisualEdge objects currently added to this VisualGraphObjectContainer.
GraphObjectContainer	getGraphObjectContainer() Gets the associated GraphObjectContainer of this instance.
VisualEdge	getIsolatedVisualEdgeByID(long id) Returns an isolated VisualEdge by ID or null if no VisualEdge instance with the given ID is added to this VisualGraphObjectContainer.
int	getIsolatedVisualEdgeCount() Returns the number of all isolated VisualEdge objects currently added to this VisualGraphObjectContainer.
java.util.Iterator	getIsolatedVisualEdges() Retrieves an Iterator for all isolated VisualEdge objects currently added to this VisualGraphObjectContainer.
java.util.Collection	getIsolatedVisualEdgesCollection() Retrieves a Collection of all isolated VisualEdge objects currently added to this VisualGraphObjectContainer.
VisualGraphObjectContainer	getParentContainer() VisualGraphObjectContainer instances can be nested inside of each other by means of the VisualSubgraph class.
VisualGraphObjectContainer	getRootContainer() VisualGraphObjectContainer instances can be nested inside of each other by means of the VisualSubgraph class.
VisualEdge	getVisualEdgeByID(long id) Returns a VisualEdge by ID or null if no VisualEdge instance with the given ID is added to this VisualGraphObjectContainer.
int	getVisualEdgeCount() Returns the number of all VisualEdge objects currently added to this VisualGraphObjectContainer.
java.util.Iterator	getVisualEdges() Retrieves an Iterator for all VisualEdge objects currently added to this VisualGraphObjectContainer.
java.util.Collection	getVisualEdgesCollection() Retrieves a Collection of all VisualEdge objects currently added to this VisualGraphObjectContainer.
int	getVisualGraphEventmask() Returns the current visualgraph event mask.
java.util.Iterator	getVisualGraphObjects() Retrieves an Iterator for all VisualGraphObject instances added to this VisualGraphObjectContainer.
VisualNode	getVisualNodeByID(long id) Returns a VisualNode by ID or null if no VisualNode instance with the given ID is added to this VisualGraphObjectContainer.
VisualNode	getVisualNodeByName(java.lang.String name) Returns a VisualNode by its name or null if no VisualNode instance with the given name is added to this VisualGraphObjectContainer.
int	getVisualNodeCount() Returns the number of all VisualNode objects currently added to this VisualGraphObjectContainer.
java.util.Iterator	getVisualNodes() Retrieves an Iterator for all VisualNode objects currently added to this VisualGraphObjectContainer.
java.util.Collection	getVisualNodesCollection() Retrieves a Collection of all VisualNode objects currently added to this VisualGraphObjectContainer.
VisualPort	getVisualPortByID(long id) Returns the VisualPort with the given ID or null if a VisualPort with the given ID does not exist.
void	removeIsolatedVisualEdge(VisualEdge visualedge) Removes the given isolated VisualEdge object from this VisualGraphObjectContainer.
void	removeVisualEdge(VisualEdge visualedge) Removes the given VisualEdge object from this VisualGraphObjectContainer.
void	removeVisualNode(VisualNode visualnode) Removes the given VisualNode object from this VisualGraphObjectContainer.
void	specificPortReassignmentVisualEdge(VisualEdge visualedge, VisualPortAssignmentPredicate predicate) Reassigns all connected ports of a single edge to the desired port match.
void	specificPortReassignmentVisualEdge(VisualEdge visualedge, VisualPortAssignmentPredicate predicateSource, VisualPortAssignmentPredicate predicateTarget) Reassigns all connected ports of a single edge to the desired port match.
void	specificPortReassignmentVisualEdgeSource(VisualEdge visualedge, VisualPortAssignmentPredicate predicate) Reassigns the source end of a single edge to the desired port match.
void	specificPortReassignmentVisualEdgeTarget(VisualEdge visualedge, VisualPortAssignmentPredicate predicate) Reassigns the target end of a single edge to the desired port match.
void	startBulkModify() Begins a bulkmodify operation.
void	stopBulkModify() Finishes a bulkmodify operation.
void	visitSubgraphs(VisualGraphVisitor visitor) Recurse over all nested subgraphs starting from this visualsubgraph.

Field Detail

EVENT_MASK_VISUALNODE_ADDED

public static final int EVENT_MASK_VISUALNODE_ADDED

Enumeration for setting event masks for the different type of events.

See Also:

Constant Field Values

EVENT_MASK_VISUALNODE_REMOVED

public static final int EVENT_MASK_VISUALNODE_REMOVED

Enumeration for setting event masks for the different type of events.

See Also:

Constant Field Values

EVENT_MASK_VISUALEDGE_ADDED

public static final int EVENT_MASK_VISUALEDGE_ADDED

Enumeration for setting event masks for the different type of events.

See Also:

Constant Field Values

EVENT_MASK_VISUALEDGE_REMOVED

public static final int EVENT_MASK_VISUALEDGE_REMOVED

Enumeration for setting event masks for the different type of events.

See Also:

Constant Field Values

EVENT_MASK_ISOLATED_VISUALEDGE_ADDED

public static final int EVENT_MASK_ISOLATED_VISUALEDGE_ADDED

Enumeration for setting event masks for the different type of events.

See Also:

Constant Field Values

EVENT_MASK_ISOLATED_VISUALEDGE_REMOVED

public static final int EVENT_MASK_ISOLATED_VISUALEDGE_REMOVED

Enumeration for setting event masks for the different type of events.

See Also:

Constant Field Values

EVENT_MASK_LAYOUT

public static final int EVENT_MASK_LAYOUT

Enumeration for setting event masks for the different type of events.

See Also:

Constant Field Values

EVENT_MASK_EDGESPLIT

public static final int EVENT_MASK_EDGESPLIT

Enumeration for setting event masks for the different type of events.

See Also:

Constant Field Values

EVENT_MASK_VISUALNODE_DELETE_CASCADE

public static final int EVENT_MASK_VISUALNODE_DELETE_CASCADE

Enumeration for setting event masks for the different type of events.

See Also:

Constant Field Values

EVENT_MASK_VISUALNODE_PRE_ADD

public static final int EVENT_MASK_VISUALNODE_PRE_ADD

Enumeration for setting event masks for the different type of events.

See Also:

Constant Field Values

EVENT_MASK_VISUALNODE_PRE_REMOVE

public static final int EVENT_MASK_VISUALNODE_PRE_REMOVE

Enumeration for setting event masks for the different type of events.

See Also:

Constant Field Values

EVENT_MASK_VISUALEDGE_PRE_ADD

public static final int EVENT_MASK_VISUALEDGE_PRE_ADD

Enumeration for setting event masks for the different type of events.

See Also:

Constant Field Values

EVENT_MASK_VISUALEDGE_PRE_REMOVE

public static final int EVENT_MASK_VISUALEDGE_PRE_REMOVE

Enumeration for setting event masks for the different type of events.

See Also:

Constant Field Values

EVENT_MASK_ISOLATED_VISUALEDGE_PRE_ADD

public static final int EVENT_MASK_ISOLATED_VISUALEDGE_PRE_ADD

Enumeration for setting event masks for the different type of events.

See Also:

Constant Field Values

EVENT_MASK_ISOLATED_VISUALEDGE_PRE_REMOVE

public static final int EVENT_MASK_ISOLATED_VISUALEDGE_PRE_REMOVE

Enumeration for setting event masks for the different type of events.

See Also:

Constant Field Values

Method Detail

getRootContainer

public VisualGraphObjectContainer getRootContainer()

VisualGraphObjectContainer instances can be nested inside of each other by means of the VisualSubgraph class. This method returns the root VisualGraphObjectContainer of the nesting hierarchy, or the this pointer if this instance is the root of the hierarchy. In case this instance is not added to a parent VisualGraphObjectContainer this method returns null.

Returns:

VisualGraphObjectContainer the root of the nesting hierarchy or this.

See Also:

VisualSubgraph

Find more information in the class documentation

getParentContainer

public VisualGraphObjectContainer getParentContainer()

VisualGraphObjectContainer instances can be nested inside of each other by means of the VisualSubgraph class. This method returns the parent VisualGraphObjectContainer of this VisualGraphObjectContainer or null if this instance is the root of the hierarchy.

Returns:

the parent of this instance or null.

See Also:

VisualSubgraph

Find more information in the class documentation

getGraphObjectContainer

public GraphObjectContainer getGraphObjectContainer()

Gets the associated GraphObjectContainer of this instance. The model instance can be associated with one or multiple VisualGraphObjectContainer instances.

Returns:

the associated GraphObjectContainer

Find more information in the class documentation

getVisualGraphObjects

public java.util.Iterator getVisualGraphObjects()

Retrieves an Iterator for all VisualGraphObject instances added to this VisualGraphObjectContainer.

Returns:

an Iterator over all VisualGraphObject instances currently added to this VisualGraphObjectContainer

See Also:

VisualGraphObject

Find more information in the class documentation

getVisualNodeCount

public int getVisualNodeCount()

Returns the number of all VisualNode objects currently added to this VisualGraphObjectContainer.

Returns:

the number of VisualNode objects added to the VisualGraphObjectContainer

See Also:

VisualNode

getVisualNodeByID

public VisualNode getVisualNodeByID(long id)

Returns a VisualNode by ID or null if no VisualNode instance with the given ID is added to this VisualGraphObjectContainer.

Parameters:

id - the ID to query

Returns:

VisualNode the VisualNode object with the given id or null if none was found

See Also:

VisualNode

getVisualNodeByName

public VisualNode getVisualNodeByName(java.lang.String name)

Returns a VisualNode by its name or null if no VisualNode instance with the given name is added to this VisualGraphObjectContainer.
The name of a VisualNode is given through the Node it is associated to.

Parameters:

name - the name to query

Returns:

the VisualNode with the given name.

See Also:

VisualNode, GraphObject.getLabel()

getVisualNodes

public java.util.Iterator getVisualNodes()

Retrieves an Iterator for all VisualNode objects currently added to this VisualGraphObjectContainer.

Returns:

an Iterator over all VisualNode instances currently added to this VisualGraphObjectContainer

See Also:

VisualNode, Iterator

Find more information in the class documentation

getVisualNodesCollection

public java.util.Collection getVisualNodesCollection()

Retrieves a Collection of all VisualNode objects currently added to this VisualGraphObjectContainer.

Returns:

Collection a Collection of all VisualNode objects currently added to this VisualGraphObjectContainer.

See Also:

VisualNode, Collection

getVisualEdgeCount

public int getVisualEdgeCount()

Returns the number of all VisualEdge objects currently added to this VisualGraphObjectContainer.

Returns:

the number of VisualEdge objects added to the VisualGraphObjectContainer

See Also:

VisualEdge

getVisualEdgeByID

public VisualEdge getVisualEdgeByID(long id)

Returns a VisualEdge by ID or null if no VisualEdge instance with the given ID is added to this VisualGraphObjectContainer.

Parameters:

id - the ID to query

Returns:

VisualEdge the VisualEdge object with the given id or null if none was found

See Also:

VisualEdge

getVisualEdges

public java.util.Iterator getVisualEdges()

Retrieves an Iterator for all VisualEdge objects currently added to this VisualGraphObjectContainer.

Returns:

an Iterator over all VisualEdge instances currently added to this VisualGraphObjectContainer

See Also:

VisualEdge, Iterator

Find more information in the class documentation

getVisualEdgesCollection

public java.util.Collection getVisualEdgesCollection()

Retrieves a Collection of all VisualEdge objects currently added to this VisualGraphObjectContainer.

Returns:

Collection a Collection of all VisualEdge objects currently added to this VisualGraphObjectContainer.

See Also:

VisualEdge, Collection

getIsolatedVisualEdgeCount

public int getIsolatedVisualEdgeCount()

Returns the number of all isolated VisualEdge objects currently added to this VisualGraphObjectContainer.

Returns:

the number of isolated VisualEdge objects added to the VisualGraphObjectContainer

See Also:

VisualEdge

getIsolatedVisualEdgeByID

public VisualEdge getIsolatedVisualEdgeByID(long id)

Returns an isolated VisualEdge by ID or null if no VisualEdge instance with the given ID is added to this VisualGraphObjectContainer.

Parameters:

id - the ID to query

Returns:

VisualEdge the isolated VisualEdge object with the given id or null if none was found

See Also:

VisualEdge

getIsolatedVisualEdges

public java.util.Iterator getIsolatedVisualEdges()

Retrieves an Iterator for all isolated VisualEdge objects currently added to this VisualGraphObjectContainer.

Returns:

an Iterator over all isolated VisualEdge instances currently added to this VisualGraphObjectContainer

See Also:

VisualEdge, Iterator

Find more information in the class documentation

getIsolatedVisualEdgesCollection

public java.util.Collection getIsolatedVisualEdgesCollection()

Retrieves a Collection of all isolated VisualEdge objects currently added to this VisualGraphObjectContainer.

Returns:

Collection a Collection of all isolated VisualEdge objects currently added to this VisualGraphObjectContainer.

See Also:

VisualEdge, Collection

getAllVisualEdges

public java.util.Iterator getAllVisualEdges()

Retrieves an Iterator for all VisualEdge objects currently added to this VisualGraphObjectContainer. All means in this case that both isolated and connected VisualEdge objects are accessible through the returned Iterator.

Returns:

an Iterator of all VisualEdge objects currently added to this VisualGraphObjectContainer.

See Also:

VisualEdge, Iterator

getVisualPortByID

public VisualPort getVisualPortByID(long id)

Returns the VisualPort with the given ID or null if a VisualPort with the given ID does not exist.

Parameters:

id - the id to query.

Returns:

the VisualPort with the given id or null.

See Also:

VisualPort

addVisualNode

public void addVisualNode(VisualNode visualnode)

Adds a the given VisualNode object to this VisualGraphObjectContainer.
The VisualNode object mustn't be added to another VisualGraphObjectContainer for this operation to succeed.
In any case the given VisualNode object can't be added to this VisualGraphObjectContainer an InvalidArgumentException is thrown. A VisualNode might be prevented from getting added to a VisualGraphObjectContainer because of a veto, the NodeRule it is associated with, the VisualNode is already added to another VisualGraphObjectContainer, the associated model Node was not previously added to the corresponding GraphObjectContainer or for other reasons.

Parameters:

visualnode - the VisualNode to add to this VisualGraphObjectContainer

Throws:

InvalidArgumentException - thrown if the given VisualNode is null or if it can't be added to this VisualGraphObjectContainer

See Also:

VisualNode, Node, GraphObjectContainer, NodeRule

removeVisualNode

public void removeVisualNode(VisualNode visualnode)
                      throws IllegalNodeException

Removes the given VisualNode object from this VisualGraphObjectContainer.
The VisualNode object must be added to this VisualGraphObjectContainer for this operation to succeed otherwise an IllegalNodeException is thrown.
An IllegalNodeException is also thrown in case the VisualNode object can't be removed from the VisualGraphObjectContainer for other reasons like a veto or the NodeRule that is associated to the VisualNode or whatever.

Parameters:

visualnode - the VisualNode object to remove from this VisualGraphObjectContainer.

Throws:

IllegalNodeException - thrown if the VisualNode object is null or if it can't be removed from this VisualGraphObjectContainer

See Also:

VisualNode, NodeRule

addVisualEdge

public void addVisualEdge(VisualEdge visualedge)

Adds a the given VisualEdge object to this VisualGraphObjectContainer.
The VisualEdge object mustn't be added to another VisualGraphObjectContainer for this operation to succeed.
In any case the given VisualEdge object can't be added to this VisualGraphObjectContainer an InvalidArgumentException is thrown. A VisualEdge might be prevented from getting added to a VisualGraphObjectContainer because of a veto, the EdgeRule it is associated with, the VisualEdge is already added to another VisualGraphObjectContainer, the associated model Edge was not previously added to the corresponding GraphObjectContainer or for other reasons.

Parameters:

visualedge - the VisualEdge to add to this VisualGraphObjectContainer

Throws:

InvalidArgumentException - thrown if the given VisualEdge is null or if it can't be added to this VisualGraphObjectContainer

See Also:

VisualEdge, Edge, GraphObjectContainer, EdgeRule

Find more information in the class documentation

removeVisualEdge

public void removeVisualEdge(VisualEdge visualedge)
                      throws IllegalEdgeException

Removes the given VisualEdge object from this VisualGraphObjectContainer.
The VisualEdge object must be added to this VisualGraphObjectContainer for this operation to succeed otherwise an IllegalEdgeException is thrown.
An IllegalEdgeException is also thrown in case the VisualEdge object can't be removed from the VisualGraphObjectContainer for other reasons like a veto or the EdgeRule that is associated to the VisualEdge or whatever.

Parameters:

visualedge - the VisualEdge object to remove from this VisualGraphObjectContainer.

Throws:

IllegalEdgeException - thrown if the VisualEdge object is null or if it can't be removed from this VisualGraphObjectContainer

See Also:

VisualEdge, EdgeRule

Find more information in the class documentation

addIsolatedVisualEdge

public void addIsolatedVisualEdge(VisualEdge visualedge)

Adds a the given VisualEdge object as an isolated edge to this VisualGraphObjectContainer.
The VisualEdge object mustn't be added to another VisualGraphObjectContainer for this operation to succeed.
In any case the given VisualEdge object can't be added to this VisualGraphObjectContainer an InvalidArgumentException is thrown. A VisualEdge might be prevented from getting added to a VisualGraphObjectContainer because of a veto, the EdgeRule it is associated with, the VisualEdge is already added to another VisualGraphObjectContainer or for other reasons.

Parameters:

visualedge - the VisualEdge to add as an isolated to this VisualGraphObjectContainer

Throws:

InvalidArgumentException - thrown if the given VisualEdge is null or if it can't be added to this VisualGraphObjectContainer

See Also:

VisualEdge, EdgeRule

Find more information in the class documentation

removeIsolatedVisualEdge

public void removeIsolatedVisualEdge(VisualEdge visualedge)
                              throws IllegalEdgeException

Removes the given isolated VisualEdge object from this VisualGraphObjectContainer.
The VisualEdge object must be added as an isolated edge to this VisualGraphObjectContainer for this operation to succeed otherwise an IllegalEdgeException is thrown.
An IllegalEdgeException is also thrown in case the VisualEdge object can't be removed from the VisualGraphObjectContainer for other reasons like a veto or the EdgeRule that is associated to the VisualEdge or whatever.

Parameters:

visualedge - the VisualEdge object to remove from this VisualGraphObjectContainer.

Throws:

IllegalEdgeException - thrown if the VisualEdge object is null or if it can't be removed from this VisualGraphObjectContainer

See Also:

VisualEdge, EdgeRule

Find more information in the class documentation

visitSubgraphs

public void visitSubgraphs(VisualGraphVisitor visitor)

Recurse over all nested subgraphs starting from this visualsubgraph.

Parameters:

visitor - the VisualGraphVisitor that is used as a functional callback for each encountered nested VisualSubgraphs.

Find more information in the class documentation

specificPortReassignmentVisualEdgeSource

public void specificPortReassignmentVisualEdgeSource(VisualEdge visualedge,
                                                     VisualPortAssignmentPredicate predicate)

Reassigns the source end of a single edge to the desired port match. (Note that nothing will happen if the source end of edge is not connected.) This is done accordingly to the user supplied predicate function.

Parameters:

visualedge - the VisualEdge for which ports are to be reassigned at the end of the VisualEdge.

predicate - a VisualPortAssignmentPredicate that specifies the details of the port reassignment.

See Also:

VisualPortAssignmentPredicate

specificPortReassignmentVisualEdgeTarget

public void specificPortReassignmentVisualEdgeTarget(VisualEdge visualedge,
                                                     VisualPortAssignmentPredicate predicate)

Reassigns the target end of a single edge to the desired port match. (Note that nothing will happen if the target end of edge is not connected.) This is done accordingly to the user supplied predicate function.

Parameters:

visualedge - the VisualEdge for which ports are to be reassigned at the end of the VisualEdge.

predicate - a VisualPortAssignmentPredicate that specifies the details of the port reassignment.

See Also:

VisualPortAssignmentPredicate

specificPortReassignmentVisualEdge

public void specificPortReassignmentVisualEdge(VisualEdge visualedge,
                                               VisualPortAssignmentPredicate predicateSource,
                                               VisualPortAssignmentPredicate predicateTarget)

Reassigns all connected ports of a single edge to the desired port match. (Note that an edge cannot have more than 2 connected ports) This is done accordingly to the user supplied predicate function.

Parameters:

visualedge - the VisualEdge for which ports are to be reassigned.

predicateSource - a VisualPortAssignmentPredicate that specifies the details of the port reassignment for the source port of the edge.

predicateTarget - a VisualPortAssignmentPredicate that specifies the details of the port reassignment for the target port of the edge.

See Also:

VisualPortAssignmentPredicate

specificPortReassignmentVisualEdge

public void specificPortReassignmentVisualEdge(VisualEdge visualedge,
                                               VisualPortAssignmentPredicate predicate)

Reassigns all connected ports of a single edge to the desired port match. (Note that an edge cannot have more than 2 connected ports) This is done accordingly to the user supplied predicate function.

Parameters:

visualedge - the VisualEdge for which ports are to be reassigned.

predicate - a VisualPortAssignmentPredicate that specifies the details of the port reassignment.

See Also:

VisualPortAssignmentPredicate

getVisualGraphEventmask

public int getVisualGraphEventmask()

Returns the current visualgraph event mask.

Returns:

current visualgraph event mask.

enableVisualGraphEvents

public void enableVisualGraphEvents(int eventmask)

Enables all of the events specified in the given eventmask.

Parameters:

eventmask - specifies which events to enable.

disableVisualGraphEvents

public void disableVisualGraphEvents(int eventmask)

Disables all of the events specified in the given eventmask.

Parameters:

eventmask - specifies which events to disable.

startBulkModify

public void startBulkModify()

Begins a bulkmodify operation. A call to this operation must be paired with a later call to stopBulkModify(). This must always be ensured by the client.

stopBulkModify

public void stopBulkModify()

Finishes a bulkmodify operation. A call to this operation must be paired with a previous call to startBulkModify(). This must always be ensured by the client.