Package org.esa.snap.core.dataio
Interface ProductWriterPlugIn
-
- All Superinterfaces:
ProductIOPlugIn
- All Known Implementing Classes:
DimapProductWriterPlugIn
public interface ProductWriterPlugIn extends ProductIOPlugIn
TheProductWriterPlugIn
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:
ProductReaderPlugIn
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ProductWriter
createWriterInstance()
Creates an instance of the actual product writer class.EncodeQualification
getEncodeQualification(Product product)
Gets the encode qualification of this product writer plugin w.r.t.Class[]
getOutputTypes()
Returns an array containing the classes that represent valid output types for this writer.-
Methods inherited from interface org.esa.snap.core.dataio.ProductIOPlugIn
getDefaultFileExtensions, getDescription, getFormatNames, getProductFileFilter
-
-
-
-
Method Detail
-
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 theProductWriter
interface (the method will not throw anInvalidArgumentException
in this case).- Returns:
- an array containing valid output types, never
null
- See Also:
ProductWriter.writeProductNodes(org.esa.snap.core.datamodel.Product, java.lang.Object)
-
createWriterInstance
ProductWriter createWriterInstance()
Creates an instance of the actual product writer class. This method should never returnnull
.- Returns:
- a new writer instance, never
null
-
-