wt.eff
Class EffVisitor

java.lang.Object
  wt.visitor.VisitorAdapter
      wt.eff.EffVisitor

All Implemented Interfaces:

Serializable, Visitor

public class EffVisitor

extends VisitorAdapter

implements Serializable

Visitor used to append effectivities to a node.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private EffGroup[]	effGroups
private static String	RESOURCE
private boolean	visitedQuietly

Constructor Summary

EffVisitor(EffGroup a_EffGroup)
Constructs a visitor that will append the provided group.

EffVisitor(EffGroup[] a_EffGroups)
Constructs a visitor that will append the provided groups.

EffVisitor(EffGroup[] a_EffGroups, boolean a_IsVisitedQuietly)
Constructs a visitor that will append the provided groups.

EffVisitor(EffGroup a_EffGroup, boolean a_IsVisitedQuietly)
Constructs a visitor that will append the provided group.

Method Summary

private void	effGroupsValidate(EffGroup[] a_EffGroups)
EffGroup[]	getEffGroups() Gets the value of the attribute: effGroups; The effectivities (represented using EffGroups) to append to the node.
boolean	isVisitedQuietly() Gets the value of the attribute: visitedQuietly; If true, do not dispatch events when the node is visited.
void	setEffGroups(EffGroup[] a_EffGroups) Sets the value of the attribute: effGroups; The effectivities (represented using EffGroups) to append to the node.
void	setVisitedQuietly(boolean a_VisitedQuietly) Sets the value of the attribute: visitedQuietly; If true, do not dispatch events when the node is visited.
boolean	visit(Persistable fromNode, Link link, Persistable toNode, int level, boolean previouslyVisited) Visits a node, calling EffGroupAssistant's appendEffGroup or appendEffGroupQuietly (based on the setting of visitedQuietly).

Methods inherited from class wt.visitor.VisitorAdapter

visitLevel, visitLevel

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

effGroups

private EffGroup[] effGroups

visitedQuietly

private boolean visitedQuietly

Constructor Detail

EffVisitor

public EffVisitor(EffGroup a_EffGroup)
           throws WTPropertyVetoException

Constructs a visitor that will append the provided group.

Supported API: true

Parameters:

a_EffGroup -

Throws:

WTPropertyVetoException

EffVisitor

public EffVisitor(EffGroup[] a_EffGroups)
           throws WTPropertyVetoException

Constructs a visitor that will append the provided groups.

Supported API: true

Parameters:

a_EffGroups -

Throws:

WTPropertyVetoException

EffVisitor

public EffVisitor(EffGroup a_EffGroup,
                  boolean a_IsVisitedQuietly)
           throws WTPropertyVetoException

Constructs a visitor that will append the provided group.

Supported API: true

Parameters:

a_EffGroup -

a_IsVisitedQuietly - Instructs the visitor to append without dispatching events when set to true.

Throws:

WTPropertyVetoException

See Also:

EffGroupAssistantEvent

EffVisitor

public EffVisitor(EffGroup[] a_EffGroups,
                  boolean a_IsVisitedQuietly)
           throws WTPropertyVetoException

Constructs a visitor that will append the provided groups.

Supported API: true

Parameters:

a_EffGroups -

a_IsVisitedQuietly - Instructs the visitor to append without dispatching events when set to true.

Throws:

WTPropertyVetoException

See Also:

EffGroupAssistantEvent

Method Detail

getEffGroups

public EffGroup[] getEffGroups()

Gets the value of the attribute: effGroups; The effectivities (represented using EffGroups) to append to the node.

Supported API: true

Returns:

EffGroup[]

setEffGroups

public void setEffGroups(EffGroup[] a_EffGroups)
                  throws WTPropertyVetoException

Sets the value of the attribute: effGroups; The effectivities (represented using EffGroups) to append to the node.

Supported API: true

Parameters:

a_EffGroups -

Throws:

WTPropertyVetoException

effGroupsValidate

private void effGroupsValidate(EffGroup[] a_EffGroups)
                        throws WTPropertyVetoException

Parameters:

a_EffGroups -

Throws:

WTPropertyVetoException

isVisitedQuietly

public boolean isVisitedQuietly()

Gets the value of the attribute: visitedQuietly; If true, do not dispatch events when the node is visited.

Supported API: true

Returns:

boolean

setVisitedQuietly

public void setVisitedQuietly(boolean a_VisitedQuietly)

Sets the value of the attribute: visitedQuietly; If true, do not dispatch events when the node is visited.

Supported API: true

Parameters:

a_VisitedQuietly -

visit

public boolean visit(Persistable fromNode,
                     Link link,
                     Persistable toNode,
                     int level,
                     boolean previouslyVisited)
              throws WTException

Visits a node, calling EffGroupAssistant's appendEffGroup or appendEffGroupQuietly (based on the setting of visitedQuietly).

Supported API: true

Specified by:

visit in interface Visitor

Overrides:

visit in class VisitorAdapter

Parameters:

fromNode -

link -

toNode -

level -

previouslyVisited -

Returns:

boolean

Throws:

WTException