Package com.tagtraum.beatunes.inspection

Class CapitalizationInspector

java.lang.Object

com.tagtraum.beatunes.inspection.Inspector

com.tagtraum.beatunes.inspection.CapitalizationInspector

All Implemented Interfaces:

DetailView, View, ApplicationComponent<BeaTunes>

public class CapitalizationInspector
extends Inspector

Checks the capitalization of song titles. Special rules for English apply. In all other cases we ask the SpellChecker for alternative spellings and resort to them should they have the same length.

Author:

Hendrik Schreiber

See Also:

MusicBrainz Style Guide

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CapitalizationInspector.DifferentLanguageInputDialogSolution
static class	CapitalizationInspector.EnglishSongTitleCapitalization

Field Summary

Fields inherited from class com.tagtraum.beatunes.inspection.Inspector

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
CapitalizationInspector(BeaTunes application)

Method Summary

Modifier and Type	Method	Description
String	getCategory()	Indicates the inspection's category or grouping.
String	getDescription()	Inspector description.
String	getName()	Inspector name.
String	getPropertyName()	Indicates which property is inspected by this inspector.
void	inspect(InspectionProgressListener inspectionProgressListener)	Inspects the given songs for problems of a specific kind.

Methods inherited from class com.tagtraum.beatunes.inspection.Inspector

addIssue, addIssues, addPropertyChangeListener, cancel, checkInterruption, clearIssues, createDisabledIcon, createIcon, getApplication, getComponent, getFocusRoot, getIcon, getId, getInspection, getInspectionProgress, getInspectorCategory, getInspectorView, getIssueModel, getIssues, getIssues, getSolution, getStatusLabel, init, isAvailable, isBeforeFirstInspection, isCancelled, isEnabled, isIndeterminateProgress, isInspecting, isPartiallyEnabled, issueCount, performInspection, performInspection, refreshLocations, removeIssue, removeIssues, removePropertyChangeListener, setApplication, setAvailable, setEnabled, setInspectionProgress, shutdown, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CapitalizationInspector

public CapitalizationInspector(BeaTunes application)

Method Detail

getCategory

public String getCategory()

Description copied from class: Inspector

Indicates the inspection's category or grouping. By default this returns GENERAL.

Overrides:

getCategory in class Inspector

Returns:

category, by default General

getName

public String getName()

Description copied from class: Inspector

Inspector name.

Specified by:

getName in class Inspector

Returns:

descriptive name for this inspector meant for the UI

getPropertyName

public String getPropertyName()

Description copied from class: Inspector

Indicates which property is inspected by this inspector. This will be used when highlighting said property in views of a song that has issues.

Specified by:

getPropertyName in class Inspector

Returns:

property name

getDescription

public String getDescription()

Description copied from class: Inspector

Inspector description.

Specified by:

getDescription in class Inspector

Returns:

long description about this inspector meant for the UI

inspect

public void inspect(InspectionProgressListener inspectionProgressListener)

Description copied from class: Inspector

Inspects the given songs for problems of a specific kind. Found issues are accessible through the issues property. Implementations need to add issues using Inspector.addIssue(Issue). If this is a long running inspection, you might want to check Inspector.isCancelled() every now and then and abort the inspection should the method return true. Note that this method is called in a separate thread, i.e. not the event dispatch thread. You can report progress through InspectionProgressListener.progress(Inspector, String, float).

Specified by:

inspect in class Inspector

Parameters:

inspectionProgressListener - progress listener

See Also:

Inspector.getIssues(), Inspector.addIssue(Issue), Inspector.isCancelled()