net.sf.jmp3renamer
Interface FilePlugin

All Superinterfaces:

Plugin

public interface FilePlugin
extends Plugin

This interface has to be implemented by all PlugIns, which represent a fileformat like the Mp3-PlugIn or the Ogg-PlugIn.

Field Summary

Fields inherited from interface net.sf.jmp3renamer.Plugin

DATA, FILE, GENERAL

Method Summary

ExtendedFileFilter	getFileFilter() Returns a filefilter, which filters files with the fitting suffix for this format.
DataSet	getMetaData(File file) Reads the meta data from a given file.
MyFile	rename(MyFile file, DataSet dataset) Renames a file with the data of the DataSet

Methods inherited from interface net.sf.jmp3renamer.Plugin

coreStarted, getAuthor, getConfig, getConfigGUI, getDescription, getName, getType, getVersion, init, saveConfig, toString

Method Detail

getFileFilter

ExtendedFileFilter getFileFilter()

Returns a filefilter, which filters files with the fitting suffix for this format.

Returns:

a filefilter, which filters files with the fitting suffix for this format.

rename

MyFile rename(MyFile file,
              DataSet dataset)

Renames a file with the data of the DataSet

Parameters:

file - The file, which should be renamed

dataset - The data, which should be used for renaming

Returns:

the result of the rename progress as an MyFile object

getMetaData

DataSet getMetaData(File file)

Reads the meta data from a given file. For example: ID3-Tags for mp3 or the Ogg-Comment for ogg

Parameters:

file - The File, which should be parsed for meta data

Returns:

the parsed data as an DataSet