Class AbstractProductBuilder

java.lang.Object
org.esa.snap.core.dataio.AbstractProductReader
org.esa.snap.core.dataio.AbstractProductBuilder
All Implemented Interfaces:
ProductReader
Direct Known Subclasses:
ProductFlipper, ProductSubsetBuilder

public abstract class AbstractProductBuilder extends AbstractProductReader
  • Field Details

    • sourceProduct

      protected Product sourceProduct
    • sourceProductOwner

      protected boolean sourceProductOwner
    • sceneRasterWidth

      protected int sceneRasterWidth
    • sceneRasterHeight

      protected int sceneRasterHeight
    • newProductName

      protected String newProductName
    • newProductDesc

      protected String newProductDesc
    • bandMap

      protected Map<Band,RasterDataNode> bandMap
  • Constructor Details

    • AbstractProductBuilder

      public AbstractProductBuilder(boolean sourceProductOwner)
  • Method Details

    • getSourceProduct

      public Product getSourceProduct()
    • isSourceProductOwner

      public boolean isSourceProductOwner()
    • setNewProductDesc

      public void setNewProductDesc(String newProductDesc)
    • setNewProductName

      public void setNewProductName(String newProductName)
    • getSceneRasterWidth

      public int getSceneRasterWidth()
    • getSceneRasterHeight

      public int getSceneRasterHeight()
    • readProductNodes

      protected Product readProductNodes(Product sourceProduct, ProductSubsetDef subsetDef, String name, String desc) throws IOException
      Throws:
      IOException
    • readProductNodesImpl

      protected abstract Product readProductNodesImpl() throws IOException
      Description copied from class: AbstractProductReader
      Provides an implementation of the readProductNodes interface method. Clients implementing this method can be sure that the input object and eventually the subset information has already been set.

      This method is called as a last step in the readProductNodes(input, subsetInfo) method.

      Specified by:
      readProductNodesImpl in class AbstractProductReader
      Returns:
      a new product instance
      Throws:
      IOException - if an I/O error occurs
    • close

      public void close() throws IOException
      Closes the access to all currently opened resources such as file input streams and all resources of this children directly owned by this reader. Its primary use is to allow the garbage collector to perform a vanilla job.

      This method should be called only if it is for sure that this object instance will never be used again. The results of referencing an instance of this class after a call to close() are undefined.

      Overrides of this method should always call super.close(); after disposing this instance.

      Specified by:
      close in interface ProductReader
      Overrides:
      close in class AbstractProductReader
      Throws:
      IOException - if an I/O error occurs
    • addFlagCodingsToProduct

      protected void addFlagCodingsToProduct(Product target)
    • addIndexCodingsToProduct

      protected void addIndexCodingsToProduct(Product target)
    • addAttribString

      protected static void addAttribString(String name, String value, MetadataElement subsetElem)
    • cloneFlags

      protected void cloneFlags(FlagCoding sourceFlagCoding, FlagCoding destFlagCoding)
    • cloneIndexes

      protected void cloneIndexes(IndexCoding sourceFlagCoding, IndexCoding destFlagCoding)
    • addMetadataToProduct

      protected void addMetadataToProduct(Product product)
    • cloneMetadataElementsAndAttributes

      protected void cloneMetadataElementsAndAttributes(MetadataElement sourceRoot, MetadataElement destRoot, int level)
    • cloneMetadataElements

      protected void cloneMetadataElements(MetadataElement sourceRoot, MetadataElement destRoot, int level)
    • cloneMetadataAttributes

      protected void cloneMetadataAttributes(MetadataElement sourceRoot, MetadataElement destRoot)
    • isInstanceOfValidInputType

      protected boolean isInstanceOfValidInputType(Object input)
      Description copied from class: AbstractProductReader
      Checks if the given object is an instance of one of the valid input types for this product reader.
      Overrides:
      isInstanceOfValidInputType in class AbstractProductReader
      Parameters:
      input - the input object passed to AbstractProductReader.readProductNodes(Object, ProductSubsetDef)
      Returns:
      true if so
      See Also:
    • disposeBandMap

      protected void disposeBandMap()