org.alfresco.repo.search.impl.lucene
Class LuceneResultSet

java.lang.Object
  extended by org.alfresco.repo.search.AbstractResultSet
      extended by org.alfresco.repo.search.impl.lucene.LuceneResultSet
All Implemented Interfaces:
java.lang.Iterable, ResultSet, ResultSetSPI

public class LuceneResultSet
extends AbstractResultSet

Implementation of a ResultSet on top of Lucene Hits class.


Constructor Summary
LuceneResultSet(org.apache.lucene.search.Hits hits, org.apache.lucene.search.Searcher searcher, NodeService nodeService, TenantService tenantService, SearchParameters searchParameters, LuceneConfig config)
          Wrap a lucene seach result with node support
 
Method Summary
 void close()
          Close the result set and release any resources held/ The result set is bound to the transaction and will auto close at the end of the transaction.
 ChildAssociationRef getChildAssocRef(int n)
          Get the child assoc ref for a particular row.
 org.apache.lucene.document.Document getDocument(int n)
           
 NodeRef getNodeRef(int n)
          Get the id of the node at the given index (if there is only one selector or no selector)
 NodeService getNodeService()
           
 ResultSetMetaData getResultSetMetaData()
          Get the meta data for the results set.
 ResultSetRow getRow(int i)
          Get a row from the result set by row index, starting at 0.
 float getScore(int n)
          Get the score for the node at the given position (if there is only one selector or no selector)
 int getStart()
          Get the start point for this results set in the overall set of rows that match the query - this will be equal to the skip count set when executing the query, and zero if this is not set.
 TenantService getTenantService()
           
 boolean hasMore()
          Was this result set curtailed - are there more pages to the result set?
 ResultSetRowIterator iterator()
           
 int length()
          Get the number of rows in this result set.
 
Methods inherited from class org.alfresco.repo.search.AbstractResultSet
getChildAssocRefs, getNodeRefs
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LuceneResultSet

public LuceneResultSet(org.apache.lucene.search.Hits hits,
                       org.apache.lucene.search.Searcher searcher,
                       NodeService nodeService,
                       TenantService tenantService,
                       SearchParameters searchParameters,
                       LuceneConfig config)
Wrap a lucene seach result with node support

Parameters:
storeRef -
hits -
Method Detail

iterator

public ResultSetRowIterator iterator()

length

public int length()
Description copied from interface: ResultSetSPI
Get the number of rows in this result set. This will be less than or equal to the maximum number of rows requested or the full length of the results set if no restriction on length are specified. If a skip count is given, the length represents the number of results after the skip count and does not include the items skipped.

Returns:
the number of results. -1 means unknown and can be returned for lazy evaluations of permissions when the actual size is not known and evaluated upon request.

getNodeRef

public NodeRef getNodeRef(int n)
Description copied from interface: ResultSetSPI
Get the id of the node at the given index (if there is only one selector or no selector)

Parameters:
n - zero-based index
Returns:
return the the node ref for the row if there is only one selector

getScore

public float getScore(int n)
               throws SearcherException
Description copied from interface: ResultSetSPI
Get the score for the node at the given position (if there is only one selector or no selector)

Specified by:
getScore in interface ResultSetSPI
Overrides:
getScore in class AbstractResultSet
Parameters:
n - zero-based index
Returns:
return the score for the row if there is only one selector
Throws:
SearcherException

getDocument

public org.apache.lucene.document.Document getDocument(int n)

close

public void close()
Description copied from interface: ResultSetSPI
Close the result set and release any resources held/ The result set is bound to the transaction and will auto close at the end of the transaction.

Specified by:
close in interface ResultSetSPI
Overrides:
close in class AbstractResultSet

getNodeService

public NodeService getNodeService()

getRow

public ResultSetRow getRow(int i)
Description copied from interface: ResultSetSPI
Get a row from the result set by row index, starting at 0.

Parameters:
i - zero-based index
Returns:
return the row

getChildAssocRef

public ChildAssociationRef getChildAssocRef(int n)
Description copied from interface: ResultSetSPI
Get the child assoc ref for a particular row. (if there is only one selectoror no selector)

Parameters:
n - zero-based index
Returns:
the child assoc ref for the row if there is only one selector or no selector

getResultSetMetaData

public ResultSetMetaData getResultSetMetaData()
Description copied from interface: ResultSetSPI
Get the meta data for the results set.

Returns:
the metadata

getStart

public int getStart()
Description copied from interface: ResultSetSPI
Get the start point for this results set in the overall set of rows that match the query - this will be equal to the skip count set when executing the query, and zero if this is not set.

Returns:
the position of the first result in the overall result set

hasMore

public boolean hasMore()
Description copied from interface: ResultSetSPI
Was this result set curtailed - are there more pages to the result set?

Returns:
true if there are more pages in the result set

getTenantService

public TenantService getTenantService()


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.