Package com.tagtraum.beatunes.analysis

Class IdentifyLyricsLanguage

java.lang.Object

com.tagtraum.beatunes.analysis.Task

com.tagtraum.beatunes.analysis.SongAnalysisTask

com.tagtraum.beatunes.analysis.IdentifyLyricsLanguage

All Implemented Interfaces:

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

@Entity
public class IdentifyLyricsLanguage
extends SongAnalysisTask

Tries to identify lyrics language.

Author:

Hendrik Schreiber

Field Summary

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

useOnlineResources

Constructor Summary

Constructors

Constructor	Description
IdentifyLyricsLanguage()

Method Summary

Modifier and Type	Method	Description
IdentifyLyricsLanguage	createDeepCopy()	This method creates a copy of the Task and its subtasks.
String	getDescription()	HTML or plain text description of this task.
String	getName()	HTML or plaintext name of this task.
boolean	isFallbackToAlbumSongTitles()
boolean	isReplaceExistingLanguage()
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	setFallbackToAlbumSongTitles(boolean fallbackToAlbumSongTitles)
void	setReplaceExistingLanguage(boolean replaceExistingLanguage)
boolean	skip()	Indicates, whether this task can be skipped.
String	toString()

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

add, addTaskProcessListener, addTaskRunListener, cancel, clearProperties, createEditor, createTask, deepRemove, equals, 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, 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

IdentifyLyricsLanguage

public IdentifyLyricsLanguage()

Method Detail

getDescription

public String getDescription()

Description copied from class: Task

HTML or plain text description of this task.

Overrides:

getDescription in class Task

Returns:

description

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

isReplaceExistingLanguage

public boolean isReplaceExistingLanguage()

setReplaceExistingLanguage

public void setReplaceExistingLanguage(boolean replaceExistingLanguage)

isFallbackToAlbumSongTitles

public boolean isFallbackToAlbumSongTitles()

setFallbackToAlbumSongTitles

public void setFallbackToAlbumSongTitles(boolean fallbackToAlbumSongTitles)

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

createDeepCopy

public IdentifyLyricsLanguage 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

toString

public String toString()

Overrides:

toString in class Task