synergynet3.mediadetection

Class MediaDetection

java.lang.Object

synergynet3.mediadetection.MediaDetection

public class MediaDetection
extends java.lang.Object

The Class MediaDetection.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaDetection.Ordering The Enum Ordering.
static class	MediaDetection.SearchType The Enum SearchType.

Constructor Summary

Constructors

Constructor and Description
MediaDetection()

Method Summary

Methods

Modifier and Type	Method and Description
void	addSearchTypeExtension(java.lang.String extension) Creates a custom search type using the extension.
void	addSearchTypeTarget(MediaDetection.SearchType searchType) Adds a MediaSearchType which will set the file types this object's affiliated listener will search for.
void	addSearchTypeTarget(MediaSearchType mediaSearchType) Adds a MediaSearchType which will set the file types this object's affiliated listener will search for.
static CustomSearchType	createCustomSearchType(java.lang.String extension) Creates a custom search type for use with initialising media discovery listeners.
static CustomSearchType	createCustomSearchType(java.lang.String[] extensions) Creates a custom search type for use with initialising media discovery listeners and searching directories using the static methods defined by this class.
void	initialiseDirectoryListener(java.io.File directoryFile, IMediaSearcher mediaSearcher) Sets the directory this object's listener should check for new files.
void	initialiseDirectoryListener(java.lang.String directory, IMediaSearcher mediaSearcher) Sets the directory this object's listener should check for new files.
void	initialiseRemovableMediaListener(IMediaSearcher mediaSearcher) Sets this object's listener to check for any new media devices.
static void	logMediaDetectionError(java.util.logging.Level level, java.lang.String logMessage, java.lang.Exception e) Log media detection error.
java.util.ArrayList<java.io.File[]>	reloadDisoveredContent() Sends any items already discovered by the in these locations to the tables.
static java.io.File[]	searchDirectory(java.lang.String directory, MediaDetection.SearchType searchType, int numberToReturn, MediaDetection.Ordering ordering) Searches the directory at the given location for file types defined by the CustomSearchType created from the given extension.
static java.io.File[]	searchDirectory(java.lang.String directory, MediaSearchType[] mediaSearchTypes, int numberToReturn, MediaDetection.Ordering ordering) Searches the directory at the given location for file types defined by the given MediaSearchTypes.
static java.io.File[]	searchDirectory(java.lang.String directory, MediaSearchType mediaSearchType, int numberToReturn, MediaDetection.Ordering ordering) Searches the directory at the given location for file types defined by the given MediaSearchType.
static java.io.File[]	searchDirectory(java.lang.String directory, java.lang.String[] extensions, int numberToReturn, MediaDetection.Ordering ordering) Searches the directory at the given location for file types defined by the CustomSearchType created from the given array of extensions.
static java.io.File[]	searchDirectory(java.lang.String directory, java.lang.String extension, int numberToReturn, MediaDetection.Ordering ordering) Searches the directory at the given location for file types defined by the CustomSearchType created from the given extension.
static void	setLogger(java.util.logging.Logger logger) Sets a logger for media detection to utilise.
void	setNumberToReturn(int listenerNumberToReturn) Sets how the maximum number of files should be returned by this object's listener at a time.
void	setOrder(MediaDetection.Ordering listenerOrdering) Sets how any files discovered by this object's listener should be sorted.
void	stopListener() Stops this object listening for new files.

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaDetection

public MediaDetection()

Method Detail

createCustomSearchType

public static CustomSearchType createCustomSearchType(java.lang.String extension)

Creates a custom search type for use with initialising media discovery listeners.

Parameters:

extension - The extension of the file type this MediaSearchType should be used for finding.

createCustomSearchType

public static CustomSearchType createCustomSearchType(java.lang.String[] extensions)

Creates a custom search type for use with initialising media discovery listeners and searching directories using the static methods defined by this class.

Parameters:

extensions - An array of strings which represent the extensions of the file types this MediaSearchType should be used for finding.

logMediaDetectionError

public static void logMediaDetectionError(java.util.logging.Level level,
                          java.lang.String logMessage,
                          java.lang.Exception e)

Log media detection error.

Parameters:

level - the level

logMessage - the log message

e - the e

searchDirectory

public static java.io.File[] searchDirectory(java.lang.String directory,
                             MediaSearchType mediaSearchType,
                             int numberToReturn,
                             MediaDetection.Ordering ordering)

Searches the directory at the given location for file types defined by the given MediaSearchType.

Parameters:

directory - The location and name of the directory to be searched for files.

mediaSearchTypes - A MediaSearchType which defines the file types being searched for.

numberToReturn - The maximum number of files to be returned by this search. If value is not positive then all files discovered will be returned.

ordering - A predefined ordering which sets the order any discovered files will be returned in. If value is null then the discovered files will be returned in order of data modified.

searchDirectory

public static java.io.File[] searchDirectory(java.lang.String directory,
                             MediaSearchType[] mediaSearchTypes,
                             int numberToReturn,
                             MediaDetection.Ordering ordering)

Searches the directory at the given location for file types defined by the given MediaSearchTypes.

Parameters:

directory - The location and name of the directory to be searched for files.

mediaSearchTypes - An array of user defined MediaSearchTypes which defines the file types being searched for.

numberToReturn - The maximum number of files to be returned by this search. If value is not positive then all files discovered will be returned.

ordering - A predefined ordering which sets the order any discovered files will be returned in. If value is null then the discovered files will be returned in order of data modified.

searchDirectory

public static java.io.File[] searchDirectory(java.lang.String directory,
                             MediaDetection.SearchType searchType,
                             int numberToReturn,
                             MediaDetection.Ordering ordering)

Searches the directory at the given location for file types defined by the CustomSearchType created from the given extension.

Parameters:

directory - The location and name of the directory to be searched for files.

searchType - A predefined SearchType which determines the files types to be searched for.

numberToReturn - The maximum number of files to be returned by this search. If value is not positive then all files discovered will be returned.

ordering - A predefined ordering which sets the order any discovered files will be returned in. If value is null then the discovered files will be returned in order of data modified.

searchDirectory

public static java.io.File[] searchDirectory(java.lang.String directory,
                             java.lang.String extension,
                             int numberToReturn,
                             MediaDetection.Ordering ordering)

Searches the directory at the given location for file types defined by the CustomSearchType created from the given extension.

Parameters:

directory - The location and name of the directory to be searched for files.

extension - The extension used to define the file type being searched for.

numberToReturn - The maximum number of files to be returned by this search. If value is not positive then all files discovered will be returned.

ordering - A predefined ordering which sets the order any discovered files will be returned in. If value is null then the discovered files will be returned in order of data modified.

searchDirectory

public static java.io.File[] searchDirectory(java.lang.String directory,
                             java.lang.String[] extensions,
                             int numberToReturn,
                             MediaDetection.Ordering ordering)

Searches the directory at the given location for file types defined by the CustomSearchType created from the given array of extensions.

Parameters:

directory - The location and name of the directory to be searched for files.

extensions - An array of extensions used to define the file types being searched for.

numberToReturn - The maximum number of files to be returned by this search. If value is not positive then all files discovered will be returned.

ordering - A predefined ordering which sets the order any discovered files will be returned in. If value is null then the discovered files will be returned in order of data modified.

setLogger

public static void setLogger(java.util.logging.Logger logger)

Sets a logger for media detection to utilise.

Parameters:

logger - The existing logger to be used by media detection.

addSearchTypeExtension

public void addSearchTypeExtension(java.lang.String extension)

Creates a custom search type using the extension. The listener affiliated with this object will search for any files which have the extension given.

Parameters:

extension - The extension of a file type the listener is needed to search for.

addSearchTypeTarget

public void addSearchTypeTarget(MediaSearchType mediaSearchType)

Adds a MediaSearchType which will set the file types this object's affiliated listener will search for. This method can be called multiple times to set a range of file types to be searched for.

Parameters:

mediaSearchType - A user defined MediaSearchType which the listener is needed to search for.

addSearchTypeTarget

public void addSearchTypeTarget(MediaDetection.SearchType searchType)

Adds a MediaSearchType which will set the file types this object's affiliated listener will search for. This method can be called multiple times to set a range of file types to be searched for.

Parameters:

searchType - A predefined SearchType which the listener is needed to search for.

initialiseDirectoryListener

public void initialiseDirectoryListener(java.io.File directoryFile,
                               IMediaSearcher mediaSearcher)

Sets the directory this object's listener should check for new files.

Parameters:

directoryFile - The file representing the directory to be check for new files.

mediaSearcher - The object which any discovered files will be forwarded to.

initialiseDirectoryListener

public void initialiseDirectoryListener(java.lang.String directory,
                               IMediaSearcher mediaSearcher)

Sets the directory this object's listener should check for new files.

Parameters:

directory - The absolute path (and /name) of the directory to be check for new files.

mediaSearcher - The object which any discovered files will be forwarded to.

initialiseRemovableMediaListener

public void initialiseRemovableMediaListener(IMediaSearcher mediaSearcher)

Sets this object's listener to check for any new media devices. When discovered these devices will be searched for new File.

Parameters:

mediaSearcher - The object which any discovered files will be forwarded to.

reloadDisoveredContent

public java.util.ArrayList<java.io.File[]> reloadDisoveredContent()

Sends any items already discovered by the in these locations to the tables.

setNumberToReturn

public void setNumberToReturn(int listenerNumberToReturn)

Sets how the maximum number of files should be returned by this object's listener at a time.

Parameters:

listenerNumberToReturn - The maximum number of files to return.

setOrder

public void setOrder(MediaDetection.Ordering listenerOrdering)

Sets how any files discovered by this object's listener should be sorted.

Parameters:

listenerOrdering - A predefined ordering which sets the order any discovered files will be returned in.

stopListener

public void stopListener()

Stops this object listening for new files.