com.tagtraum.beatunes.library

Class AbstractMusicLibrary<T extends ApplicationComponent>

java.lang.Object

com.tagtraum.beatunes.library.AbstractMusicLibrary<T>

All Implemented Interfaces:

ITunesMusicLibrary, ApplicationComponent<T>

Direct Known Subclasses:

HibernateMusicLibrary

public abstract class AbstractMusicLibrary<T extends ApplicationComponent>
extends Object
implements ITunesMusicLibrary, ApplicationComponent<T>

Abstract music library.

Author:

Hendrik Schreiber

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	AUTO_DETECT_ITUNESLIBRARY
protected File	databaseDir
protected PropertyChangeSupport	propertyChangeSupport
protected static long	TEN_MINUTES
protected static int	TOTALTIME_DEVIATION
protected ITunesMusicLibrary	wrappingProxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMusicLibrary(T application)

Method Summary

Modifier and Type	Method and Description
void	addITunesMusicLibraryListener(ITunesMusicLibraryListener listener)
void	addPropertyChangeListener(PropertyChangeListener propertyChangeListener)
void	addPropertyChangeListener(String property, PropertyChangeListener propertyChangeListener)
protected void	fireAsynchronousSynchronizationEvent()
protected void	fireLibrarySynchronizedEvent()
protected void	fireSynchronousSynchronizationEvent()
T	getApplication() Returns the main application component.
ExecutorService	getAudioMetaDataExecutor() Returns en executor service that should be used for any write access to AudioMetaData related tasks.
<T> T	getImplementation(Class<T> klass)
long	getLastSynchronizationTimestamp() Timestamp of last synchronization of the current library.
LibraryDescriptor	getLibraryDescriptor() Returns the library descriptor.
protected abstract LibraryLoader	getLibraryLoader()
ReentrantLock	getLock(Long songId) Provides a lock object for a song id.
PlayList	getPlayList(long id) Get a PlayList for an id.
long	getPreviousToLastSynchronizationTimestamp() Timestamp of the previous to last synchronization of the current library.
PropertyChangeListener[]	getPropertyChangeListeners()
PropertyChangeListener[]	getPropertyChangeListeners(String property)
Set<Long>	getSongIds(PlayList.Kind... kinds) Returns all ids that are in the given set of PlayList.Kinds.
Iterable<AudioSong>	getSongs() Returns an Iterable that can be used to iterate over all songs.
ITunes	getTunes() Returns the currently associated audio player, probably iTunes.
MultiQueueExecutor	getTunesExecutor() Returns en executor service that should be used for any write access to ITunes related tasks.
MusicLibraryUIDelegate	getUIDelegate()
ITunesMusicLibrary	getWrappingProxy()
WrappingProxyFactory	getWrappingProxyFactory()
boolean	isEmbedAudioMetaData()
boolean	isNewDatabase()
boolean	isOneWeekOld()
protected abstract boolean	isProgressDialogVisible(boolean firstTime, boolean manuallyInitiated)
boolean	isRebuildPlayLists()
boolean	isSynchronizing()
Lock	lock(Long songId) Provides a locked lock for a song id.
boolean	needsRefresh()
void	refresh() Reloads all objects that are connected to the music library.
void	refresh(boolean blockingCall, boolean manuallyInitiated) Reloads all objects that are connected to the music library.
void	refreshOnNextUpdate()
void	removePropertyChangeListener(PropertyChangeListener propertyChangeListener)
void	removePropertyChangeListener(String property, PropertyChangeListener propertyChangeListener)
<V> V	serialExecute(Callable<V> callable) Execute the callable with ITunesMusicLibrary.getTunesExecutor(), but not before ITunesMusicLibrary.getAudioMetaDataExecutor() has run through.
void	serialExecute(Runnable runnable) Execute the runnable with ITunesMusicLibrary.getTunesExecutor(), but not before ITunesMusicLibrary.getAudioMetaDataExecutor() has run through.
void	setApplication(T application) Sets the main application component.
void	setDatabaseDir(File databaseDir)
void	setEmbedAudioMetaData(boolean embedAudioMetaData)
void	setLibraryDescriptor(LibraryDescriptor libraryDescriptor) Sets the library descriptor.
void	setNewDatabase(boolean newDatabase)
void	setRebuildPlayLists(boolean rebuildPlayLists) If set to true, the library will attempt to re-build all playlists on next load(boolean, boolean).
void	setUIDelegate(MusicLibraryUIDelegate uiDelegate)
<V> V	smuggle(Callable<V> callable) Smuggles read-only calls to the ITunesMusicLibrary.getTunesExecutor() even when it's blocked.
void	store(AudioSong song) Stores a song in the beaTunes database.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tagtraum.beatunes.library.ITunesMusicLibrary

addPlayListDataListener, addPlayListPropertyChangeListener, addPlayListPropertyChangeListener, countSongs, countSongsWithPropertyValue, countUnprotectedSongsAddedAfter, createFolder, createFolder, createPlayList, createPlayList, createPlayList, deletePlayList, fetchCollections, flushPendingWrites, getAcousticallyIdenticalSongIds, getAcousticallyIdenticalSongIds, getAlbum, getAlbumKeys, getAlbumSongIds, getAlbumSongs, getAllTimesFavoriteAlbums, getApplicationVersion, getDatabaseDir, getDuplicateTitles, getDuplicateTrackIds, getGenres, getHighlyRatedAlbums, getLibrary, getPersistentId, getPlayListPropertyChangeListeners, getPlayListPropertyChangeListeners, getPlayLists, getPopularTagCollection, getRecentlyAddedAlbums, getRecentlyPlayedAlbums, getSimilarTitles, getSong, getSongIds, getSongIdsWithoutPropertyValue, getSongIdsWithPropertyLikeValue, getSongIdsWithPropertyValue, getSongPropertyValues, getSongPropertyValues, getSongPropertyValues, getSongs, getSongsWithFileAndSize, getSongsWithNameArtistAlbumTotalTime, getSongsWithoutPropertyValue, getSongsWithPropertyLikeValue, getSongsWithPropertyValue, getSongsWithTrackIdTotalTime, getTagCollection, getUnprotectedSongsAddedAfter, init, removePlayListDataListener, removePlayListPropertyChangeListener, removePlayListPropertyChangeListener, shutdown, store, store, store, store

Methods inherited from interface com.tagtraum.core.app.ApplicationComponent

getId, init, shutdown

Field Detail

AUTO_DETECT_ITUNESLIBRARY

public static final boolean AUTO_DETECT_ITUNESLIBRARY

TEN_MINUTES

protected static final long TEN_MINUTES

See Also:

Constant Field Values

TOTALTIME_DEVIATION

protected static final int TOTALTIME_DEVIATION

See Also:

Constant Field Values

propertyChangeSupport

protected PropertyChangeSupport propertyChangeSupport

databaseDir

protected File databaseDir

wrappingProxy

protected final ITunesMusicLibrary wrappingProxy

Constructor Detail

AbstractMusicLibrary

protected AbstractMusicLibrary(T application)

Method Detail

getWrappingProxyFactory

public WrappingProxyFactory getWrappingProxyFactory()

getWrappingProxy

public ITunesMusicLibrary getWrappingProxy()

getUIDelegate

public MusicLibraryUIDelegate getUIDelegate()

setUIDelegate

public void setUIDelegate(MusicLibraryUIDelegate uiDelegate)

Specified by:

setUIDelegate in interface ITunesMusicLibrary

isEmbedAudioMetaData

public boolean isEmbedAudioMetaData()

Specified by:

isEmbedAudioMetaData in interface ITunesMusicLibrary

setEmbedAudioMetaData

public void setEmbedAudioMetaData(boolean embedAudioMetaData)

Specified by:

setEmbedAudioMetaData in interface ITunesMusicLibrary

getTunes

public ITunes getTunes()

Description copied from interface: ITunesMusicLibrary

Returns the currently associated audio player, probably iTunes.

Specified by:

getTunes in interface ITunesMusicLibrary

Returns:

audio player

getApplication

public T getApplication()

Description copied from interface: ApplicationComponent

Returns the main application component.

Specified by:

getApplication in interface ApplicationComponent<T extends ApplicationComponent>

Returns:

application object

getImplementation

public <T> T getImplementation(Class<T> klass)

Specified by:

getImplementation in interface ITunesMusicLibrary

setApplication

public void setApplication(T application)

Description copied from interface: ApplicationComponent

Sets the main application component.

Specified by:

setApplication in interface ApplicationComponent<T extends ApplicationComponent>

Parameters:

application - main application component

getLock

public ReentrantLock getLock(Long songId)

Description copied from interface: ITunesMusicLibrary

Provides a lock object for a song id.

Specified by:

getLock in interface ITunesMusicLibrary

Parameters:

songId - song id

Returns:

exclusive, reentrant lock

lock

public Lock lock(Long songId)

Description copied from interface: ITunesMusicLibrary

Provides a locked lock for a song id.

Specified by:

lock in interface ITunesMusicLibrary

Parameters:

songId - song id

Returns:

exclusive, reentrant lock

getTunesExecutor

public MultiQueueExecutor getTunesExecutor()

Description copied from interface: ITunesMusicLibrary

Returns en executor service that should be used for any write access to ITunes related tasks. This takes care of synchronizing your access as well as using the correct thread.

Typically when working with AudioSong objects, synchronization happens behind the scenes, so you don't have to use this service. However, there may be situations in which you want to access a Track directly. If you intend to write, you should use this executor.

The service is managed by the application, i.e. you cannot terminate or shut it down.

Specified by:

getTunesExecutor in interface ITunesMusicLibrary

Returns:

executor service

See Also:

TunesUtilities.getExecutorService()

getAudioMetaDataExecutor

public ExecutorService getAudioMetaDataExecutor()

Description copied from interface: ITunesMusicLibrary

Returns en executor service that should be used for any write access to AudioMetaData related tasks. This takes care of synchronizing your access as well as using the correct thread.

Typically when working with AudioSong objects, synchronization happens behind the scenes, so you don't have to use this service. However, there may be situations in which you want to access a AudioMetaData directly. If you intend to write, you should use this executor.

The service is managed by the application, i.e. you cannot terminate or shut it down.

Specified by:

getAudioMetaDataExecutor in interface ITunesMusicLibrary

Returns:

executor service

See Also:

AudioMetaData.getExecutorService()

serialExecute

public <V> V serialExecute(Callable<V> callable)
                    throws Exception

Description copied from interface: ITunesMusicLibrary

Execute the callable with ITunesMusicLibrary.getTunesExecutor(), but not before ITunesMusicLibrary.getAudioMetaDataExecutor() has run through.

Specified by:

serialExecute in interface ITunesMusicLibrary

Type Parameters:

V - return type

Parameters:

callable - callable

Returns:

return value, may be null

Throws:

Exception

serialExecute

public void serialExecute(Runnable runnable)

Description copied from interface: ITunesMusicLibrary

Execute the runnable with ITunesMusicLibrary.getTunesExecutor(), but not before ITunesMusicLibrary.getAudioMetaDataExecutor() has run through.

Specified by:

serialExecute in interface ITunesMusicLibrary

Parameters:

runnable - runnable

smuggle

public <V> V smuggle(Callable<V> callable)
              throws Exception

Description copied from interface: ITunesMusicLibrary

Smuggles read-only calls to the ITunesMusicLibrary.getTunesExecutor() even when it's blocked.

Specified by:

smuggle in interface ITunesMusicLibrary

Type Parameters:

V - return type

Parameters:

callable - callable

Returns:

return value, may be null

Throws:

Exception

isNewDatabase

public boolean isNewDatabase()

Specified by:

isNewDatabase in interface ITunesMusicLibrary

setNewDatabase

public void setNewDatabase(boolean newDatabase)

Specified by:

setNewDatabase in interface ITunesMusicLibrary

getSongs

public Iterable<AudioSong> getSongs()

Description copied from interface: ITunesMusicLibrary

Returns an Iterable that can be used to iterate over all songs. Shortcut for getLibrary().getSongs(). Note that the Iterable may be a List, which would expose other means of dealing with the content.

Specified by:

getSongs in interface ITunesMusicLibrary

Returns:

an object from which one can get an iterator

getSongIds

public Set<Long> getSongIds(PlayList.Kind... kinds)

Description copied from interface: ITunesMusicLibrary

Returns all ids that are in the given set of PlayList.Kinds.

Specified by:

getSongIds in interface ITunesMusicLibrary

Parameters:

kinds - kind

Returns:

set of ids

isRebuildPlayLists

public boolean isRebuildPlayLists()

setRebuildPlayLists

public void setRebuildPlayLists(boolean rebuildPlayLists)

If set to true, the library will attempt to re-build all playlists on next load(boolean, boolean). This makes primarily sense for iTunes based libraries. The load/sync itself is not triggered automatically.

Parameters:

rebuildPlayLists - true, if you want to trigger a rebuild.

getPlayList

public PlayList getPlayList(long id)

Description copied from interface: ITunesMusicLibrary

Get a PlayList for an id.

Specified by:

getPlayList in interface ITunesMusicLibrary

Parameters:

id - persistent id

Returns:

the playlist corresponding to the id or null, if it does not exist

getLibraryLoader

protected abstract LibraryLoader getLibraryLoader()

getLastSynchronizationTimestamp

public long getLastSynchronizationTimestamp()

Description copied from interface: ITunesMusicLibrary

Timestamp of last synchronization of the current library.

Specified by:

getLastSynchronizationTimestamp in interface ITunesMusicLibrary

Returns:

timestamp or 0, if unknown

getPreviousToLastSynchronizationTimestamp

public long getPreviousToLastSynchronizationTimestamp()

Description copied from interface: ITunesMusicLibrary

Timestamp of the previous to last synchronization of the current library.

Specified by:

getPreviousToLastSynchronizationTimestamp in interface ITunesMusicLibrary

Returns:

timestamp or 0, if unknown

setLibraryDescriptor

public void setLibraryDescriptor(LibraryDescriptor libraryDescriptor)

Description copied from interface: ITunesMusicLibrary

Sets the library descriptor.

Specified by:

setLibraryDescriptor in interface ITunesMusicLibrary

Parameters:

libraryDescriptor - library descriptor

getLibraryDescriptor

public LibraryDescriptor getLibraryDescriptor()

Description copied from interface: ITunesMusicLibrary

Returns the library descriptor. Use this method to find out, what kind of library you are dealing with.

Specified by:

getLibraryDescriptor in interface ITunesMusicLibrary

Returns:

library descriptor

See Also:

ITunesLibraryDescriptor, FileSystemLibraryDescriptor

refresh

public void refresh()
             throws IOException,
                    ParserConfigurationException,
                    SAXException

Description copied from interface: ITunesMusicLibrary

Reloads all objects that are connected to the music library. If this is the first time we are loading the library, it will be done synchronously. After that it will be done asynchronously.

Specified by:

refresh in interface ITunesMusicLibrary

Throws:

IOException

ParserConfigurationException

SAXException

refresh

public void refresh(boolean blockingCall,
                    boolean manuallyInitiated)
             throws IOException,
                    ParserConfigurationException,
                    SAXException

Description copied from interface: ITunesMusicLibrary

Reloads all objects that are connected to the music library.

Specified by:

refresh in interface ITunesMusicLibrary

Parameters:

blockingCall - flag to indicate whether this call should return right away or not.

manuallyInitiated - indicates whether this refresh was directly triggered by some user action

Throws:

IOException

ParserConfigurationException

SAXException

refreshOnNextUpdate

public void refreshOnNextUpdate()

needsRefresh

public boolean needsRefresh()

Specified by:

needsRefresh in interface ITunesMusicLibrary

Returns:

true, if the library is based on an xml files and was changed. Or if we cannot determine, if a refresh is really necessary

isOneWeekOld

public boolean isOneWeekOld()

Specified by:

isOneWeekOld in interface ITunesMusicLibrary

Returns:

true if the iTunes (Music) Library.xml file is older than one week.

See Also:

ITunesMusicLibrary.getLibraryDescriptor()

isProgressDialogVisible

protected abstract boolean isProgressDialogVisible(boolean firstTime,
                                                   boolean manuallyInitiated)

isSynchronizing

public boolean isSynchronizing()

Specified by:

isSynchronizing in interface ITunesMusicLibrary

addITunesMusicLibraryListener

public void addITunesMusicLibraryListener(ITunesMusicLibraryListener listener)

Specified by:

addITunesMusicLibraryListener in interface ITunesMusicLibrary

fireLibrarySynchronizedEvent

protected void fireLibrarySynchronizedEvent()

fireSynchronousSynchronizationEvent

protected void fireSynchronousSynchronizationEvent()

fireAsynchronousSynchronizationEvent

protected void fireAsynchronousSynchronizationEvent()

setDatabaseDir

public void setDatabaseDir(File databaseDir)

Specified by:

setDatabaseDir in interface ITunesMusicLibrary

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener propertyChangeListener)

Specified by:

addPropertyChangeListener in interface ITunesMusicLibrary

addPropertyChangeListener

public void addPropertyChangeListener(String property,
                                      PropertyChangeListener propertyChangeListener)

Specified by:

addPropertyChangeListener in interface ITunesMusicLibrary

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener propertyChangeListener)

Specified by:

removePropertyChangeListener in interface ITunesMusicLibrary

removePropertyChangeListener

public void removePropertyChangeListener(String property,
                                         PropertyChangeListener propertyChangeListener)

Specified by:

removePropertyChangeListener in interface ITunesMusicLibrary

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()

Specified by:

getPropertyChangeListeners in interface ITunesMusicLibrary

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners(String property)

Specified by:

getPropertyChangeListeners in interface ITunesMusicLibrary

store

public void store(AudioSong song)

Description copied from interface: ITunesMusicLibrary

Stores a song in the beaTunes database.

The write-process is asynchronous, i.e. this method may return before the songs has actually been written.

Specified by:

store in interface ITunesMusicLibrary

Parameters:

song - song to save