org.apache.jackrabbit.standalone.cli.collect

Class AbstractCollect

java.lang.Object

org.apache.jackrabbit.standalone.cli.collect.AbstractCollect

All Implemented Interfaces:

org.apache.commons.chain.Command

Direct Known Subclasses:

CollectItems, CollectNodes, CollectProperties

public abstract class AbstractCollect
extends Object
implements org.apache.commons.chain.Command

Collect the children items from the given node and store them under the given key.

Field Summary

Fields inherited from interface org.apache.commons.chain.Command

CONTINUE_PROCESSING, PROCESSING_COMPLETE

Constructor Summary

Constructors

Constructor and Description
AbstractCollect()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	execute(org.apache.commons.chain.Context ctx)
String	getDepthKey()
String	getDestKey()
String	getNamePatternKey()
String	getSrcPathKey()
protected abstract boolean	isCollectNodes() Collect nodes flag
protected abstract boolean	isCollectProperties() Collect properties flag
void	setDepthKey(String depthKey)
void	setDestKey(String destKey) Sets the destination key
void	setNamePatternKey(String namePatternKey)
void	setSrcPathKey(String srcPathKey) Sets the source path key

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCollect

public AbstractCollect()

Method Detail

execute

public final boolean execute(org.apache.commons.chain.Context ctx)
                      throws Exception

Specified by:

execute in interface org.apache.commons.chain.Command

Throws:

Exception

getDepthKey

public String getDepthKey()

Returns:

Returns the depthKey.

setDepthKey

public void setDepthKey(String depthKey)

Parameters:

depthKey - Set the context attribute key for the depth attribute

getNamePatternKey

public String getNamePatternKey()

Returns:

Returns the namePatternKey.

setNamePatternKey

public void setNamePatternKey(String namePatternKey)

Parameters:

namePatternKey - context attribute key for the name pattern attribute

isCollectNodes

protected abstract boolean isCollectNodes()

Collect nodes flag

Returns:

true if Node s must be collected

isCollectProperties

protected abstract boolean isCollectProperties()

Collect properties flag

Returns:

true if Property s must be collected

getDestKey

public String getDestKey()

Returns:

the destination key

setDestKey

public void setDestKey(String destKey)

Sets the destination key

Parameters:

destKey - the detination key

getSrcPathKey

public String getSrcPathKey()

Returns:

the source path key

setSrcPathKey

public void setSrcPathKey(String srcPathKey)

Sets the source path key

Parameters:

srcPathKey - the source path key