ccc.api.core
Interface SearchEngine

All Superinterfaces:
Scheduler
All Known Implementing Classes:
SearchEngineEJB, SearchImpl

public interface SearchEngine
extends Scheduler

The search API.

Author:
Civic Computing Ltd.

Field Summary
static java.lang.String NAME
          NAME : String.
 
Method Summary
 SearchResult find(java.lang.String searchTerms, int noOfResultsPerPage, int page)
          Find the entities 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.
 void index()
          Rebuild the search index.
 SearchResult similar(java.lang.String uuid, int noOfResultsPerPage, int page)
          Find the results that are similar to the specified page.
 
Methods inherited from interface ccc.api.core.Scheduler
isRunning, start, stop
 

Field Detail

NAME

static final java.lang.String NAME
NAME : String.

See Also:
Constant Field Values
Method Detail

find

SearchResult find(java.lang.String searchTerms,
                  int noOfResultsPerPage,
                  int page)
Find the entities that match the specified search terms.

Parameters:
searchTerms - The terms to match.
noOfResultsPerPage - 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 noOfResultsPerPage,
                     int page)
Find the results that are similar to the specified page.

Parameters:
uuid - The page to match.
noOfResultsPerPage - 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.

index

void index()
Rebuild the search index.



Copyright © 2010. All Rights Reserved.