Package com.tagtraum.beatunes.inspection

Class InspectorCategory

java.lang.Object

com.tagtraum.beatunes.inspection.Inspector

com.tagtraum.beatunes.inspection.InspectorCategory

All Implemented Interfaces:

DetailView, View, ApplicationComponent<BeaTunes>

public class InspectorCategory
extends Inspector

Aggregates multiple Inspectors in order to expose them together through the Inspector (class) interface. This makes InspectorCategory usable by InspectorView.

Author:

Hendrik Schreiber

Field Summary

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

propertyChangeSupport

Method Summary

Modifier and Type	Method	Description
protected void	addIssue(Issue issue)	To be used by subclasses to add a single issue.
protected void	addIssues(Collection<Issue<?>> issues)	To be used by subclasses to add multiple issues.
void	cancel()	Called by the UI.
protected void	clearIssues()	To be used by subclasses.
protected Icon	createDisabledIcon()
protected Icon	createIcon()
String	getCategory()	Indicates the inspection's category or grouping.
String	getDescription()	Inspector description.
List<Inspector>	getInspectors()
static InspectorCategory	getInstance(Inspector inspector)
static List<InspectorCategory>	getInstances(BeaTunes application)
ListModel<Issue<?>>	getIssueModel()
List<Issue<?>>	getIssues()
List<Issue<?>>	getIssues(Long songId)
String	getName()	Inspector name.
String	getPropertyName()	Indicates which property is inspected by this inspector.
Solution	getSolution(String solutionId)
void	inspect(InspectionProgressListener inspectionProgressListener)	Inspects the given songs for problems of a specific kind.
boolean	isAvailable()	Indicates whether this Inspector is available at all.
boolean	isBeforeFirstInspection()	Indicates whether this this inspector has been used before.
boolean	isCancelled()	Lets the Inspector check whether an ongoing inspection was cancelled by the user.
boolean	isEnabled()	Is this inspector enabled?
boolean	isPartiallyEnabled()	Indicates that some Inspectors are enabled while others aren't.
int	issueCount()	Number of issues.
void	removeIssue(Issue issue)
void	removeIssues(Collection<Issue<?>> issues)
void	setAvailable(boolean available)	Sets availability.
void	setEnabled(boolean enabled)	Enables/disables this inspector.

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

addPropertyChangeListener, checkInterruption, getApplication, getComponent, getFocusRoot, getIcon, getId, getInspection, getInspectionProgress, getInspectorCategory, getInspectorView, getStatusLabel, init, isIndeterminateProgress, isInspecting, performInspection, performInspection, refreshLocations, removePropertyChangeListener, setApplication, setInspectionProgress, shutdown, toString

Methods inherited from class java.lang.Object

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

Method Detail

createIcon

protected Icon createIcon()

Overrides:

createIcon in class Inspector

createDisabledIcon

protected Icon createDisabledIcon()

Overrides:

createDisabledIcon in class Inspector

getInstance

public static InspectorCategory getInstance(Inspector inspector)

getInstances

public static List<InspectorCategory> getInstances(BeaTunes application)

isBeforeFirstInspection

public boolean isBeforeFirstInspection()

Description copied from class: Inspector

Indicates whether this this inspector has been used before.

Overrides:

isBeforeFirstInspection in class Inspector

Returns:

true or false

getInspectors

public List<Inspector> getInspectors()

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

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

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

setEnabled

public void setEnabled(boolean enabled)

Description copied from class: Inspector

Enables/disables this inspector.

Overrides:

setEnabled in class Inspector

Parameters:

enabled - true or false

isEnabled

public boolean isEnabled()

Description copied from class: Inspector

Is this inspector enabled?

Overrides:

isEnabled in class Inspector

Returns:

true or false

isPartiallyEnabled

public boolean isPartiallyEnabled()

Description copied from class: Inspector

Indicates that some Inspectors are enabled while others aren't. Only meaningful for InspectorCategory. Default returns false.

Overrides:

isPartiallyEnabled in class Inspector

Returns:

true or false

setAvailable

public void setAvailable(boolean available)

Description copied from class: Inspector

Sets availability.

Overrides:

setAvailable in class Inspector

Parameters:

available - true or false

See Also:

Inspector.isAvailable()

isAvailable

public boolean isAvailable()

Description copied from class: Inspector

Indicates whether this Inspector is available at all. E.g. an Inspector could be unavailable for libraries specified by FileSystemLibraryDescriptor, but available for iTunes specific libraries (ITunesLibraryDescriptor). Or available for macOS, but not for Windows....

Overrides:

isAvailable in class Inspector

Returns:

true or false

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

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

getIssues

public List<Issue<?>> getIssues(Long songId)

Overrides:

getIssues in class Inspector

getIssues

public List<Issue<?>> getIssues()

Overrides:

getIssues in class Inspector

issueCount

public int issueCount()

Description copied from class: Inspector

Number of issues. This property can be followed by adding a property change listener.

Overrides:

issueCount in class Inspector

Returns:

number of current issues

addIssue

protected void addIssue(Issue issue)

Description copied from class: Inspector

To be used by subclasses to add a single issue. Issues may be ignore, if Inspection.ignore(Issue) returns true.

Overrides:

addIssue in class Inspector

Parameters:

issue - issue

See Also:

Inspector.addIssues(java.util.Collection)

addIssues

protected void addIssues(Collection<Issue<?>> issues)

Description copied from class: Inspector

To be used by subclasses to add multiple issues. This method is a lot more efficient than Inspector.addIssue(Issue) when adding a lot of issues, because the UI is only updated once and not for every single issue individually. Issues may be ignore, if Inspection.ignore(Issue) returns true.

Overrides:

addIssues in class Inspector

Parameters:

issues - issues

removeIssue

public void removeIssue(Issue issue)

Overrides:

removeIssue in class Inspector

removeIssues

public void removeIssues(Collection<Issue<?>> issues)

Overrides:

removeIssues in class Inspector

clearIssues

protected void clearIssues()

Description copied from class: Inspector

To be used by subclasses. Should be called before rebuilding the issue list. This also resets the cancel flag to false.

Overrides:

clearIssues in class Inspector

See Also:

Inspector.isCancelled()

cancel

public void cancel()

Description copied from class: Inspector

Called by the UI. Do not call this yourself.

Overrides:

cancel in class Inspector

isCancelled

public boolean isCancelled()

Description copied from class: Inspector

Lets the Inspector check whether an ongoing inspection was cancelled by the user.

Overrides:

isCancelled in class Inspector

Returns:

true, of the user cancelled the inspection

See Also:

Inspector.clearIssues()

getIssueModel

public ListModel<Issue<?>> getIssueModel()

Overrides:

getIssueModel in class Inspector

getSolution

public Solution getSolution(String solutionId)

Overrides:

getSolution in class Inspector