com.atlassian.confluence.search.v2
Interface SearchManager

All Known Implementing Classes:

LuceneSearchManager

public interface SearchManager

Facade for the v2 search API.

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(ISearch search) Perform a search with a given criteria.
SearchResults	search(Search search) Deprecated. since 3.0. Use search(ISearch) by passing in a ContentSearch.
java.util.List<com.atlassian.bonnie.Searchable>	searchEntities(ISearch search) Perform a search with the given criteria, returning the results as a list of database entity objects.
java.util.List<com.atlassian.bonnie.Searchable>	searchEntities(Search search) Deprecated. since 3.0. Use searchEntities(ISearch) instead.

Method Detail

search

SearchResults search(ISearch search)
                     throws InvalidSearchException

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.

Parameters:

search - the search to perform

Returns:

the results of that search

Throws:

java.lang.IllegalArgumentException - if the search contains an invalid SearchQuery

InvalidSearchException - when this manager is unable to translate and conduct the specified search. Clients should just discard the search if this occurs.

search

@Deprecated
SearchResults search(Search search)
                     throws InvalidSearchException

Deprecated. since 3.0. Use search(ISearch) by passing in a ContentSearch.

Throws:

InvalidSearchException

See Also:

Search, ContentSearch

searchEntities

java.util.List<com.atlassian.bonnie.Searchable> searchEntities(ISearch search)
                                                               throws InvalidSearchException

Perform a search with the given criteria, returning the results as a list of database entity objects. Unlike the 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

Parameters:

search - the search to perform

Returns:

a list of Searchable objects representing the search results

Throws:

java.lang.IllegalArgumentException - if the search contains an invalid SearchQuery

InvalidSearchException - when this manager is unable to translate and conduct the specified search. Clients should just discard the search if this occurs.

searchEntities

@Deprecated
java.util.List<com.atlassian.bonnie.Searchable> searchEntities(Search search)
                                                               throws InvalidSearchException

Deprecated. since 3.0. Use searchEntities(ISearch) instead.

Throws:

InvalidSearchException

convertToEntities

java.util.List<com.atlassian.bonnie.Searchable> convertToEntities(SearchResults searchResults,
                                                                  boolean stripNull)

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.

Parameters:

searchResults - the results of a search from this manager

stripNull - 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.