org.apache.jackrabbit.core.query.lucene

Class QueryResultImpl

java.lang.Object

org.apache.jackrabbit.core.query.lucene.QueryResultImpl

All Implemented Interfaces:

QueryResult, org.apache.jackrabbit.api.query.JackrabbitQueryResult

Direct Known Subclasses:

MultiColumnQueryResult, SingleColumnQueryResult

public abstract class QueryResultImpl
extends Object
implements org.apache.jackrabbit.api.query.JackrabbitQueryResult

Implements the QueryResult interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,ColumnImpl>	columns The columns to select.
protected boolean	docOrder If true nodes are returned in document order.
protected SearchIndex	index The search index to execute the query.
protected AbstractQueryImpl	queryImpl The query instance which created this query result.
protected SessionContext	sessionContext Component context of the current session
protected org.apache.jackrabbit.core.query.lucene.SpellSuggestion	spellSuggestion The spell suggestion or null if not available.

Constructor Summary

Constructors

Constructor and Description
QueryResultImpl(SearchIndex index, SessionContext sessionContext, AbstractQueryImpl queryImpl, org.apache.jackrabbit.core.query.lucene.SpellSuggestion spellSuggestion, ColumnImpl[] columns, boolean documentOrder, long offset, long limit) Creates a new query result.

Method Summary

Modifier and Type	Method and Description
protected abstract ExcerptProvider	createExcerptProvider() Creates an excerpt provider for this result set.
protected abstract MultiColumnQueryHits	executeQuery(long resultFetchHint) Executes the query for this result and returns hits.
String[]	getColumnNames()
NodeIterator	getNodes()
protected void	getResults(long size) Attempts to get size results and puts them into resultNodes.
RowIterator	getRows()
String[]	getSelectorNames()
int	getTotalSize() Returns the total number of hits.
protected boolean	isAccessGranted(ScoreNode[] nodes) Checks if access is granted to all nodes.

Methods inherited from class java.lang.Object

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

Field Detail

index

protected final SearchIndex index

The search index to execute the query.

sessionContext

protected final SessionContext sessionContext

Component context of the current session

queryImpl

protected final AbstractQueryImpl queryImpl

The query instance which created this query result.

spellSuggestion

protected final org.apache.jackrabbit.core.query.lucene.SpellSuggestion spellSuggestion

The spell suggestion or null if not available.

columns

protected final Map<String,ColumnImpl> columns

The columns to select.

docOrder

protected final boolean docOrder

If true nodes are returned in document order.

Constructor Detail

QueryResultImpl

public QueryResultImpl(SearchIndex index,
                       SessionContext sessionContext,
                       AbstractQueryImpl queryImpl,
                       org.apache.jackrabbit.core.query.lucene.SpellSuggestion spellSuggestion,
                       ColumnImpl[] columns,
                       boolean documentOrder,
                       long offset,
                       long limit)
                throws RepositoryException

Creates a new query result. The concrete sub class is responsible for calling getResults(long) after this constructor had been called.

Parameters:

index - the search index where the query is executed.

sessionContext - component context of the current session

queryImpl - the query instance which created this query result.

spellSuggestion - the spell suggestion or null if none is available.

columns - the select properties of the query.

documentOrder - if true the result is returned in document order.

limit - the maximum result size

offset - the offset in the total result set

Throws:

RepositoryException - if an error occurs while reading from the repository.

IllegalArgumentException - if any of the columns does not have a column name.

Method Detail

getSelectorNames

public String[] getSelectorNames()
                          throws RepositoryException

Specified by:

getSelectorNames in interface QueryResult

Throws:

RepositoryException

getColumnNames

public String[] getColumnNames()
                        throws RepositoryException

Specified by:

getColumnNames in interface QueryResult

Throws:

RepositoryException

getNodes

public NodeIterator getNodes()
                      throws RepositoryException

Specified by:

getNodes in interface QueryResult

Throws:

RepositoryException

getRows

public RowIterator getRows()
                    throws RepositoryException

Specified by:

getRows in interface QueryResult

Throws:

RepositoryException

executeQuery

protected abstract MultiColumnQueryHits executeQuery(long resultFetchHint)
                                              throws IOException

Executes the query for this result and returns hits. The caller must close the query hits when he is done using it.

Parameters:

resultFetchHint - a hint on how many results should be fetched.

Returns:

hits for this query result.

Throws:

IOException - if an error occurs while executing the query.

createExcerptProvider

protected abstract ExcerptProvider createExcerptProvider()
                                                  throws IOException

Creates an excerpt provider for this result set.

Returns:

an excerpt provider.

Throws:

IOException - if an error occurs.

getResults

protected void getResults(long size)
                   throws RepositoryException

Attempts to get size results and puts them into resultNodes. If the size of resultNodes is less than size then there are no more than resultNodes.size() results for this query.

Parameters:

size - the number of results to fetch for the query.

Throws:

RepositoryException - if an error occurs while executing the query.

isAccessGranted

protected boolean isAccessGranted(ScoreNode[] nodes)
                           throws RepositoryException

Checks if access is granted to all nodes.

Parameters:

nodes - the nodes to check.

Returns:

true if read access is granted to all nodes.

Throws:

RepositoryException - if an error occurs while checking access rights.

getTotalSize

public int getTotalSize()

Returns the total number of hits. This is the number of results you will get get if you don't set any limit or offset. This method may return -1 if the total size is unknown.

If the "sizeEstimate" options is enabled: Keep in mind that this number may get smaller if nodes are found in the result set which the current session has no permission to access. This might be a security problem.

Specified by:

getTotalSize in interface org.apache.jackrabbit.api.query.JackrabbitQueryResult

Returns:

the total number of hits.