Package com.tagtraum.beatunes.analysis

Class AnalyzeKey

java.lang.Object

com.tagtraum.beatunes.analysis.Task

com.tagtraum.beatunes.analysis.AudioAnalysisTask

com.tagtraum.beatunes.analysis.AnalyzeKey

All Implemented Interfaces:

TaskFactory, TaskProcessListener, TaskRunListener, Matchable, Cloneable

@Entity
public class AnalyzeKey
extends AudioAnalysisTask

Analyze key.

Author:

Hendrik Schreiber

Field Summary

Fields inherited from class com.tagtraum.beatunes.analysis.Task

useOnlineResources

Constructor Summary

Constructors

Constructor	Description
AnalyzeKey()

Method Summary

Modifier and Type	Method	Description
AnalyzeKey	createDeepCopy()	This method creates a copy of the Task and its subtasks.
TaskEditor<AnalyzeKey>	createEditor()	By default instantiates a class with the name this.getClass().getName() + "Editor".
SignalProcessor	createPipeline(AudioFileFormat audioFileFormat)
boolean	equals(Object o)
static String	getClassName(KeyTextRenderer renderer)	Ruby and Python object's classnames are not the same after the JVM exists.
String	getDescription()	HTML or plain text description of this task.
com.tagtraum.beatunes.analysis.AnalyzeKey.KeyClassifier	getKeyClassifier()
String	getName()	HTML or plaintext name of this task.
KeyTextRenderer	getRenderer()
String	getRendererClass()
AudioClip	getRequiredClip(AudioFileFormat audioFileFormat)
int	hashCode()
boolean	isCopyToComment()
boolean	isLimitToOneMinute()
boolean	isOverwriteComment()
boolean	isReplaceExistingKey()
void	processBefore(Task task)	Process online results with this task before other tasks are invoked.
void	runBefore(Task task)	Is executed before sub tasks are run.
void	setCopyToComment(boolean overwrite)
void	setKeyClassifier(com.tagtraum.beatunes.analysis.AnalyzeKey.KeyClassifier keyClassifier)
void	setKeyClassifier(String keyClassifier)
void	setLimitToOneMinute(boolean limitToOneMinute)
void	setOverwriteComment(boolean overwrite)
void	setRendererClass(String klass)
void	setReplaceExistingKey(boolean replaceExistingKey)
boolean	skip()	Indicates, whether this task can be skipped.
String	toString()

Methods inherited from class com.tagtraum.beatunes.analysis.AudioAnalysisTask

getAlgorithmName

Methods inherited from class com.tagtraum.beatunes.analysis.Task

add, addTaskProcessListener, addTaskRunListener, cancel, clearProperties, createTask, deepRemove, fetchCollections, getAnalysisProgress, getApplication, getAudioFileFormat, getCurrentOperation, getDeepLeafs, getDeepTaskCount, getDeepTasks, getEditor, getId, getMessagePanel, getParent, getPriority, getProperties, getProperty, getPropertyNames, getReferenceSong, getSong, getSongId, getTask, getTaskCount, getTasks, hasSucceeded, isAvailable, isCancelled, isDeepUseOnlineResources, isFileExistedBeforeStart, isLeaf, isPaused, isProgressRelevant, isUseOnlineResources, matches, maybePause, process, processAfter, processFinally, remove, removeDeadLeaves, run, runAfter, runFinally, setAnalysisProgress, setApplication, setAudioFileFormat, setAvailable, setCurrentOperation, setId, setParent, setPaused, setPriority, setProgressRelevant, setProperties, setProperty, setReferenceSong, setSkipped, setSong, setSongId, setSucceeded, setUseOnlineResources, wasSkipped

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AnalyzeKey

public AnalyzeKey()

Method Detail

getName

public String getName()

Description copied from class: Task

HTML or plaintext name of this task. Defaults to the task's classname.

Overrides:

getName in class Task

Returns:

name

getDescription

public String getDescription()

Description copied from class: Task

HTML or plain text description of this task.

Overrides:

getDescription in class Task

Returns:

description

createPipeline

public SignalProcessor createPipeline(AudioFileFormat audioFileFormat)

Overrides:

createPipeline in class AudioAnalysisTask

setOverwriteComment

public void setOverwriteComment(boolean overwrite)

isOverwriteComment

public boolean isOverwriteComment()

setCopyToComment

public void setCopyToComment(boolean overwrite)

isCopyToComment

public boolean isCopyToComment()

setRendererClass

public void setRendererClass(String klass)

getRendererClass

public String getRendererClass()

getRenderer

public KeyTextRenderer getRenderer()

isLimitToOneMinute

public boolean isLimitToOneMinute()

setLimitToOneMinute

public void setLimitToOneMinute(boolean limitToOneMinute)

getKeyClassifier

public com.tagtraum.beatunes.analysis.AnalyzeKey.KeyClassifier getKeyClassifier()

setKeyClassifier

public void setKeyClassifier(com.tagtraum.beatunes.analysis.AnalyzeKey.KeyClassifier keyClassifier)

setKeyClassifier

public void setKeyClassifier(String keyClassifier)

isReplaceExistingKey

public boolean isReplaceExistingKey()

setReplaceExistingKey

public void setReplaceExistingKey(boolean replaceExistingKey)

getRequiredClip

public AudioClip getRequiredClip(AudioFileFormat audioFileFormat)

Overrides:

getRequiredClip in class AudioAnalysisTask

Parameters:

audioFileFormat - file format of the original, potentially compressed audio file

Returns:

the clip this algorithm actually requires

createEditor

public TaskEditor<AnalyzeKey> createEditor()

Description copied from class: Task

By default instantiates a class with the name this.getClass().getName() + "Editor". If that does not work (because the editor class does not exist), an EmptyTaskEditor is created. To create a meaningful editor for a configurable task, you must override this method.

Overrides:

createEditor in class Task

Returns:

task editor for this task.

processBefore

public void processBefore(Task task)

Description copied from class: Task

Process online results with this task before other tasks are invoked. Override this method, if you want to take online resources into account. Note that you will also need to set Task.setUseOnlineResources(boolean) to true, if you want this method to be called at all.

To avoid having this task processed again by Task.runBefore(Task), you must call Task.setSucceeded(boolean) with the argument true. If, for some reason, you could not take care of this task with just the available online resources, you must call Task.setSucceeded(boolean) with the argument false

This method is executed before sub tasks are run. When this method is called, the methods Task.getSong() and Task.getReferenceSong() will return meaningful results.

Specified by:

processBefore in interface TaskProcessListener

Overrides:

processBefore in class Task

Parameters:

task - task

runBefore

public void runBefore(Task task)
               throws AnalysisException

Description copied from class: Task

Is executed before sub tasks are run.

Specified by:

runBefore in interface TaskRunListener

Overrides:

runBefore in class Task

Parameters:

task - task

Throws:

AnalysisException - if this analysis step fails

skip

public boolean skip()

Description copied from class: Task

Indicates, whether this task can be skipped. Defaults to false.

Since this task is not necessarily called by beaTunes, but by your own implementation of Task.runBefore(Task), you should call Task.setSkipped(boolean) with whatever value you are returning.

Overrides:

skip in class Task

Returns:

true or false

equals

public boolean equals(Object o)

Overrides:

equals in class Task

hashCode

public int hashCode()

Overrides:

hashCode in class Task

createDeepCopy

public AnalyzeKey createDeepCopy()

This method creates a copy of the Task and its subtasks.

Overrides:

createDeepCopy in class Task

Returns:

copy

toString

public String toString()

Overrides:

toString in class Task

getClassName

public static String getClassName(KeyTextRenderer renderer)

Ruby and Python object's classnames are not the same after the JVM exists. Therefore we have to get their type's name, which is persistent.

Parameters:

renderer - renderer

Returns:

classname