net.sourceforge.openutils.mgnlcriteria.advanced.impl
Class AdvancedResultImpl

java.lang.Object
  net.sourceforge.openutils.mgnlcriteria.advanced.impl.AdvancedResultImpl

All Implemented Interfaces:

AdvancedResult

public class AdvancedResultImpl
extends Object
implements AdvancedResult

Version:

$Id: AdvancedResultImpl.java 3369 2011-03-05 20:08:02Z fgiust $

Author:

fgiust

Nested Class Summary

Nested classes/interfaces inherited from interface net.sourceforge.openutils.mgnlcriteria.jcr.query.AdvancedResult

AdvancedResult.EmptyResult, AdvancedResult.EmptyResultIterator

Field Summary

Fields inherited from interface net.sourceforge.openutils.mgnlcriteria.jcr.query.AdvancedResult

EMPTY_RESULT

Constructor Summary

AdvancedResultImpl(org.apache.jackrabbit.core.query.lucene.QueryResultImpl jcrQueryResult, int itemsPerPage, int pageNumberStartingFromOne, String statement, info.magnolia.cms.core.HierarchyManager hm, javax.jcr.query.Query spellCheckerQuery)

AdvancedResultImpl(org.apache.jackrabbit.core.query.lucene.QueryResultImpl jcrQueryResult, int itemsPerPage, int pageNumberStartingFromOne, String statement, info.magnolia.cms.core.HierarchyManager hm, javax.jcr.query.Query spellCheckerQuery, boolean applyLocalPaging)

Method Summary

AdvancedResultItem	getFirstResult() Returns the fist result if available, null otherwise.
ResultIterator<AdvancedResultItem>	getItems() Gets an iterator over the results
<K> ResultIterator<K>	getItems(Class<K> theclass) Gets an iterator over the results, transforming objects using content2bean while iterating
int	getItemsPerPage() Gets the maximum number of results per page
int	getNumberOfPages() Gets the total number of pages
int	getPage() Gets the page number (1, 2, 3...)
String	getSpellCheckerSuggestion() Gets the suggestion from the spell checker.
int	getTotalSize() Gets the total number of results that would be retrieved without pagination.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdvancedResultImpl

public AdvancedResultImpl(org.apache.jackrabbit.core.query.lucene.QueryResultImpl jcrQueryResult,
                          int itemsPerPage,
                          int pageNumberStartingFromOne,
                          String statement,
                          info.magnolia.cms.core.HierarchyManager hm,
                          javax.jcr.query.Query spellCheckerQuery)

Parameters:

jcrQueryResult -

itemsPerPage -

pageNumberStartingFromOne -

statement -

hm -

spellCheckerQuery -

AdvancedResultImpl

public AdvancedResultImpl(org.apache.jackrabbit.core.query.lucene.QueryResultImpl jcrQueryResult,
                          int itemsPerPage,
                          int pageNumberStartingFromOne,
                          String statement,
                          info.magnolia.cms.core.HierarchyManager hm,
                          javax.jcr.query.Query spellCheckerQuery,
                          boolean applyLocalPaging)

Parameters:

jcrQueryResult -

itemsPerPage -

pageNumberStartingFromOne -

statement -

hm -

spellCheckerQuery -

applyLocalPaging - don't assume the result iterator is already paginated, do it "manually"

Method Detail

getItemsPerPage

public int getItemsPerPage()

Gets the maximum number of results per page

Specified by:

getItemsPerPage in interface AdvancedResult

Returns:

the maximum number of results per page

getPage

public int getPage()

Gets the page number (1, 2, 3...)

Specified by:

getPage in interface AdvancedResult

Returns:

the page number (1, 2, 3...)

getTotalSize

public int getTotalSize()

Gets the total number of results that would be retrieved without pagination. Note that jackrabbit may return -1 if the query doesn't have a sort condition, in order to optimize execution. Always add an order by clause (e.g. "order by @jcr:score") if you need to get the total size.

Specified by:

getTotalSize in interface AdvancedResult

Returns:

the total number of results that would be retrieved without pagination.

getNumberOfPages

public int getNumberOfPages()

Gets the total number of pages

Specified by:

getNumberOfPages in interface AdvancedResult

Returns:

total number of pages

getItems

public ResultIterator<AdvancedResultItem> getItems()

Gets an iterator over the results

Specified by:

getItems in interface AdvancedResult

Returns:

an iterator over the results

getSpellCheckerSuggestion

public String getSpellCheckerSuggestion()

Gets the suggestion from the spell checker. Note that spell checker must be configured in jackrabbit for this to work. See http://wiki.apache.org/jackrabbit/Search for details.

Specified by:

getSpellCheckerSuggestion in interface AdvancedResult

Returns:

the suggestion from the spell checker

getFirstResult

public AdvancedResultItem getFirstResult()

Returns the fist result if available, null otherwise.

Specified by:

getFirstResult in interface AdvancedResult

Returns:

the fist result if available, null otherwise.

getItems

public <K> ResultIterator<K> getItems(Class<K> theclass)

Gets an iterator over the results, transforming objects using content2bean while iterating

Specified by:

getItems in interface AdvancedResult

Type Parameters:

K - destination class.

Parameters:

theclass - destination class.

Returns:

an iterator over the results