ccc.plugins.search
Interface Index

All Known Subinterfaces:

SimpleLucene

All Known Implementing Classes:

SimpleLuceneFS

public interface Index

API for querying a search index.

Author:

Civic Computing Ltd.

Method Summary

SearchResult	find(java.lang.String searchTerms, int resultCount, int page) Find the results that match the specified search terms.
SearchResult	find(java.lang.String searchTerms, java.lang.String sort, SortOrder order, int resultCount, int page) Find the results that match the specified search terms.
SearchResult	similar(java.lang.String uuid, int nofOfResultsPerPage, int pageNo) Find the results that are similar to the specified page.

Method Detail

find

SearchResult find(java.lang.String searchTerms,
                  int resultCount,
                  int page)

Find the results that match the specified search terms.

Parameters:

searchTerms - The terms to match.

resultCount - The number of results to return.

page - The page of results to return (first page has index of 0).

Returns:

The SearchResult object with set entities and total count.

find

SearchResult find(java.lang.String searchTerms,
                  java.lang.String sort,
                  SortOrder order,
                  int resultCount,
                  int page)

Find the results that match the specified search terms.

Parameters:

searchTerms - The terms to match.

sort - The field to sort on.

order - The order of the sort.

resultCount - The number of results to return.

page - The page of results to return (first page has index of 0).

Returns:

The SearchResult object with set entities and total count.

similar

SearchResult similar(java.lang.String uuid,
                     int nofOfResultsPerPage,
                     int pageNo)

Find the results that are similar to the specified page.

Parameters:

uuid - The UUID of the page to compare.

nofOfResultsPerPage - The number of results to return.

pageNo - The page of results to return (first page has index of 0).

Returns:

The SearchResult object with set entities and total count.