Package org.apache.sling.pipes.internal.slingquery

Class AbstractSlingQueryPipe

java.lang.Object

org.apache.sling.pipes.BasePipe

org.apache.sling.pipes.internal.slingquery.AbstractSlingQueryPipe

All Implemented Interfaces:

Pipe

Direct Known Subclasses:

AbstractExpressionSlingQueryPipe, ParentPipe

public abstract class AbstractSlingQueryPipe
extends BasePipe

deals with common sling query pipe code

Field Summary

Fields inherited from class org.apache.sling.pipes.BasePipe

afterHook, beforeHook, bindingProviders, bindings, distributionAgent, DRYRUN_EXPR, DRYRUN_KEY, EMPTY_ITERATOR, IGNORED_NODES, IGNORED_PROPERTIES, parent, plumber, PN_AFTERHOOK, PN_BEFOREHOOK, PN_STATUS, PN_STATUS_MODIFIED, properties, READ_ONLY, resolver, resource, RESOURCE_TYPE, RT_PREFIX, SLASH, STATUS_FINISHED, STATUS_STARTED

Fields inherited from interface org.apache.sling.pipes.Pipe

NN_CONF, PN_DISTRIBUTION_AGENT, PN_EXPR, PN_NAME, PN_PATH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSlingQueryPipe(Plumber plumber, org.apache.sling.api.resource.Resource resource, PipeBindings upperBindings)

Method Summary

Modifier and Type	Method	Description
protected Iterator<org.apache.sling.api.resource.Resource>	computeOutput()	generate outputs out of input resource and abstract query
protected abstract org.apache.sling.query.SlingQuery	getQuery(org.apache.sling.api.resource.Resource resource)	generates a sling query object out of a resource
boolean	modifiesContent()	returns true if that pipe modifies content during its execution

Methods inherited from class org.apache.sling.pipes.BasePipe

after, before, getBindings, getComputedPath, getConfiguration, getDistributionAgent, getExpr, getInput, getName, getOutput, getOutputBinding, getParent, getPath, getPreviousPipe, getPreviousResource, getRawExpression, getRawPath, getResource, isDryRun, isRootPath, provideAdditionalBindings, setParent, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSlingQueryPipe

protected AbstractSlingQueryPipe(Plumber plumber,
                                 org.apache.sling.api.resource.Resource resource,
                                 PipeBindings upperBindings)

Method Detail

modifiesContent

public boolean modifiesContent()

Description copied from interface: Pipe

returns true if that pipe modifies content during its execution

Specified by:

modifiesContent in interface Pipe

Overrides:

modifiesContent in class BasePipe

Returns:

true for write / false for read

getQuery

protected abstract org.apache.sling.query.SlingQuery getQuery(org.apache.sling.api.resource.Resource resource)

generates a sling query object out of a resource

Parameters:

resource - input resource

Returns:

SlingQuery object

computeOutput

protected Iterator<org.apache.sling.api.resource.Resource> computeOutput()

generate outputs out of input resource and abstract query

Overrides:

computeOutput in class BasePipe

Returns:

output's resource iterator, empty in case input is null