net.sourceforge.atunes.kernel.modules.search.searchableobjects
Class CommonAudioFileSearchableObject

java.lang.Object
  extended by net.sourceforge.atunes.kernel.modules.search.searchableobjects.CommonAudioFileSearchableObject
All Implemented Interfaces:
SearchableObject
Direct Known Subclasses:
DeviceSearchableObject, FavoritesSearchableObject, RepositorySearchableObject

public abstract class CommonAudioFileSearchableObject
extends java.lang.Object
implements SearchableObject

This class represents common methods for all searchable objects that contain AudioFiles

Author:
fleax

Field Summary
protected static java.lang.String INDEX_FIELD_ALBUM
          The Constant INDEX_FIELD_ALBUM.
protected static java.lang.String INDEX_FIELD_ALBUM_ARTIST
          The Constant INDEX_FIELD_ALBUM_ARTIST.
protected static java.lang.String INDEX_FIELD_ARTIST
          The Constant INDEX_FIELD_ARTIST.
protected static java.lang.String INDEX_FIELD_BITRATE
          The Constant INDEX_FIELD_BITRATE.
protected static java.lang.String INDEX_FIELD_COMPOSER
          The Constant INDEX_FIELD_COMPOSER.
protected static java.lang.String INDEX_FIELD_DURATION
          The Constant INDEX_FIELD_DURATION.
protected static java.lang.String INDEX_FIELD_FILENAME
          The Constant INDEX_FIELD_FILENAME.
protected static java.lang.String INDEX_FIELD_FREQUENCY
          The Constant INDEX_FIELD_FREQUENCY.
protected static java.lang.String INDEX_FIELD_GENRE
          The Constant INDEX_FIELD_GENRE.
protected static java.lang.String INDEX_FIELD_LYRICS
          The Constant INDEX_FIELD_LYRICS.
protected static java.lang.String INDEX_FIELD_SCORE
          The Constant INDEX_FIELD_STARS.
protected static java.lang.String INDEX_FIELD_TITLE
          The Constant INDEX_FIELD_TITLE.
protected static java.lang.String INDEX_FIELD_TRACK_NUMBER
          The Constant INDEX_FIELD_NUMBER.
protected static java.lang.String INDEX_FIELD_URL
          The Constant INDEX_FIELD_URL.
protected static java.lang.String INDEX_FIELD_YEAR
          The Constant INDEX_FIELD_YEAR.
 
Constructor Summary
CommonAudioFileSearchableObject()
           
 
Method Summary
 Document getDocumentForElement(AudioObject audioObject)
          Builds a Lucene Document for a given AudioObject.
 java.util.List<java.lang.String> getSearchableAttributes()
          Returns a list of attributes that can be used in queries.
 SearchResultTableModel getSearchResultsTableModel(java.util.List<SearchResult> results)
          Returns a table model to show search results.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface net.sourceforge.atunes.kernel.modules.search.SearchableObject
getElementsToIndex, getPathToIndex, getSearchableObjectName, getSearchResult
 

Field Detail

INDEX_FIELD_TITLE

protected static final java.lang.String INDEX_FIELD_TITLE
The Constant INDEX_FIELD_TITLE.

See Also:
Constant Field Values

INDEX_FIELD_TRACK_NUMBER

protected static final java.lang.String INDEX_FIELD_TRACK_NUMBER
The Constant INDEX_FIELD_NUMBER.

See Also:
Constant Field Values

INDEX_FIELD_ARTIST

protected static final java.lang.String INDEX_FIELD_ARTIST
The Constant INDEX_FIELD_ARTIST.

See Also:
Constant Field Values

INDEX_FIELD_ALBUM_ARTIST

protected static final java.lang.String INDEX_FIELD_ALBUM_ARTIST
The Constant INDEX_FIELD_ALBUM_ARTIST.

See Also:
Constant Field Values

INDEX_FIELD_ALBUM

protected static final java.lang.String INDEX_FIELD_ALBUM
The Constant INDEX_FIELD_ALBUM.

See Also:
Constant Field Values

INDEX_FIELD_COMPOSER

protected static final java.lang.String INDEX_FIELD_COMPOSER
The Constant INDEX_FIELD_COMPOSER.

See Also:
Constant Field Values

INDEX_FIELD_YEAR

protected static final java.lang.String INDEX_FIELD_YEAR
The Constant INDEX_FIELD_YEAR.

See Also:
Constant Field Values

INDEX_FIELD_GENRE

protected static final java.lang.String INDEX_FIELD_GENRE
The Constant INDEX_FIELD_GENRE.

See Also:
Constant Field Values

INDEX_FIELD_DURATION

protected static final java.lang.String INDEX_FIELD_DURATION
The Constant INDEX_FIELD_DURATION.

See Also:
Constant Field Values

INDEX_FIELD_BITRATE

protected static final java.lang.String INDEX_FIELD_BITRATE
The Constant INDEX_FIELD_BITRATE.

See Also:
Constant Field Values

INDEX_FIELD_FREQUENCY

protected static final java.lang.String INDEX_FIELD_FREQUENCY
The Constant INDEX_FIELD_FREQUENCY.

See Also:
Constant Field Values

INDEX_FIELD_SCORE

protected static final java.lang.String INDEX_FIELD_SCORE
The Constant INDEX_FIELD_STARS.

See Also:
Constant Field Values

INDEX_FIELD_LYRICS

protected static final java.lang.String INDEX_FIELD_LYRICS
The Constant INDEX_FIELD_LYRICS.

See Also:
Constant Field Values

INDEX_FIELD_FILENAME

protected static final java.lang.String INDEX_FIELD_FILENAME
The Constant INDEX_FIELD_FILENAME.

See Also:
Constant Field Values

INDEX_FIELD_URL

protected static final java.lang.String INDEX_FIELD_URL
The Constant INDEX_FIELD_URL.

See Also:
Constant Field Values
Constructor Detail

CommonAudioFileSearchableObject

public CommonAudioFileSearchableObject()
Method Detail

getSearchableAttributes

public java.util.List<java.lang.String> getSearchableAttributes()
Description copied from interface: SearchableObject
Returns a list of attributes that can be used in queries.

Specified by:
getSearchableAttributes in interface SearchableObject
Returns:
the searchable attributes

getDocumentForElement

public Document getDocumentForElement(AudioObject audioObject)
Description copied from interface: SearchableObject
Builds a Lucene Document for a given AudioObject.

Specified by:
getDocumentForElement in interface SearchableObject
Parameters:
audioObject - the audio object
Returns:
the document for element

getSearchResultsTableModel

public SearchResultTableModel getSearchResultsTableModel(java.util.List<SearchResult> results)
Description copied from interface: SearchableObject
Returns a table model to show search results.

Specified by:
getSearchResultsTableModel in interface SearchableObject
Parameters:
results - the results
Returns:
the search results table model


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