Package edu.cornell.mannlib.vitro.webapp.searchengine

Class InstrumentedSearchEngineWrapper

java.lang.Object

edu.cornell.mannlib.vitro.webapp.searchengine.InstrumentedSearchEngineWrapper

All Implemented Interfaces:

Application.Component, Application.Module, SearchEngine

public class InstrumentedSearchEngineWrapper
extends Object
implements SearchEngine

Manages the life-cycle of the SearchEngine. Adds logging, controlled by DeveloperSettings.

Nested Class Summary

Nested classes/interfaces inherited from interface edu.cornell.mannlib.vitro.webapp.modules.Application.Component

Application.Component.LifecycleState

Constructor Summary

Constructors

Constructor	Description
InstrumentedSearchEngineWrapper()

Method Summary

Modifier and Type	Method	Description
void	add(SearchInputDocument... docs)	Add documents to the search index.
void	add(Collection<SearchInputDocument> docs)	Add documents to the search index.
void	commit()	Explicitly commit all pending changes, and wait until they are visible to the search.
void	commit(boolean wait)	Explicitly commit all pending changes, and optionally wait until they are visible to the search.
SearchInputDocument	createInputDocument()	Create a SearchInputDocument that can be populated and added to the index.
SearchQuery	createQuery()	Create a SearchQuery that can be populated and used for searching.
SearchQuery	createQuery(String queryText)	Convenience method to create a SearchQuery and set the query text in one step.
void	deleteById(String... ids)	Delete documents from the search index, by unique ID.
void	deleteById(Collection<String> ids)	Delete documents from the search index, by unique ID.
void	deleteByQuery(String query)	Delete documents from the search index if they satisfy the query.
int	documentCount()	Find the number of documents in the search index.
void	ping()	Check to see whether the SearchEngine is alive.
SearchResponse	query(SearchQuery query)	Query the search index and return the results.
void	setInnerEngine(SearchEngine inner)
void	shutdown(Application application)	If ACTIVE, do shutdown.
void	startup(Application application, ComponentStartupStatus css)	If NEW, do startup.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InstrumentedSearchEngineWrapper

public InstrumentedSearchEngineWrapper()

Method Detail

setInnerEngine

public void setInnerEngine(SearchEngine inner)

startup

public void startup(Application application,
                    ComponentStartupStatus css)

If NEW, do startup. If STOPPED, throw an exception. If ACTIVE, just complain.

Specified by:

startup in interface Application.Component

shutdown

public void shutdown(Application application)

If ACTIVE, do shutdown. Otherwise, complain and do nothing.

Specified by:

shutdown in interface Application.Component

ping

public void ping()
          throws SearchEngineException

Description copied from interface: SearchEngine

Check to see whether the SearchEngine is alive.

Specified by:

ping in interface SearchEngine

Throws:

SearchEngineException - if the SearchEngine does not respond.

createInputDocument

public SearchInputDocument createInputDocument()

Description copied from interface: SearchEngine

Create a SearchInputDocument that can be populated and added to the index.

Specified by:

createInputDocument in interface SearchEngine

add

public void add(SearchInputDocument... docs)
         throws SearchEngineException

Description copied from interface: SearchEngine

Add documents to the search index.

Specified by:

add in interface SearchEngine

Throws:

SearchEngineException

add

public void add(Collection<SearchInputDocument> docs)
         throws SearchEngineException

Description copied from interface: SearchEngine

Add documents to the search index.

Specified by:

add in interface SearchEngine

Throws:

SearchEngineException

commit

public void commit()
            throws SearchEngineException

Description copied from interface: SearchEngine

Explicitly commit all pending changes, and wait until they are visible to the search.

Specified by:

commit in interface SearchEngine

Throws:

SearchEngineException

commit

public void commit(boolean wait)
            throws SearchEngineException

Description copied from interface: SearchEngine

Explicitly commit all pending changes, and optionally wait until they are visible to the search.

Specified by:

commit in interface SearchEngine

Throws:

SearchEngineException

deleteById

public void deleteById(String... ids)
                throws SearchEngineException

Description copied from interface: SearchEngine

Delete documents from the search index, by unique ID.

Specified by:

deleteById in interface SearchEngine

Throws:

SearchEngineException

deleteById

public void deleteById(Collection<String> ids)
                throws SearchEngineException

Description copied from interface: SearchEngine

Delete documents from the search index, by unique ID.

Specified by:

deleteById in interface SearchEngine

Throws:

SearchEngineException

deleteByQuery

public void deleteByQuery(String query)
                   throws SearchEngineException

Description copied from interface: SearchEngine

Delete documents from the search index if they satisfy the query.

Specified by:

deleteByQuery in interface SearchEngine

Throws:

SearchEngineException

createQuery

public SearchQuery createQuery()

Description copied from interface: SearchEngine

Create a SearchQuery that can be populated and used for searching.

Specified by:

createQuery in interface SearchEngine

createQuery

public SearchQuery createQuery(String queryText)

Description copied from interface: SearchEngine

Convenience method to create a SearchQuery and set the query text in one step.

Specified by:

createQuery in interface SearchEngine

query

public SearchResponse query(SearchQuery query)
                     throws SearchEngineException

Description copied from interface: SearchEngine

Query the search index and return the results. Response is never null.

Specified by:

query in interface SearchEngine

Throws:

SearchEngineException

documentCount

public int documentCount()
                  throws SearchEngineException

Description copied from interface: SearchEngine

Find the number of documents in the search index.

Specified by:

documentCount in interface SearchEngine

Throws:

SearchEngineException