Package com.ptc.core.percol

Class PersistedCollectionMemberGraphImpl

java.lang.Object

com.ptc.core.percol.PersistedCollectionMemberGraphImpl

All Implemented Interfaces:

Serializable, PersistedCollectionMemberGraph

public class PersistedCollectionMemberGraphImpl
extends Object
implements PersistedCollectionMemberGraph, Serializable

Graph representation of the collected members of a persisted collection. The roots of the graph are the seeds of the collection (i.e., the initially selected objects). The parent-child relationships represent the navigation path used to collect all members during the last refresh operation. The graph is guaranteed not to contain any cycles, but there may be several paths to any given member.

** IMPORTANT **
For very large graphs it is the caller's responsibility to properly manage performance and memory by inflating member references in chunks, rather than one-at-a-time or all-at-once, and deflating each chunk before inflating the next one. The depth-first navigation iterator provided by this class offers an inflate option to assist with memory management and performance.

Supported API: true

Extendable: false

See Also:

• wt.facade.persistedcollection.PersistedCollectionMemberNode
• wt.facade.persistedcollection.PersistedCollectionService#getMemberGraph(wt.facade.persistedcollection.PersistedCollectableHolder, java.lang.String, java.util.Locale)
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PersistedCollectionMemberGraphImpl.PersistedCollectionMemberNodeImpl	Graph node representing a single member of a persisted collection.

Nested classes/interfaces inherited from interface wt.facade.persistedcollection.PersistedCollectionMemberGraph

PersistedCollectionMemberGraph.DepthIterator, PersistedCollectionMemberGraph.PersistedCollectionMemberNode

Method Summary

Modifier and Type	Method	Description
void	clearAllVisited()	Clear the visited state of all nodes in the member graph.
PersistedCollectionMemberGraph.DepthIterator	depthIterator(boolean inflate, boolean skipRepeated)	Get depth-first graph iterator to PersistedCollectionMemberNode objects with optionally inflated member references.
Collection<PersistedCollectionMemberGraph.PersistedCollectionMemberNode>	getAllMemberNodes()	Get collection of all member nodes from the graph.
WTSet	getAllMembers()	Get set of all members from the graph.
AssociationDisplayAssistant	getDisplayAssistant()	Get the display assistant used for localizing relationship roles.
PersistedCollectableHolder	getHolder()	Get the holder for which this member graph was created.
PersistedCollectionMemberGraph.PersistedCollectionMemberNode	getMemberNode(PersistedCollectable member)	Get the graph node for a collection member.
PersistedCollectionMemberGraph.PersistedCollectionMemberNode	getMemberNode(ObjectReference memberRef)	Get the graph node for a collection member.
Map<Integer,Set<PersistedCollectionMemberGraph.PersistedCollectionMemberNode>>	getMemberNodesByLevel()	Get member nodes sorted by their maximum level in the graph.
Set<PersistedCollectionMemberGraph.PersistedCollectionMemberNode>	getSeedNodes()	Get member nodes corresponding to the seed objects.
int	size()	Get member graph size.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

size

public int size()

Get member graph size.

Supported API: true

Specified by:

size in interface PersistedCollectionMemberGraph

Returns:

Number of nodes in member graph.

getMemberNode

public PersistedCollectionMemberGraph.PersistedCollectionMemberNode getMemberNode(ObjectReference memberRef)

Get the graph node for a collection member.

Supported API: true

Specified by:

getMemberNode in interface PersistedCollectionMemberGraph

Parameters:

memberRef - ObjectReference for a PersistedCollectable member object.

Returns:

PersistedCollectionMemberNode for the specified member reference, or null if the reference is not a member of the graph.

getMemberNode

public PersistedCollectionMemberGraph.PersistedCollectionMemberNode getMemberNode(PersistedCollectable member)

Get the graph node for a collection member.

Supported API: true

Specified by:

getMemberNode in interface PersistedCollectionMemberGraph

Parameters:

member - PersistedCollectable member object.

Returns:

PersistedCollectionMemberNode for the specified member object, or null if the object is not a member of the graph.

getAllMemberNodes

public Collection<PersistedCollectionMemberGraph.PersistedCollectionMemberNode> getAllMemberNodes()

Get collection of all member nodes from the graph.

Supported API: true

Specified by:

getAllMemberNodes in interface PersistedCollectionMemberGraph

Returns:

Collection of all member graph Nodes.

getAllMembers

public WTSet getAllMembers()

Get set of all members from the graph.

Supported API: true

Specified by:

getAllMembers in interface PersistedCollectionMemberGraph

Returns:

Set of all members (non-null, may be empty).

clearAllVisited

public void clearAllVisited()

Clear the visited state of all nodes in the member graph.

Supported API: true

Specified by:

clearAllVisited in interface PersistedCollectionMemberGraph

getSeedNodes

public Set<PersistedCollectionMemberGraph.PersistedCollectionMemberNode> getSeedNodes()

Get member nodes corresponding to the seed objects. Depending on how the configuration specifications were set up for the collector, these objects may be the same as the actual seeds or may be different versions of the actual seeds.

Supported API: true

Specified by:

getSeedNodes in interface PersistedCollectionMemberGraph

Returns:

Set of Member graph nodes for the seed members.

getMemberNodesByLevel

public Map<Integer,Set<PersistedCollectionMemberGraph.PersistedCollectionMemberNode>> getMemberNodesByLevel()

Get member nodes sorted by their maximum level in the graph. When navigating nodes by order of increasing level, it is guaranteed that all parents of a node will be visited before the node itself is reached.

Supported API: true

Specified by:

getMemberNodesByLevel in interface PersistedCollectionMemberGraph

Returns:

Map of maximum level to member nodes at that level (non-null, may be empty).

getHolder

public PersistedCollectableHolder getHolder()

Get the holder for which this member graph was created.

Supported API: true

Specified by:

getHolder in interface PersistedCollectionMemberGraph

Returns:

PersistedCollectableHolder object.

getDisplayAssistant

public AssociationDisplayAssistant getDisplayAssistant()

Get the display assistant used for localizing relationship roles.

Supported API: true

Specified by:

getDisplayAssistant in interface PersistedCollectionMemberGraph

Returns:

AssociationDisplayAssistant object.

depthIterator

public PersistedCollectionMemberGraph.DepthIterator depthIterator(boolean inflate,
 boolean skipRepeated)

Get depth-first graph iterator to PersistedCollectionMemberNode objects with optionally inflated member references. The remove() method may not be called for this iterator.

Inflating and deflated member references are handled internally to the iterator when created with inflate=true. References are inflated and deflated in chunks to maintain a balance between performance and memory usage. Do not use two or more of these iterators with inflate=true simultaneously for the same member graph (i.e., may result in slow performance or excessive memory usage).

Supported API: true

Specified by:

depthIterator in interface PersistedCollectionMemberGraph

Parameters:

inflate - Set true to have the iterator inflate the member references of the nodes being returned by the next() method. Set false to have the iterator return member references in whatever state they are currently in, inflated or deflated.

skipRepeated - True to skip repeated branches of the graph, false to iterate over the entire graph (included repeated branches). If true the iterator will return an entire repeated branch the first time it is encountered, but will only return the root node all subsequent times.

Returns:

Iterator to return member nodes using depth-first graph navigation.

See Also:

• PersistedCollectionMemberGraph.DepthIterator