org.geotools.image.io.mosaic
Class MosaicImageWriteParam

java.lang.Object
  extended by javax.imageio.IIOParam
      extended by javax.imageio.ImageWriteParam
          extended by org.geotools.image.io.mosaic.MosaicImageWriteParam

public class MosaicImageWriteParam
extends javax.imageio.ImageWriteParam

The parameters for MosaicImageWriter.

Since:
2.5
Version:
$Id: MosaicImageWriteParam.java 30729 2008-06-16 09:26:48Z desruisseaux $
Author:
Martin Desruisseaux

Field Summary
 
Fields inherited from class javax.imageio.ImageWriteParam
canOffsetTiles, canWriteCompressed, canWriteProgressive, canWriteTiles, compressionMode, compressionQuality, compressionType, compressionTypes, locale, MODE_COPY_FROM_METADATA, MODE_DEFAULT, MODE_DISABLED, MODE_EXPLICIT, preferredTileSizes, progressiveMode, tileGridXOffset, tileGridYOffset, tileHeight, tileWidth, tilingMode, tilingSet
 
Fields inherited from class javax.imageio.IIOParam
controller, defaultController, destinationOffset, destinationType, sourceBands, sourceRegion, sourceXSubsampling, sourceYSubsampling, subsamplingXOffset, subsamplingYOffset
 
Constructor Summary
MosaicImageWriteParam()
          Constructs an empty set of parameters.
 
Method Summary
 int getOutputIndex()
          Returns the index of the image to be written.
 TileWritingPolicy getTileWritingPolicy()
          Returns whatever existings files should be skipped or overwritten.
 void setOutputIndex(int index)
          Sets the index of the image to be written.
 void setTileWritingPolicy(TileWritingPolicy policy)
          Sets whatever existings files should be skipped.
 
Methods inherited from class javax.imageio.ImageWriteParam
canOffsetTiles, canWriteCompressed, canWriteProgressive, canWriteTiles, getBitRate, getCompressionMode, getCompressionQuality, getCompressionQualityDescriptions, getCompressionQualityValues, getCompressionType, getCompressionTypes, getLocale, getLocalizedCompressionTypeName, getPreferredTileSizes, getProgressiveMode, getTileGridXOffset, getTileGridYOffset, getTileHeight, getTileWidth, getTilingMode, isCompressionLossless, setCompressionMode, setCompressionQuality, setCompressionType, setProgressiveMode, setTiling, setTilingMode, unsetCompression, unsetTiling
 
Methods inherited from class javax.imageio.IIOParam
activateController, getController, getDefaultController, getDestinationOffset, getDestinationType, getSourceBands, getSourceRegion, getSourceXSubsampling, getSourceYSubsampling, getSubsamplingXOffset, getSubsamplingYOffset, hasController, setController, setDestinationOffset, setDestinationType, setSourceBands, setSourceRegion, setSourceSubsampling
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MosaicImageWriteParam

public MosaicImageWriteParam()
Constructs an empty set of parameters.

Method Detail

getOutputIndex

public int getOutputIndex()
Returns the index of the image to be written. This is the index of the tile manager to use in the array returned by MosaicImageWriter.getOutput(). The default value is 0.

Returns:
The index of the image to be written.

setOutputIndex

public void setOutputIndex(int index)
Sets the index of the image to be written. This is the index of the tile manager to use in the array returned by MosaicImageWriter.getOutput(). The default value is 0.

Parameters:
index - The index of the image to be written.

getTileWritingPolicy

public TileWritingPolicy getTileWritingPolicy()
Returns whatever existings files should be skipped or overwritten. The default value is OVERWRITE.

Returns:
The policy to apply when writting tiles.

setTileWritingPolicy

public void setTileWritingPolicy(TileWritingPolicy policy)
Sets whatever existings files should be skipped. The default behavior is to overwrite every files inconditionnaly. Settings the policy to WRITE_NEWS_ONLY may speedup MosaicImageWriter when the process of writting tiles is started again after a previous partial failure, by skipping the tiles that were successfully generated in the previous run.

Parameters:
policy - The policy to apply when writting tiles.


Copyright © 1996-2010 Geotools. All Rights Reserved.