ResultSetSPI (Alfresco 5.1.4.1 Public Java API)

org.alfresco.service.cmr.search

Interface ResultSetSPI<ROW extends ResultSetRow,MD extends ResultSetMetaData>

All Superinterfaces:

All Known Subinterfaces:

@org.alfresco.api.AlfrescoPublicApi
public interface ResultSetSPI<ROW extends ResultSetRow,MD extends ResultSetMetaData>

extends Iterable<ROW>

This is the common interface for both row (Alfresco node) and column (CMIS style property or function) based results. The meta-data for the results sets contains the detailed info on what columns are available. For row based result sets there is no selector - all the nodes returned do not have to have a specific type or aspect. For example, an FTS search on properties of type d:content has no type constraint implied or otherwise. Searches against properties have an implied type, but as there can be more than one property -> more than one type or aspect implied (eg via OR in FTS or lucene) they are ignored An iterable result set from a searcher query. Implementations must implement the indexes for row lookup as zero-based.

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.
boolean	getBulkFetch() Do we bulk fetch
int	getBulkFetchSize() Get the bulk fetch size.
ChildAssociationRef	getChildAssocRef(int n) Get the child assoc ref for a particular row.
List<ChildAssociationRef>	getChildAssocRefs() Get a list of all the child associations in the results set.
Map<String,Integer>	getFacetQueries() Gets the facet query results
List<Pair<String,Integer>>	getFieldFacet(String field)
NodeRef	getNodeRef(int n) Get the id of the node at the given index (if there is only one selector or no selector)
List<NodeRef>	getNodeRefs() Get a list of all the node refs in the result set (if there is only one selector or no selector)
long	getNumberFound() Attempt to get the number of rows that matched the query.
MD	getResultSetMetaData() Get the meta data for the results set.
ROW	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)
org.alfresco.service.cmr.search.SpellCheckResult	getSpellCheckResult() Gets the spell check result
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.
boolean	hasMore() Was this result set curtailed - are there more pages to the result set?
int	length() Get the number of rows in this result set.
boolean	setBulkFetch(boolean bulkFetch) Bulk fetch results in the cache
int	setBulkFetchSize(int bulkFetchSize) Set the bulk fetch size

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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.

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.

long getNumberFound()

Attempt to get the number of rows that matched the query. This result set may only contain a section of the results. If a skip count is given the number found may or may not include the items skipped. This is best effort and only done if is cheap. For SOLR it is cheap; for the DB it may be expensive as permissions are done post query. If you want to know if there are more results to fetch use hasMore()

NodeRef getNodeRef(int n)

Get the id of the node at the given index (if there is only one selector or no selector)

n - zero-based index

return the the node ref for the row if there is only one selector

float getScore(int n)

Get the score for the node at the given position (if there is only one selector or no selector)

n - zero-based index

return the score for the row if there is only one selector

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.

Get a row from the result set by row index, starting at 0.

i - zero-based index

List<NodeRef> getNodeRefs()

Get a list of all the node refs in the result set (if there is only one selector or no selector)

the node refs if there is only one selector or no selector *

List<ChildAssociationRef> getChildAssocRefs()

Get a list of all the child associations in the results set. (if there is only one selectoror no selector)

the child assoc refs if there is only one selector or no selector *

ChildAssociationRef getChildAssocRef(int n)

Get the child assoc ref for a particular row. (if there is only one selectoror no selector)

n - zero-based index

the child assoc ref for the row if there is only one selector or no selector

getResultSetMetaData

MD getResultSetMetaData()

Get the meta data for the results set.

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.

the position of the first result in the overall result set

Was this result set curtailed - are there more pages to the result set?

true if there are more pages in the result set

boolean setBulkFetch(boolean bulkFetch)

Bulk fetch results in the cache

boolean getBulkFetch()

int setBulkFetchSize(int bulkFetchSize)

Set the bulk fetch size

int getBulkFetchSize()

Get the bulk fetch size.

List<Pair<String,Integer>> getFieldFacet(String field)

Map<String,Integer> getFacetQueries()

Gets the facet query results

Map of <requested facet query, count>

org.alfresco.service.cmr.search.SpellCheckResult getSpellCheckResult()

Gets the spell check result

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.