org.musicontroller.core.searching
Interface ISearcher

All Known Implementing Classes:

MCSearcher

public interface ISearcher

Specifies all methods for a Searcher. This interface is a high-leven specification of a service that can do a full-index-search in a DB/index/whatever.

Author:

Varienaja

Method Summary

java.util.List<Item>

searchGeneral(java.lang.String username, java.lang.String toSearch) Searches an Index for Items.

Method Detail

searchGeneral

java.util.List<Item> searchGeneral(java.lang.String username,
                                   java.lang.String toSearch)
                                   throws java.io.IOException,
                                          org.apache.lucene.queryParser.ParseException

Searches an Index for Items.

Parameters:

username - The username. Use this to obtain user-specific search results. This parameter may be null.

toSearch - The search-string.

Returns:

A list ith 0 or more Items, ordered by relevance (most relevant on top).

Throws:

java.io.IOException - If the index could not be consulted.

org.apache.lucene.queryParser.ParseException - If the search-string could not be parsed.