com.atlassian.confluence.search.v2.lucene
Class LuceneSearchManager
java.lang.Object
com.atlassian.confluence.search.v2.lucene.LuceneSearchManager
- All Implemented Interfaces:
- SearchManager
public class LuceneSearchManager
- extends java.lang.Object
- implements SearchManager
Field Summary |
static org.apache.log4j.Logger |
log
|
Method Summary |
java.util.List<com.atlassian.bonnie.Searchable> |
convertToEntities(SearchResults searchResults,
boolean stripNull)
Helper method to convert search results into a list of database entities. |
SearchResults |
search(Search search)
Perform a search with a given criteria. |
java.util.List<com.atlassian.bonnie.Searchable> |
searchEntities(Search search)
Perform a search with the given criteria, returning the results as a list of database entity
objects. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
log
public static final org.apache.log4j.Logger log
LuceneSearchManager
public LuceneSearchManager(LuceneSearchMapper luceneSearchMapper,
LuceneSearcher luceneSearcher,
com.atlassian.bonnie.AnyTypeObjectDao anyTypeObjectDao,
com.atlassian.bonnie.analyzer.LuceneAnalyzerFactory luceneAnalyzerFactory)
search
public SearchResults search(Search search)
throws InvalidSearchException
- Description copied from interface:
SearchManager
- Perform a search with a given criteria.
Will throw an InvalidSearchException if some error occurred converting the search object into
a search that could be performed in the back-end. Usually this is a sign that some plugin that was
used to create the search is no longer available.
- Specified by:
search
in interface SearchManager
- Parameters:
search
- the specified search
- Returns:
- search results.
- Throws:
InvalidSearchException
- when this manager is unable to translate and conduct the specified search. Clients should just discard the search if this occurs.
searchEntities
public java.util.List<com.atlassian.bonnie.Searchable> searchEntities(Search search)
throws InvalidSearchException
- Description copied from interface:
SearchManager
- Perform a search with the given criteria, returning the results as a list of database entity
objects. Unlike the
SearchManager.convertToEntities(SearchResults, boolean)
method, the list of entities returned
will not contain any nulls: search results that do not match a database record will be silently
discarded
- Specified by:
searchEntities
in interface SearchManager
- Parameters:
search
- the search to perform
- Returns:
- a list of Searchable objects representing the search results
- Throws:
InvalidSearchException
- when this manager is unable to translate and conduct the specified search. Clients should just discard the search if this occurs.
convertToEntities
public java.util.List<com.atlassian.bonnie.Searchable> convertToEntities(SearchResults searchResults,
boolean stripNull)
- Description copied from interface:
SearchManager
Helper method to convert search results into a list of database entities. The index of the entity
in the returned list will match the index of the search result it corresponds to. Because the
search index does not update at the same time as the database, a search may contain references
to entities that have since been deleted from the db. As such, the returned list may contain
null values.
If you do not want this behaviour then supplied true for the stripNulls parameter.
- Specified by:
convertToEntities
in interface SearchManager
- Parameters:
searchResults
- the results of a search from this managerstripNull
- if true then any nulls resulting from the mapping will be removed from the list meaning that
the list no longer aligns with the supplied searchResults.
- Returns:
- the entities represented by that search result. List may be empty if the search returned no results, or
may contain null values where the result does not map to a valid database record.
Copyright © 2003-2008 Atlassian Pty Ltd. All Rights Reserved.