Package org.deepsymmetry.cratedigger

Class Archivist

java.lang.Object

org.deepsymmetry.cratedigger.Archivist

public class Archivist
extends Object

Supports the creation of archives of all the metadata needed from rekordbox media exports to enable full Beat Link features when working with the Opus Quad, which is unable to serve the metadata itself.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Archivist.ArchiveListener	An interface that can be used to display progress to the user as an archive is being created, and allow them to cancel the process if desired.

Method Summary

Modifier and Type	Method	Description
void	createArchive(Database database, File file)	Creates an archive file containing all the metadata found in the rekordbox media export containing the supplied database export that needed to enable full Beat Link features when that media is being used in an Opus Quad, which is unable to serve the metadata itself.
void	createArchive(Database database, File archiveFile, Archivist.ArchiveListener listener)	Creates an archive file containing all the metadata found in the rekordbox media export containing the supplied database export that needed to enable full Beat Link features when that media is being used in an Opus Quad, which is unable to serve the metadata itself.
static Archivist	getInstance()	Look up the singleton instance of this class.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Archivist getInstance()

Look up the singleton instance of this class.

Returns:

the only instance that exists

createArchive

public void createArchive(Database database,
                          File file)
                   throws IOException

Creates an archive file containing all the metadata found in the rekordbox media export containing the supplied database export that needed to enable full Beat Link features when that media is being used in an Opus Quad, which is unable to serve the metadata itself.

Parameters:

database - the parsed database found within the media export for which an archive is desired

file - where to write the archive

Throws:

IOException - if there is a problem creating the archive

createArchive

public void createArchive(Database database,
                          File archiveFile,
                          Archivist.ArchiveListener listener)
                   throws IOException

Creates an archive file containing all the metadata found in the rekordbox media export containing the supplied database export that needed to enable full Beat Link features when that media is being used in an Opus Quad, which is unable to serve the metadata itself.

Parameters:

database - the parsed database found within the media export for which an archive is desired

archiveFile - where to write the archive, will be replaced if it already exists

listener - if not null, will be called throughout the archive process to support progress reports and allow cancellation

Throws:

IOException - if there is a problem creating the archive