org.cyclos.impl.search

Interface SearchHandler

All Superinterfaces:

org.cyclos.impl.ApplicationInitializationListener, org.cyclos.impl.CustomBean

public interface SearchHandler
extends org.cyclos.impl.CustomBean, org.cyclos.impl.ApplicationInitializationListener

Handler used to perform [full-text / geo-distance] searches, as well as eventually handling indexing on entities. The entities that can be searched are: users, contacts, advertisements and records.

Author:

luis

Field Summary

Fields inherited from interface org.cyclos.impl.ApplicationInitializationListener

MAX_PRIORITY, MIN_PRIORITY, NORMAL_PRIORITY

Method Summary

Modifier and Type	Method and Description
AdSearchHandler	ad() Returns the handler for searching advertisements
ContactSearchHandler	contact() Returns the handler for searching contacts
boolean	isPhraseSearchSupported() Returns whether phrase searches are supported within full-text queries
boolean	isTranslationSupported() Returns whether translated values are supported
java.util.List<java.lang.String>	performIndex(java.lang.String index, java.util.List<java.lang.Long> ids) Updates the given index for the entity with the given identifiers.
RecordSearchHandler	record() Returns the handler for searching records
long	reindex() Reindexes all data.
UserSearchHandler	user() Returns the handler for searching users

Methods inherited from interface org.cyclos.impl.ApplicationInitializationListener

applicationInitializationPriority, onApplicationInitialization

Method Detail

ad

AdSearchHandler ad()

Returns the handler for searching advertisements

contact

ContactSearchHandler contact()

Returns the handler for searching contacts

isPhraseSearchSupported

boolean isPhraseSearchSupported()

Returns whether phrase searches are supported within full-text queries

isTranslationSupported

boolean isTranslationSupported()

Returns whether translated values are supported

performIndex

java.util.List<java.lang.String> performIndex(java.lang.String index,
                                              java.util.List<java.lang.Long> ids)

Updates the given index for the entity with the given identifiers.

Returns:

Either null, indicating a no-op, or a list with the same size as the input ids, containing the error message for each id, or null if it succeeded.

record

RecordSearchHandler record()

Returns the handler for searching records

reindex

long reindex()

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

user

UserSearchHandler user()

Returns the handler for searching users