org.esa.beam.framework.dataio
Interface ProductIOPlugIn

All Known Subinterfaces:

ProductReaderPlugIn, ProductWriterPlugIn

public interface ProductIOPlugIn

The ProductIOPlugIn interface is the base for all data product reader or writer plug-ins.

Version:

$Revision$ $Date$

Author:

Norman Fomferra

Method Summary

String[]	getDefaultFileExtensions() Gets the default file extensions associated with each of the format names returned by the getFormatNames() method.
String	getDescription(Locale locale) Gets a short description of this plug-in.
String[]	getFormatNames() Gets the names of the product formats handled by this product I/O plug-in.
BeamFileFilter	getProductFileFilter() Gets an instance of BeamFileFilter for use in a JFileChooser.

Method Detail

getFormatNames

String[] getFormatNames()

Gets the names of the product formats handled by this product I/O plug-in.

Returns:

the names of the product formats handled by this product I/O plug-in, never null

getDefaultFileExtensions

String[] getDefaultFileExtensions()

Gets the default file extensions associated with each of the format names returned by the getFormatNames() method.

The string array returned shall always have the same length as the array returned by the getFormatNames() method.

The extensions returned in the string array also shall always include a leading colon ('.') character, e.g. ".hdf"

Returns:

the default file extensions for this product I/O plug-in, never null

getDescription

String getDescription(Locale locale)

Gets a short description of this plug-in. If the given locale is set to null the default locale is used.

In a GUI, the description returned could be used as tool-tip text.

Parameters:

locale - the local for the given decription string, if null the default locale is used

Returns:

a textual description of this product reader/writer

getProductFileFilter

BeamFileFilter getProductFileFilter()

Gets an instance of BeamFileFilter for use in a JFileChooser.

Returns:

a file filter