Package org.esa.snap.core.dataio

Interface ProductWriterPlugIn

All Superinterfaces:
ProductIOPlugIn
All Known Implementing Classes:
DimapProductWriterPlugIn
public interface ProductWriterPlugIn extends ProductIOPlugIn
The ProductWriterPlugIn interface is implemented by data product writer plug-ins.

ProductWriterPlugIn plug-ins are used to provide meta-information about a particular data format and to create instances of the actual writer 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$
See Also:

  • Method Details

    • getEncodeQualification

      EncodeQualification getEncodeQualification(Product product)
      Gets the encode qualification of this product writer plugin w.r.t. the given product.
      Parameters:
      product - The product.
      Returns:
      The encode qualification.
      Since:
      SNAP 2.0

    • getOutputTypes

      Class[] getOutputTypes()
      Returns an array containing the classes that represent valid output types for this writer.

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

      Returns:
      an array containing valid output types, never null
      See Also:

    • createWriterInstance

      ProductWriter createWriterInstance()
      Creates an instance of the actual product writer class. This method should never return null.
      Returns:
      a new writer instance, never null