Package com.ptc.core.percol

Class PersistedCollectionMemberGraphImpl.PersistedCollectionMemberNodeImpl

java.lang.Object

com.ptc.core.percol.PersistedCollectionMemberGraphImpl.PersistedCollectionMemberNodeImpl

All Implemented Interfaces:

Serializable, PersistedCollectionMemberGraph.PersistedCollectionMemberNode

Enclosing class:

PersistedCollectionMemberGraphImpl

public static class PersistedCollectionMemberGraphImpl.PersistedCollectionMemberNodeImpl
extends Object
implements PersistedCollectionMemberGraph.PersistedCollectionMemberNode, Serializable

Graph node representing a single member of a persisted collection.

Supported API: true

Extendable: false

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
void	clearVisited()	Clear the visited state of this member node.
Map<PersistedCollectionMemberGraph.PersistedCollectionMemberNode,Collection<String>>	getChildNodes()	Get children of this member node.
Object	getCustomObject()	Get custom object for this member node.
String	getFilteredMessage()	Get the filtered message.
int	getMaxLevel()	Get the maximum depth level of this node in the graph (seeds are level 1).
ObjectReference	getMemberRef()	Return member reference of this node.
Map<PersistedCollectionMemberGraph.PersistedCollectionMemberNode,Collection<String>>	getParentNodes()	Get parents of this member node.
boolean	isFilteredOut()	Return filtered out status.
boolean	isVisited()	Get the visited state of this member node.
void	keepInflated()	Prevent iterator methods from deflating the member reference of this node.
Object	setCustomObject(Object customObject)	Set custom object for this member node.
void	setVisited()	Set the visited state of this member node.

Methods inherited from class java.lang.Object

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

Method Details

getMemberRef

public ObjectReference getMemberRef()

Return member reference of this node.

Supported API: true

Specified by:

getMemberRef in interface PersistedCollectionMemberGraph.PersistedCollectionMemberNode

Returns:

ObjectReference to PersistedCollectable member.

isFilteredOut

public boolean isFilteredOut()

Return filtered out status.

Supported API: true

Specified by:

isFilteredOut in interface PersistedCollectionMemberGraph.PersistedCollectionMemberNode

Returns:

True if member is filtered out.

getFilteredMessage

public String getFilteredMessage()

Get the filtered message. This is the message displayed in the "Filtered" column of a customized package contents table view.

Supported API: true

Specified by:

getFilteredMessage in interface PersistedCollectionMemberGraph.PersistedCollectionMemberNode

Returns:

Filtered message, or null if no message.

getMaxLevel

public int getMaxLevel()

Get the maximum depth level of this node in the graph (seeds are level 1). If member is collected from multiple parents then this value is maximum depth level from all parents.

Supported API: true

Specified by:

getMaxLevel in interface PersistedCollectionMemberGraph.PersistedCollectionMemberNode

Returns:

Maximum depth level (always >= 1).

getParentNodes

public Map<PersistedCollectionMemberGraph.PersistedCollectionMemberNode,Collection<String>> getParentNodes()

Get parents of this member node.

Supported API: true

Specified by:

getParentNodes in interface PersistedCollectionMemberGraph.PersistedCollectionMemberNode

Returns:

Map of parent nodes to their relationship roles (null if no parent nodes).

getChildNodes

public Map<PersistedCollectionMemberGraph.PersistedCollectionMemberNode,Collection<String>> getChildNodes()

Get children of this member node.

Supported API: true

Specified by:

getChildNodes in interface PersistedCollectionMemberGraph.PersistedCollectionMemberNode

Returns:

Map of child nodes to their relationship roles (null if no child nodes).

isVisited

public boolean isVisited()

Get the visited state of this member node.

Supported API: true

Specified by:

isVisited in interface PersistedCollectionMemberGraph.PersistedCollectionMemberNode

Returns:

True if the visited state of this node is set.

setVisited

public void setVisited()

Set the visited state of this member node.

Supported API: true

Specified by:

setVisited in interface PersistedCollectionMemberGraph.PersistedCollectionMemberNode

clearVisited

public void clearVisited()

Clear the visited state of this member node.

Supported API: true

Specified by:

clearVisited in interface PersistedCollectionMemberGraph.PersistedCollectionMemberNode

keepInflated

public void keepInflated()

Prevent iterator methods from deflating the member reference of this node.

Supported API: true

Specified by:

keepInflated in interface PersistedCollectionMemberGraph.PersistedCollectionMemberNode

getCustomObject

public Object getCustomObject()

Get custom object for this member node. Used to associated application specific data with the node.

Supported API: true

Specified by:

getCustomObject in interface PersistedCollectionMemberGraph.PersistedCollectionMemberNode

Returns:

Custom object (null if none set prior to call).

setCustomObject

public Object setCustomObject(Object customObject)

Set custom object for this member node. Used to associated application specific data with the node.

Supported API: true

Specified by:

setCustomObject in interface PersistedCollectionMemberGraph.PersistedCollectionMemberNode

Parameters:

customObject - Custom object to set on this node (may be null).

Returns:

Old custom object being replaced (null if none set prior to call).