Package com.tagtraum.beatunes.analysis

Class ImportLyrics

java.lang.Object

com.tagtraum.beatunes.analysis.Task

com.tagtraum.beatunes.analysis.SongAnalysisTask

com.tagtraum.beatunes.analysis.ImportLyrics

All Implemented Interfaces:

TaskFactory, TaskProcessListener, TaskRunListener, Matchable<PlayList.SubstringFilterProperty>, Cloneable

@Entity
public class ImportLyrics
extends SongAnalysisTask

Import lyrics from online databases using implementations of LyricsProvider. To add another provider, simply implement the LyricsProvider interface, pack the implementation into a plugin jar, add the implementing class to the plugin's plugin.xml and install the plugin.

Author:

Hendrik Schreiber

Field Summary

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

useOnlineResources

Constructor Summary

Constructors

Constructor	Description
ImportLyrics()

Method Summary

Modifier and Type	Method	Description
ImportLyrics	createDeepCopy()	This method creates a copy of the Task and its subtasks.
TaskEditor<ImportLyrics>	createEditor()	By default instantiates a class with the name this.getClass().getName() + "Editor".
boolean	equals(Object obj)
String	getDescription()	HTML or plain text description of this task.
String	getName()	HTML or plaintext name of this task.
boolean	isReplaceExistingLyrics()
void	runBefore(Task task)	Is executed before sub tasks are run.
void	setReplaceExistingLyrics(boolean replaceExistingLyrics)
boolean	skip()	Indicates, whether this task can be skipped.

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, hashCode, hasSucceeded, isAvailable, isCancelled, isDeepUseOnlineResources, isFileExistedBeforeStart, isLeaf, isPaused, isProgressRelevant, isUseOnlineResources, matches, maybePause, process, processAfter, processBefore, processFinally, remove, removeDeadLeaves, run, runAfter, runFinally, setAnalysisProgress, setApplication, setAudioFileFormat, setAvailable, setCurrentOperation, setId, setParent, setPaused, setPriority, setProgressRelevant, setProperties, setProperty, setReferenceSong, setSkipped, setSong, setSongId, setSucceeded, setUseOnlineResources, toString, wasSkipped

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportLyrics

public ImportLyrics()

Method Detail

createEditor

public TaskEditor<ImportLyrics> 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.

isReplaceExistingLyrics

public boolean isReplaceExistingLyrics()

setReplaceExistingLyrics

public void setReplaceExistingLyrics(boolean replaceExistingLyrics)

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

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 obj)

Overrides:

equals in class Task

createDeepCopy

public ImportLyrics createDeepCopy()

Description copied from class: Task

This method creates a copy of the Task and its subtasks. If you added any members to your subclass you MUST override this method and provide code that copies your members.

Overrides:

createDeepCopy in class Task

Returns:

copy