Package com.tagtraum.beatunes.library

Class MatchListInfo

java.lang.Object

com.tagtraum.beatunes.library.MatchListInfo

All Implemented Interfaces:

SpecialPlayListInfo

@Entity
public class MatchListInfo
extends Object
implements SpecialPlayListInfo

Describes parameters necessary to create a match list. New instances can be persisted via MediaLibrary.store(MatchListInfo). Existing instances may be obtained via PlayList.getSpecialPlayListInfo().

Author:

Hendrik Schreiber

See Also:

PlayList.getSpecialPlayListInfo(), MediaLibrary.store(MatchListInfo)

Constructor Summary

Constructors

Constructor	Description
MatchListInfo()

Method Summary

Modifier and Type	Method	Description
long	getId()	This object's persistent id.
List<LimitSongFilter>	getLimitSongFilters()	Limit song filters.
List<SongFilter>	getMatchListFilters()	Filters to apply after matching songs are found.
Long	getMatchRuleSetId()	Id for the match rule set to use.
List<Long>	getSeedSongIds()	Ids for the AudioSongs that should be used as seeds for a match list.
Long	getSourcePlayListId()	The id of the PlayList that songs for a match list based on this object should be taken from.
Float	getSyncBPM()	Returns the BPM value at which all songs in this match list should be played.
Long	getTargetPlayListId()	The id of the PlayList created based on this info.
float	getThreshold()	Matching threshold.
boolean	isAddSeeds()	Should the seed songs be added to a resulting match list?
boolean	isAllowDuplicateTitles()	Allow multiple songs with the same (normalized) title.
boolean	isMatchAnyFilter()	Indicates how to apply the filters.
void	setAddSeeds(boolean addSeeds)
void	setAllowDuplicateTitles(boolean allowDuplicateTitles)	Allow multiple songs with the same (normalized) title.
void	setLimitSongFilters(List<LimitSongFilter> limitSongFilters)
void	setMatchAnyFilter(boolean matchAnyFilter)	Sets the filter mode.
void	setMatchListFilters(List<SongFilter> matchListFilters)	Sets the filters to use.
void	setMatchRuleSetId(Long matchRuleSetId)
void	setSeedSongIds(List<Long> seedSongIds)	Sets seed song ids.
void	setSourcePlayListId(Long sourcePlayListId)
void	setSyncBPM(Float syncBPM)	Sets the BPM value at which all songs in this match list should be played.
void	setTargetPlayListId(Long targetPlayListId)
void	setThreshold(float threshold)

Methods inherited from class java.lang.Object

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

Constructor Detail

MatchListInfo

public MatchListInfo()

Method Detail

getId

public long getId()

This object's persistent id.

Specified by:

getId in interface SpecialPlayListInfo

Returns:

id

getTargetPlayListId

public Long getTargetPlayListId()

The id of the PlayList created based on this info. May change.

Returns:

target id

setTargetPlayListId

public void setTargetPlayListId(Long targetPlayListId)

Parameters:

targetPlayListId - target playlist id

See Also:

getTargetPlayListId()

getSourcePlayListId

public Long getSourcePlayListId()

The id of the PlayList that songs for a match list based on this object should be taken from.

Returns:

source playlist id

setSourcePlayListId

public void setSourcePlayListId(Long sourcePlayListId)

Parameters:

sourcePlayListId - source play list id

See Also:

getSourcePlayListId()

getThreshold

public float getThreshold()

Matching threshold.

Returns:

matching threshold

setThreshold

public void setThreshold(float threshold)

Parameters:

threshold - matching threshold

See Also:

getThreshold()

getSeedSongIds

public List<Long> getSeedSongIds()

Ids for the AudioSongs that should be used as seeds for a match list.

Returns:

list of ids, never null

setSeedSongIds

public void setSeedSongIds(List<Long> seedSongIds)

Sets seed song ids.

Parameters:

seedSongIds - seed song ids

See Also:

getSeedSongIds()

getLimitSongFilters

public List<LimitSongFilter> getLimitSongFilters()

Limit song filters.

Returns:

limit song filters

setLimitSongFilters

public void setLimitSongFilters(List<LimitSongFilter> limitSongFilters)

Parameters:

limitSongFilters - limit song filters

See Also:

getLimitSongFilters()

isAddSeeds

public boolean isAddSeeds()

Should the seed songs be added to a resulting match list?

Returns:

true or false

setAddSeeds

public void setAddSeeds(boolean addSeeds)

Parameters:

addSeeds - true or false

See Also:

isAddSeeds()

isAllowDuplicateTitles

public boolean isAllowDuplicateTitles()

Allow multiple songs with the same (normalized) title.

Returns:

true or false

setAllowDuplicateTitles

public void setAllowDuplicateTitles(boolean allowDuplicateTitles)

Allow multiple songs with the same (normalized) title.

Parameters:

allowDuplicateTitles - true or false

getMatchRuleSetId

public Long getMatchRuleSetId()

Id for the match rule set to use.

Returns:

match rule set id

setMatchRuleSetId

public void setMatchRuleSetId(Long matchRuleSetId)

Parameters:

matchRuleSetId - match rule set id

See Also:

getMatchRuleSetId()

setMatchListFilters

public void setMatchListFilters(List<SongFilter> matchListFilters)

Sets the filters to use.

Parameters:

matchListFilters - match list filters

getMatchListFilters

public List<SongFilter> getMatchListFilters()

Filters to apply after matching songs are found.

Returns:

match list filters

isMatchAnyFilter

public boolean isMatchAnyFilter()

Indicates how to apply the filters.

Returns:

true or false

setMatchAnyFilter

public void setMatchAnyFilter(boolean matchAnyFilter)

Sets the filter mode.

Parameters:

matchAnyFilter - true or false

getSyncBPM

public Float getSyncBPM()

Returns the BPM value at which all songs in this match list should be played.

Returns:

bpm value or null

setSyncBPM

public void setSyncBPM(Float syncBPM)

Sets the BPM value at which all songs in this match list should be played.

Parameters:

syncBPM - sync BPM

See Also:

SyncTempoAware