net.sourceforge.atunes.kernel.handlers
Class SearchHandler

java.lang.Object
  extended by net.sourceforge.atunes.kernel.handlers.SearchHandler

public class SearchHandler
extends java.lang.Object

The Class SearchHandler.


Nested Class Summary
static class SearchHandler.LogicalOperator
          Logical operators used to create complex rules.
 
Field Summary
static java.lang.String DEFAULT_INDEX
          Default lucene field.
 
Method Summary
static SearchHandler getInstance()
          Returns SearchHandler unique instance.
 void registerSearchableObject(SearchableObject so)
          Method to register a searchable object.
 java.util.List<SearchResult> search(SearchableObject searchableObject, java.lang.String queryStr)
          Evaluates a search query and returns a result list of audio objects and scores (0 <= score <= 1).
 void startSearch()
          Starts a search by showing search dialog.
 void unregisterSearchableObject(SearchableObject so)
          Method to unregister a searchable object.
 void updateSearchIndex(SearchableObject searchableObject)
          Generic method to update any searchable object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_INDEX

public static final java.lang.String DEFAULT_INDEX
Default lucene field.

See Also:
Constant Field Values
Method Detail

registerSearchableObject

public void registerSearchableObject(SearchableObject so)
Method to register a searchable object. All searchable objects must call this method to initialize searches

Parameters:
so - the so

unregisterSearchableObject

public void unregisterSearchableObject(SearchableObject so)
Method to unregister a searchable object. After this method is called, searchable object is not searchable, and must be registered again

Parameters:
so -

getInstance

public static SearchHandler getInstance()
Returns SearchHandler unique instance.

Returns:
the instance

startSearch

public void startSearch()
Starts a search by showing search dialog.


search

public java.util.List<SearchResult> search(SearchableObject searchableObject,
                                           java.lang.String queryStr)
                                    throws SearchIndexNotAvailableException,
                                           SearchQuerySyntaxException
Evaluates a search query and returns a result list of audio objects and scores (0 <= score <= 1).

Parameters:
queryStr - The search query
searchableObject - the searchable object
Returns:
The search result
Throws:
SearchIndexNotAvailableException - If no search index was found
SearchQuerySyntaxException - If the search query has invalid syntax

updateSearchIndex

public void updateSearchIndex(SearchableObject searchableObject)
Generic method to update any searchable object.

Parameters:
searchableObject - the searchable object


Copyright © 2006-2008 The aTunes Team. All Rights Reserved.