Package org.cyclos.impl.search

Interface SearchHandler

All Superinterfaces:

ApplicationInitializationListener, BaseApplicationInitializationListener, CustomBean

public interface SearchHandler
extends CustomBean, 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.

Field Summary

Fields

Modifier and Type	Field	Description
static int	INDEX_BATCH_SIZE	The maximum number of entities that should be batched to be indexed at once

Fields inherited from interface org.cyclos.impl.BaseApplicationInitializationListener

MAX_PRIORITY, MIN_PRIORITY, NORMAL_PRIORITY

Method Summary

Modifier and Type	Method	Description
AdSearchHandler	ad()	Returns the handler for searching advertisements
ContactSearchHandler	contact()	Returns the handler for searching contacts
InstallmentSearchHandler	installment()	Returns the handler for searching installments
boolean	isPhraseSearchSupported()	Returns whether phrase searches are supported within full-text queries
boolean	isTranslationSupported()	Returns whether translated values are supported
void	performIndex(String index, List<Long> ids)	Updates the given index for the entity with the given identifiers
RecordSearchHandler	record()	Returns the handler for searching records
void	reindex()	Reindexes all data.
long	removeArchived(Instant startedAt)	Removes indexed documents referenced in ArchivedEntityToRemoveFromIndex.
<S extends SearchHandler> S	self()	Returns the own implementation
TransactionSearchHandler	transaction()	Returns the handler for searching transactions
TransferSearchHandler	transfer()	Returns the handler for searching transfers
UserSearchHandler	user()	Returns the handler for searching users

Methods inherited from interface org.cyclos.impl.ApplicationInitializationListener

onApplicationInitialization

Methods inherited from interface org.cyclos.impl.BaseApplicationInitializationListener

applicationInitializationPriority, getInitializationId

Field Detail

INDEX_BATCH_SIZE

static final int INDEX_BATCH_SIZE

The maximum number of entities that should be batched to be indexed at once

See Also:

Constant Field Values

Method Detail

ad

AdSearchHandler ad()

Returns the handler for searching advertisements

contact

ContactSearchHandler contact()

Returns the handler for searching contacts

installment

InstallmentSearchHandler installment()

Returns the handler for searching installments

isPhraseSearchSupported

boolean isPhraseSearchSupported()

Returns whether phrase searches are supported within full-text queries

isTranslationSupported

boolean isTranslationSupported()

Returns whether translated values are supported

performIndex

void performIndex(String index,
                  List<Long> ids)

Updates the given index for the entity with the given identifiers

record

RecordSearchHandler record()

Returns the handler for searching records

reindex

void reindex()

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

removeArchived

long removeArchived(Instant startedAt)
             throws RemoveArchivedEntitiesFromIndexException

Removes indexed documents referenced in ArchivedEntityToRemoveFromIndex. Operates in batches, opening transactions as needed. Between each batch, sleeps for a time specified in CyclosProperties.getArchivingWaitTimeBetweenDeletesMillis(). Considers the given instant as the moment the whole process started. Will work at most for the number of minutes indicated in CyclosProperties.getArchivingDeleteDurationMinutes().

Throws:

RemoveArchivedEntitiesFromIndexException

self

<S extends SearchHandler> S self()

Returns the own implementation

transaction

TransactionSearchHandler transaction()

Returns the handler for searching transactions

transfer

TransferSearchHandler transfer()

Returns the handler for searching transfers

user

UserSearchHandler user()

Returns the handler for searching users