org.esa.beam.framework.dataio
Interface ProductReaderPlugIn

All Superinterfaces:

ProductIOPlugIn

public interface ProductReaderPlugIn
extends ProductIOPlugIn

The ProductReaderPlugIn interface is implemented by data product reader plug-ins.

XMLDecoder plug-ins are used to provide meta-information about a particular data format and to create instances of the actual reader objects.

A plug-in can register itself in the ProductIO plug-in registry or it is automatically found during a classpath scan.

Version:

$Revision$ $Date$

Author:

Norman Fomferra

See Also:

ProductWriterPlugIn

Method Summary

ProductReader	createReaderInstance() Creates an instance of the actual product reader class.
DecodeQualification	getDecodeQualification(Object input) Gets the qualification of the product reader to decode a given input object.
Class[]	getInputTypes() Returns an array containing the classes that represent valid input types for this reader.

Methods inherited from interface org.esa.beam.framework.dataio.ProductIOPlugIn

getDefaultFileExtensions, getDescription, getFormatNames, getProductFileFilter

Method Detail

getDecodeQualification

DecodeQualification getDecodeQualification(Object input)

Gets the qualification of the product reader to decode a given input object.

Parameters:

input - the input object

Returns:

the decode qualification

getInputTypes

Class[] getInputTypes()

Returns an array containing the classes that represent valid input types for this reader.

Intances of the classes returned in this array are valid objects for the setInput method of the ProductReader interface (the method will not throw an InvalidArgumentException in this case).

Returns:

an array containing valid input types, never null

createReaderInstance

ProductReader createReaderInstance()

Creates an instance of the actual product reader class. This method should never return null.

Returns:

a new reader instance, never null