Package com.adobe.cq.cif.common.associatedcontent

Interface AssociatedContentQuery<T>

Type Parameters:

T - the type of the results returned by the Query

public interface AssociatedContentQuery<T>

An AssociatedContentQuery is returned by the AssociatedContentService and can be used to trill down the result set further.

Method Summary

Modifier and Type	Method	Description
java.util.Iterator<T>	execute()	Executes the AssociatedContentQuery returning an Iterator on the result set.
AssociatedContentQuery<T>	withLimit(long limit)	Set a limit to the AssociatedContentQuery.
AssociatedContentQuery<T>	withOffset(long offset)	Set an offset to the AssociatedContentQuery.
<N> AssociatedContentQuery<N>	withTransformer(QueryResultTransformer<N> transformer)	Sets a custom transformer for this query results.

Method Detail

withLimit

AssociatedContentQuery<T> withLimit(long limit)

Set a limit to the AssociatedContentQuery.

If not called, the limit is Long.MAX_VALUE.

Parameters:

limit - the limit

Returns:

the AssociatedContentQuery itself

withOffset

AssociatedContentQuery<T> withOffset(long offset)

Set an offset to the AssociatedContentQuery.

If not called, the offset is 0

Parameters:

offset - the offset

Returns:

the AssociatedContentQuery itself

execute

java.util.Iterator<T> execute()

Executes the AssociatedContentQuery returning an Iterator on the result set. This iterator may contain all query hits or not, depending if a hit can be converted to the result type of the AssociatedContentQuery.

Returns:

an Iterator of a hits that can be converted to the result type, null values filtered out

withTransformer

<N> AssociatedContentQuery<N> withTransformer(QueryResultTransformer<N> transformer)

Sets a custom transformer for this query results. This would transform the results from type T to type N

If not called, the default transformer is used.

Type Parameters:

N - the new result type

Parameters:

transformer - a QueryResultTransformer implementation

Returns:

an AssociatedContentQuery object