|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IStore
Stores are similar too sources, except that they are also writable. Once information has been retrieved from a source, it is written too a store. Next time the information is needed, it can be retrieved from the store. This makes retrieving information a lot faster.
Method Summary | |
---|---|
void |
cacheEpisode(java.io.File rootMediaDir,
java.io.File episodeFile,
IEpisode episode)
This is used to write a episode or special too the store |
void |
cacheFilm(java.io.File rootMediaDir,
java.io.File filmFile,
IFilm film,
java.lang.Integer part)
This is used to write a film to the store. |
void |
cacheSeason(java.io.File rootMediaDir,
java.io.File episodeFile,
ISeason season)
This is used to write a season too the store. |
void |
cacheShow(java.io.File rootMediaDir,
java.io.File episodeFile,
IShow show)
This is used to write a show too the store. |
void |
fileDeleted(MediaDirectory dir,
java.io.File file)
This is called when a file is deleted from a media directory |
void |
fileUpdated(MediaDirectory mediaDirectory,
java.io.File file)
This is called when a file is updated within a media directory. |
IEpisode |
getEpisode(java.io.File rootMediaDir,
java.io.File episodeFile,
ISeason season,
int episodeNum)
This gets a episode from the store. |
IEpisode |
getEpisode(MediaDirectory dir,
java.io.File file)
This is used to get a episode from a store via it's file name. |
IFilm |
getFilm(java.io.File rootMediaDir,
java.io.File filmFile,
java.lang.String filmId)
This will get a film from the store. |
IFilm |
getFilm(MediaDirectory dir,
java.io.File file)
This is used to get a film from a store via it's file name. |
java.lang.String |
getParameter(java.lang.String key)
Used to get the value of a source parameter. |
ISeason |
getSeason(java.io.File rootMediaDir,
java.io.File episodeFile,
IShow show,
int seasonNum)
This will get a season from the store. |
IShow |
getShow(java.io.File rootMediaDir,
java.io.File episodeFile,
java.lang.String showId)
This will get a show from the store. |
IEpisode |
getSpecial(java.io.File rootMediaDir,
java.io.File episodeFile,
ISeason season,
int specialNumber)
This gets a special episode from the store. |
void |
init(Controller controller,
java.io.File nativeDir)
Called to initialise the stores and check all their resources can be found. |
java.util.Collection<IEpisode> |
listEpisodes(MediaDirConfig dirConfig,
IProgressMonitor monitor)
This is used to list all the episodes within the store if the store supports the operation. |
java.util.Collection<IFilm> |
listFilms(MediaDirConfig dirConfig,
IProgressMonitor monitor)
This is used to list all the films within the store if the store supports the operation. |
void |
performedActions(MediaDirectory dir)
This is called after all the actions on all the media files have been performed so that the store can clean up any stale data. |
void |
renamedFile(java.io.File rootMediaDir,
java.io.File oldFile,
java.io.File newFile)
This is used when a file that holds a episode or film has been renamed |
SearchResult |
searchMedia(java.lang.String name,
Mode mode,
java.lang.Integer part,
MediaDirConfig dirConfig,
java.io.File mediaFile)
Used to search for store for media |
void |
setParameter(java.lang.String key,
java.lang.String value)
Used to set source parameters. |
void |
upgrade(MediaDirectory mediaDirectory)
This is called to check if a upgrade is needed and perform the upgrade if required |
Method Detail |
---|
void cacheEpisode(java.io.File rootMediaDir, java.io.File episodeFile, IEpisode episode) throws StoreException
episode
- The episode or special too writeepisodeFile
- the file witch the episode is stored inrootMediaDir
- This is the directory which is the root of media, this can be the current directory if
it was not specified on the command line.
StoreException
- Thrown if their is a problem with the storevoid cacheSeason(java.io.File rootMediaDir, java.io.File episodeFile, ISeason season) throws StoreException
season
- The season too writeepisodeFile
- The file the episode is stored inrootMediaDir
- This is the directory which is the root of media, this can be the current directory if
it was not specified on the command line.
StoreException
- Thrown if their is a problem with the storevoid cacheShow(java.io.File rootMediaDir, java.io.File episodeFile, IShow show) throws StoreException
show
- The show too writeepisodeFile
- The file the episode is stored inrootMediaDir
- This is the directory which is the root of media, this can be the current directory if
it was not specified on the command line.
StoreException
- Thrown if their is a problem with the storevoid cacheFilm(java.io.File rootMediaDir, java.io.File filmFile, IFilm film, java.lang.Integer part) throws StoreException
filmFile
- The file which the film is stored infilm
- The film to writepart
- The part number of the filmrootMediaDir
- This is the directory which is the root of media, this can be the current directory if
it was not specified on the command line.
StoreException
- Thrown if their is a problem with the storeIEpisode getEpisode(java.io.File rootMediaDir, java.io.File episodeFile, ISeason season, int episodeNum) throws StoreException, java.net.MalformedURLException, java.io.IOException
episodeFile
- the file which the episode is stored inseason
- The season the episode belongs tooepisodeNum
- The number of the episode too getrootMediaDir
- This is the directory which is the root of media, this can be the current directory if
it was not specified on the command line.
StoreException
- Thrown if their is a problem with the store
java.net.MalformedURLException
- Thrown if their is a problem creating URL's
java.io.IOException
- Thrown if their is a I/O related problem.ISeason getSeason(java.io.File rootMediaDir, java.io.File episodeFile, IShow show, int seasonNum) throws StoreException, java.io.IOException
episodeFile
- the file which the episode is stored inshow
- The show the season belongs tooseasonNum
- The number of the season that is to be fetchedrootMediaDir
- This is the directory which is the root of media, this can be the current directory if
it was not specified on the command line.
StoreException
- Thrown if their is a problem with the store
java.io.IOException
- Thrown if their is a I/O related problem.IShow getShow(java.io.File rootMediaDir, java.io.File episodeFile, java.lang.String showId) throws StoreException, java.net.MalformedURLException, java.io.IOException
episodeFile
- the file which the episode is stored inshowId
- The id of the show to get.rootMediaDir
- This is the directory which is the root of media, this can be the current directory if
it was not specified on the command line.
StoreException
- Thrown if their is a problem with the store
java.net.MalformedURLException
- Thrown if their is a problem creating URL's
java.io.IOException
- Thrown if their is a I/O related problem.IEpisode getSpecial(java.io.File rootMediaDir, java.io.File episodeFile, ISeason season, int specialNumber) throws java.net.MalformedURLException, java.io.IOException, StoreException
episodeFile
- the file which the episode is stored inseason
- The season the special episode belongs toospecialNumber
- The number of the special episode too getrootMediaDir
- This is the directory which is the root of media, this can be the current directory if
it was not specified on the command line.
StoreException
- Thrown if their is a problem with the store
java.net.MalformedURLException
- Thrown if their is a problem creating URL's
java.io.IOException
- Thrown if their is a I/O related problem.SearchResult searchMedia(java.lang.String name, Mode mode, java.lang.Integer part, MediaDirConfig dirConfig, java.io.File mediaFile) throws StoreException
name
- The search termmode
- The mode of the searchpart
- The part number to search fordirConfig
- The Media directory configurationmediaFile
- The media file the search is associated with
StoreException
- Thrown if their is a problem with the storevoid renamedFile(java.io.File rootMediaDir, java.io.File oldFile, java.io.File newFile) throws StoreException
rootMediaDir
- This is the directory which is the root of media, this can be the current directory if
it was not specified on the command line.oldFile
- The old filenewFile
- The new file
StoreException
- Thrown if their is a problem renaming filesIFilm getFilm(java.io.File rootMediaDir, java.io.File filmFile, java.lang.String filmId) throws StoreException, java.net.MalformedURLException, java.io.IOException
filmFile
- The file the film is located in.filmId
- The id of the filmrootMediaDir
- This is the directory which is the root of media, this can be the current directory if
it was not specified on the command line.
StoreException
- Thrown if their is a problem retrieving the data
java.net.MalformedURLException
- Thrown if their is a problem creating URL's
java.io.IOException
- Thrown if their is a I/O related problem.void setParameter(java.lang.String key, java.lang.String value) throws StoreException
Used to set source parameters. If the key is not supported by this source, then a SourceException
is thrown.
key
- The key of the parametervalue
- The value of the parameter
StoreException
- Throw if the key is not supported by this store.java.lang.String getParameter(java.lang.String key) throws StoreException
Used to get the value of a source parameter. If the key is not supported by this source, then a SourceException
is thrown.
key
- The key of the parameter
StoreException
- Throw if the key is not supported by this store.void performedActions(MediaDirectory dir) throws StoreException
dir
- The media directory
StoreException
- Thrown if their is a problemvoid fileDeleted(MediaDirectory dir, java.io.File file) throws StoreException
dir
- The media directoryfile
- The file
StoreException
- Thrown if their is a problemIEpisode getEpisode(MediaDirectory dir, java.io.File file) throws StoreException
dir
- The media directoryfile
- The media file
StoreException
- Thrown if their are any problemsIFilm getFilm(MediaDirectory dir, java.io.File file) throws StoreException
dir
- The media directoryfile
- The media file
StoreException
- Thrown if their are any problemsvoid init(Controller controller, java.io.File nativeDir) throws StoreException
controller
- The media controllernativeDir
- The native folder been used or configured. Null if can't be found
StoreException
- Thrown if their are any problemsjava.util.Collection<IEpisode> listEpisodes(MediaDirConfig dirConfig, IProgressMonitor monitor) throws StoreException
dirConfig
- The media directory configurationmonitor
- The progress monitor
StoreException
- Thrown if their are any problemsjava.util.Collection<IFilm> listFilms(MediaDirConfig dirConfig, IProgressMonitor monitor) throws StoreException
dirConfig
- The media directory configurationmonitor
- The progress monitor
StoreException
- Thrown if their are any problemsvoid upgrade(MediaDirectory mediaDirectory) throws StoreException
mediaDirectory
- The media directory been upgraded
StoreException
- Thrown if thier are any problemsvoid fileUpdated(MediaDirectory mediaDirectory, java.io.File file) throws StoreException
mediaDirectory
- The media directory the file belongs tofile
- The media file
StoreException
- Thrown if their are any problems
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |