Package com.tagtraum.beatunes.matchtable

Class BPMRule

java.lang.Object

com.tagtraum.beatunes.matchtable.ScoreRule

com.tagtraum.beatunes.matchtable.BPMRule

All Implemented Interfaces:

Serializable, Comparable<ScoreRule>

public class BPMRule
extends ScoreRule

BPMRule.

Author:

Hendrik Schreiber

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.tagtraum.beatunes.matchtable.ScoreRule

ScoreRule.BasicScoreRuleEditor, ScoreRule.WeightBoundedRangeModel

Constructor Summary

Constructors

Constructor	Description
BPMRule()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Description of how this rule works.
String	getId()	Returns a unique name for this rule.
SongPropertyFilter	getMatchFilter(AudioSong template, Float templateSyncBPM, boolean playMatchAtSyncTempo)	Returns a filter that matches Songs that match this rule at least somewhat.
String	getName()	Short name, like "Similar BPM"
float	score(AudioSong song, AudioSong template, Float syncBPM, boolean playMatchAtSyncTempo)	Returns a score between 0 and 1 for how well the given song matches the given template.

Methods inherited from class com.tagtraum.beatunes.matchtable.ScoreRule

addPropertyChangeListener, compareTo, createEditor, getApplication, getScoreRuleEditor, getWeight, getWeightedMatchFilter, isIgnoredWhileQuickMatching, isSuitableForSorting, load, setApplication, setWeight, store, weightedScore

Methods inherited from class java.lang.Object

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

Constructor Detail

BPMRule

public BPMRule()

Method Detail

getId

public String getId()

Description copied from class: ScoreRule

Returns a unique name for this rule.

Specified by:

getId in class ScoreRule

Returns:

unique name

getDescription

public String getDescription()

Description copied from class: ScoreRule

Description of how this rule works. May be displayed in tooltips.

Specified by:

getDescription in class ScoreRule

Returns:

description

getName

public String getName()

Description copied from class: ScoreRule

Short name, like "Similar BPM"

Specified by:

getName in class ScoreRule

Returns:

short name

score

public float score(AudioSong song,
                   AudioSong template,
                   Float syncBPM,
                   boolean playMatchAtSyncTempo)

Description copied from class: ScoreRule

Returns a score between 0 and 1 for how well the given song matches the given template. A higher score indicates a better match.

Specified by:

score in class ScoreRule

Parameters:

song - song

template - template

syncBPM - sync bpm

playMatchAtSyncTempo - the given song is meant to be played at the same tempo as the template song

Returns:

score between 0.0 and 1.0 as a measure for how well the song matches the template.

getMatchFilter

public SongPropertyFilter getMatchFilter(AudioSong template,
                                         Float templateSyncBPM,
                                         boolean playMatchAtSyncTempo)

Description copied from class: ScoreRule

Returns a filter that matches Songs that match this rule at least somewhat. This should be used to find songs that at least somewhat match the rule.

Specified by:

getMatchFilter in class ScoreRule

Parameters:

template - template song to match

templateSyncBPM - sync bpm for the template song

playMatchAtSyncTempo - the given song is meant to be played at the same tempo as the template song

Returns:

a filter (set) that matches this rule or null, if all songs match this rule.