jreceiver.common.rec.util
Class TuneQueryRec

java.lang.Object
  |
  +--jreceiver.common.rec.BaseRec
        |
        +--jreceiver.common.rec.util.TuneQueryRec

All Implemented Interfaces:

Hashable, TuneQuery

public final class TuneQueryRec

extends BaseRec

implements TuneQuery

A basic interface to filter tunes.

It's purpose is to provide abstraction from the database implementation.

The items specified are ANDed together.

Version:

$Revision: 1.5 $ $Date: 2003/05/10 12:57:41 $

Author:

Reed Esau

Fields inherited from interface jreceiver.common.rec.util.TuneQuery

IS_REG_EXP

Constructor Summary

TuneQueryRec()

TuneQueryRec(java.util.Hashtable hash)
ctor - construct from a hashtable, usually retrieved via XML-RPC

Method Summary

void	addPlaylistKey(int pl_src_id)
void	addPlaylistKeys(java.util.Iterator it)
void	addTuneKey(int tune_src_id)
void	addTuneKeys(java.util.Iterator it)
void	clearPlaylistKeys()
void	clearTuneKeys()
java.lang.String	getAlbumName()
java.lang.String	getArtistName()
java.lang.String	getGenreName()
boolean	getIsAlbumNameRE()
boolean	getIsArtistNameRE()
boolean	getIsGenreNameRE()
boolean	getIsTitleRE()
java.lang.String	getOrderBy()
java.util.Vector	getPlaylistKeys()
java.lang.String	getTitle()
java.util.Vector	getTuneKeys()
static java.util.Vector	reconstitute(java.util.Vector vector) Reconstitute each TuneQueryRec object that appears as a hash in the list.
boolean	removePlaylistKey(int pl_src_id)
boolean	removeTuneKey(int tune_src_id)
void	setAlbumName(java.lang.String album_name)
void	setAlbumName(java.lang.String album_name, boolean is_regular_expression)
void	setArtistName(java.lang.String artist_name)
void	setArtistName(java.lang.String artist_name, boolean is_regular_expression)
void	setGenreName(java.lang.String genre_name)
void	setGenreName(java.lang.String genre_name, boolean is_regular_expression)
void	setOrderBy(java.lang.String order_by)
void	setTitle(java.lang.String title)
void	setTitle(java.lang.String title, boolean is_regular_expression)
java.util.Hashtable	toHash() Store the object as a hash suitable for transport over an XML-RPC connection or similar.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class jreceiver.common.rec.BaseRec

dissolve, dissolveMap, find, find, find, find

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TuneQueryRec

public TuneQueryRec()

TuneQueryRec

public TuneQueryRec(java.util.Hashtable hash)

ctor - construct from a hashtable, usually retrieved via XML-RPC

Method Detail

getArtistName

public java.lang.String getArtistName()

Specified by:

getArtistName in interface TuneQuery

setArtistName

public void setArtistName(java.lang.String artist_name,
                          boolean is_regular_expression)

Specified by:

setArtistName in interface TuneQuery

setArtistName

public void setArtistName(java.lang.String artist_name)

Specified by:

setArtistName in interface TuneQuery

getIsArtistNameRE

public boolean getIsArtistNameRE()

Specified by:

getIsArtistNameRE in interface TuneQuery

getAlbumName

public java.lang.String getAlbumName()

Specified by:

getAlbumName in interface TuneQuery

setAlbumName

public void setAlbumName(java.lang.String album_name,
                         boolean is_regular_expression)

Specified by:

setAlbumName in interface TuneQuery

setAlbumName

public void setAlbumName(java.lang.String album_name)

Specified by:

setAlbumName in interface TuneQuery

getIsAlbumNameRE

public boolean getIsAlbumNameRE()

Specified by:

getIsAlbumNameRE in interface TuneQuery

getGenreName

public java.lang.String getGenreName()

Specified by:

getGenreName in interface TuneQuery

setGenreName

public void setGenreName(java.lang.String genre_name,
                         boolean is_regular_expression)

Specified by:

setGenreName in interface TuneQuery

setGenreName

public void setGenreName(java.lang.String genre_name)

Specified by:

setGenreName in interface TuneQuery

getIsGenreNameRE

public boolean getIsGenreNameRE()

Specified by:

getIsGenreNameRE in interface TuneQuery

getTitle

public java.lang.String getTitle()

Specified by:

getTitle in interface TuneQuery

setTitle

public void setTitle(java.lang.String title,
                     boolean is_regular_expression)

Specified by:

setTitle in interface TuneQuery

setTitle

public void setTitle(java.lang.String title)

Specified by:

setTitle in interface TuneQuery

getIsTitleRE

public boolean getIsTitleRE()

Specified by:

getIsTitleRE in interface TuneQuery

getTuneKeys

public java.util.Vector getTuneKeys()

Specified by:

getTuneKeys in interface TuneQuery

addTuneKeys

public void addTuneKeys(java.util.Iterator it)

Specified by:

addTuneKeys in interface TuneQuery

addTuneKey

public void addTuneKey(int tune_src_id)

Specified by:

addTuneKey in interface TuneQuery

removeTuneKey

public boolean removeTuneKey(int tune_src_id)

Specified by:

removeTuneKey in interface TuneQuery

clearTuneKeys

public void clearTuneKeys()

Specified by:

clearTuneKeys in interface TuneQuery

getPlaylistKeys

public java.util.Vector getPlaylistKeys()

Specified by:

getPlaylistKeys in interface TuneQuery

addPlaylistKeys

public void addPlaylistKeys(java.util.Iterator it)

Specified by:

addPlaylistKeys in interface TuneQuery

addPlaylistKey

public void addPlaylistKey(int pl_src_id)

Specified by:

addPlaylistKey in interface TuneQuery

removePlaylistKey

public boolean removePlaylistKey(int pl_src_id)

Specified by:

removePlaylistKey in interface TuneQuery

clearPlaylistKeys

public void clearPlaylistKeys()

Specified by:

clearPlaylistKeys in interface TuneQuery

getOrderBy

public java.lang.String getOrderBy()

Specified by:

getOrderBy in interface TuneQuery

setOrderBy

public void setOrderBy(java.lang.String order_by)

Specified by:

setOrderBy in interface TuneQuery

toString

public java.lang.String toString()

Returns a string representation of the object.

Specified by:

toString in interface Hashable

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.

toHash

public java.util.Hashtable toHash()

Store the object as a hash suitable for transport over an XML-RPC connection or similar.

Use TuneQueryRec(Hashtable) to transform the data back into an object of this type.

Specified by:

toHash in interface Hashable

Following copied from interface: jreceiver.common.rec.Hashable

Returns:

reconstitute

public static java.util.Vector reconstitute(java.util.Vector vector)

Reconstitute each TuneQueryRec object that appears as a hash in the list.