org.cyclos.impl.search

Interface EntitySearchHandler<E extends NetworkedEntity,Q extends QueryParameters,R>

Type Parameters:

E - The entity type

Q - The query parameters type

R - The result type on search, generally a VO

All Known Subinterfaces:

AdSearchHandler, ContactSearchHandler, InstallmentSearchHandler, RecordSearchHandler, RemovableEntitySearchHandler<E,Q,R>, TransactionSearchHandler, TransferSearchHandler, UserSearchHandler

public interface EntitySearchHandler<E extends NetworkedEntity,Q extends QueryParameters,R>

Interface for searching over a specific entity

Author:

luis

Method Summary

Modifier and Type	Method and Description
void	index(E entity) Indexes the given entity
java.lang.String	indexName() Returns the name of the external index, or null if external indexing isn't used
com.mysema.commons.lang.CloseableIterator<E>	iterateEntities(Q query) Iterates entities which match the given query
com.mysema.commons.lang.CloseableIterator<java.lang.Long>	iterateIds(Q query) Iterates ids which match the given query
long	reindex() Reindexes all data.
Page<R>	search(Q query) Performs the search for a page of results

Method Detail

index

void index(E entity)

Indexes the given entity

indexName

java.lang.String indexName()

Returns the name of the external index, or null if external indexing isn't used

iterateEntities

com.mysema.commons.lang.CloseableIterator<E> iterateEntities(Q query)

Iterates entities which match the given query

iterateIds

com.mysema.commons.lang.CloseableIterator<java.lang.Long> iterateIds(Q query)

Iterates ids which match the given query

reindex

long reindex()

Reindexes all data. This is only called by scripts, in case the admin needs to reindex the data.

search

Page<R> search(Q query)

Performs the search for a page of results