net.sf.mmm.util.search.api

Interface SearchQuery<HIT>

Type Parameters:

HIT - is the generic type of the result of this query. Typically one of your entities but may also be a transfer object (in case of constructor-query).

public interface SearchQuery<HIT>

This interface represents a search query that is supposed to be created from particular SearchCriteria.
ATTENTION:
This is a stateful object and therefore NOT thread-safe. Further, each of the methods will cause an (expensive) query to be performed.
EXAMPLE:

 public interface MyEntityDao extends GenericDao<Long, MyEntity> {

   SearchQuery<MyEntity> findByCriteria(MySearchCriteria criteria);

 }
 

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
long	count() This method performs a count query to determine the total number of hits (e.g.
SearchResult<HIT>	search() This method performs the actual search to get the SearchResult.

Method Detail

count

long count()

This method performs a count query to determine the total number of hits (e.g. in SQL something like "SELECT count(*) FROM ..."). This is a relatively expensive operation.

Returns:

the total number of hits for this query in the database.

search

SearchResult<HIT> search()

This method performs the actual search to get the SearchResult. To prevent performance problems the SearchResult may be limited according to the maximum hit count as well as by a timeout.

Returns:

the result containing the hits for the query.