| java.lang.Object
 javax.imageio.ImageWriter
org.geotools.image.io.GeographicImageWriter
All known Subclasses: org.geotools.image.io.StreamImageWriter,
| GeographicImageWriter | | abstract public class GeographicImageWriter extends ImageWriter (Code) | | Base class for writers of geographic images.
since:
2.4
version:
$Id: GeographicImageWriter.java 27862 2007-11-12 19:51:19Z desruisseaux $
author:
Martin Desruisseaux |
| Field Summary | |
| final static Logger | LOGGER
The logger to use for events related to this image writer. |
| Method Summary | |
| public boolean | canWriteRasters()
Returns true if the methods that take an
IIOImage parameter are capable of dealing
with a
Raster . | | void | close()
To be overriden and made
protected by
StreamImageWriter only. | | protected static ImageDimension | computeSize(IIOImage image, ImageWriteParam parameters)
Computes the size of the region to be read, taking subsampling in account.
Parameters:
image - The image or raster to be written.
Parameters:
parameters - The write parameters, or null if the whole image will be written. | | public IIOMetadata | convertImageMetadata(IIOMetadata inData, ImageTypeSpecifier imageType, ImageWriteParam param)
Returns a metadata object initialized to the specified data for encoding an image
of the given type. | | public IIOMetadata | convertStreamMetadata(IIOMetadata inData, ImageWriteParam param)
Returns a metadata object initialized to the specified data for encoding a stream
of images. | | protected static RectIter | createRectIter(IIOImage image, ImageWriteParam parameters)
Returns an iterator over the pixels of the specified image, taking subsampling in account.
Parameters:
image - The image or raster to be written.
Parameters:
parameters - The write parameters, or null if the whole image will be written. | | public IIOMetadata | getDefaultImageMetadata(ImageTypeSpecifier imageType, ImageWriteParam param)
Returns a metadata object containing default values for encoding an image of the given
type. | | public IIOMetadata | getDefaultStreamMetadata(ImageWriteParam param)
Returns a metadata object containing default values for encoding a stream of images.
The default implementation returns
null , which is appropriate for writer that
do not make use of stream meta-data.
Parameters:
param - Parameters that will be used to encode the image (in cases whereit may affect the structure of the metadata), or null . | | final IndexedResourceBundle | getErrorResources()
Returns the resources for formatting error messages. | | protected void | processImageComplete()
Broadcasts the completion of an image write to all registered listeners. | | protected void | processImageStarted()
Broadcasts the start of an image write to all registered listeners. | | protected void | processThumbnailComplete()
Broadcasts the completion of a thumbnail write to all registered listeners. | | protected void | processThumbnailStarted()
Broadcasts the start of a thumbnail write to all registered listeners. | | protected void | processWarningOccurred(String warning)
Broadcasts a warning message to all registered listeners. | | protected void | processWarningOccurred(String baseName, String keyword)
Broadcasts a warning message to all registered listeners. | | public void | setOutput(Object output)
Sets the output. | | public void | warningOccurred(LogRecord record)
Invoked when a warning occured. |
| LOGGER | | final static Logger LOGGER(Code) | | The logger to use for events related to this image writer.
|
| GeographicImageWriter | | protected GeographicImageWriter(ImageWriterSpi provider)(Code) | | Constructs a
GeographicImageWriter .
Parameters:
originatingProvider - The ImageWriterSpi thatis constructing this object, or null . |
| canWriteRasters | | public boolean canWriteRasters()(Code) | | Returns true if the methods that take an
IIOImage parameter are capable of dealing
with a
Raster . The default implementation returns
true since it is assumed
that subclasses will fetch pixels using the iterator returned by
GeographicImageWriter.createRectItercreateRectIter .
|
| computeSize | | protected static ImageDimension computeSize(IIOImage image, ImageWriteParam parameters)(Code) | | Computes the size of the region to be read, taking subsampling in account.
Parameters:
image - The image or raster to be written.
Parameters:
parameters - The write parameters, or null if the whole image will be written. dimension The dimension of the image to be written. |
| convertImageMetadata | | public IIOMetadata convertImageMetadata(IIOMetadata inData, ImageTypeSpecifier imageType, ImageWriteParam param)(Code) | | Returns a metadata object initialized to the specified data for encoding an image
of the given type. The default implementation copies the specified data into a
.
Parameters:
inData - Image metadata used to initialize the state of the returned object.
Parameters:
imageType - The format of the image to be written later.
Parameters:
param - Parameters that will be used to encode the image (in cases whereit may affect the structure of the metadata), or null . The metadata, or null . |
| convertStreamMetadata | | public IIOMetadata convertStreamMetadata(IIOMetadata inData, ImageWriteParam param)(Code) | | Returns a metadata object initialized to the specified data for encoding a stream
of images. The default implementation copies the specified data into a
.
Parameters:
inData - Stream metadata used to initialize the state of the returned object.
Parameters:
param - Parameters that will be used to encode the image (in cases whereit may affect the structure of the metadata), or null . The metadata, or null . |
| createRectIter | | protected static RectIter createRectIter(IIOImage image, ImageWriteParam parameters)(Code) | | Returns an iterator over the pixels of the specified image, taking subsampling in account.
Parameters:
image - The image or raster to be written.
Parameters:
parameters - The write parameters, or null if the whole image will be written. An iterator over the pixel values of the image to be written. |
| getDefaultImageMetadata | | public IIOMetadata getDefaultImageMetadata(ImageTypeSpecifier imageType, ImageWriteParam param)(Code) | | Returns a metadata object containing default values for encoding an image of the given
type. The default implementation returns
null , which is appropriate for writer
that do not make use of image meta-data.
Parameters:
imageType - The format of the image to be written later.
Parameters:
param - Parameters that will be used to encode the image (in cases whereit may affect the structure of the metadata), or null . The metadata, or null . |
| getDefaultStreamMetadata | | public IIOMetadata getDefaultStreamMetadata(ImageWriteParam param)(Code) | | Returns a metadata object containing default values for encoding a stream of images.
The default implementation returns
null , which is appropriate for writer that
do not make use of stream meta-data.
Parameters:
param - Parameters that will be used to encode the image (in cases whereit may affect the structure of the metadata), or null . The metadata, or null . |
| processImageComplete | | protected void processImageComplete()(Code) | | Broadcasts the completion of an image write to all registered listeners.
|
| processImageStarted | | protected void processImageStarted()(Code) | | Broadcasts the start of an image write to all registered listeners. The default
implementation invokes the
with an image index maintained by this writer.
|
| processThumbnailComplete | | protected void processThumbnailComplete()(Code) | | Broadcasts the completion of a thumbnail write to all registered listeners.
|
| processThumbnailStarted | | protected void processThumbnailStarted()(Code) | | Broadcasts the start of a thumbnail write to all registered listeners. The default
implementation invokes the
with an image and thumbnail index maintained by this writer.
|
| processWarningOccurred | | protected void processWarningOccurred(String warning)(Code) | | Broadcasts a warning message to all registered listeners. The default implementation
invokes the
with
an image index maintained by this writer.
|
| processWarningOccurred | | protected void processWarningOccurred(String baseName, String keyword)(Code) | | Broadcasts a warning message to all registered listeners. The default implementation
invokes the
with an image index maintained by this writer.
|
| setOutput | | public void setOutput(Object output)(Code) | | Sets the output.
|
| warningOccurred | | public void warningOccurred(LogRecord record)(Code) | | Invoked when a warning occured. The default implementation make the following choice:
- If at least one
has been
, then the
IIOWriteWarningListener.warningOccurred warningOccurred method is
invoked for each of them and the log record is not logged.
- Otherwise, the log record is sent to the
"org.geotools.image.io" logger.
Subclasses may override this method if more processing is wanted, or for
throwing exception if some warnings should be considered as fatal errors.
|
| Methods inherited from javax.imageio.ImageWriter | public synchronized void abort()(Code)(Java Doc)
protected synchronized boolean abortRequested()(Code)(Java Doc)
public void addIIOWriteProgressListener(IIOWriteProgressListener listener)(Code)(Java Doc)
public void addIIOWriteWarningListener(IIOWriteWarningListener listener)(Code)(Java Doc)
public boolean canInsertEmpty(int imageIndex) throws IOException(Code)(Java Doc)
public boolean canInsertImage(int imageIndex) throws IOException(Code)(Java Doc)
public boolean canRemoveImage(int imageIndex) throws IOException(Code)(Java Doc)
public boolean canReplaceImageMetadata(int imageIndex) throws IOException(Code)(Java Doc)
public boolean canReplacePixels(int imageIndex) throws IOException(Code)(Java Doc)
public boolean canReplaceStreamMetadata() throws IOException(Code)(Java Doc)
public boolean canWriteEmpty() throws IOException(Code)(Java Doc)
public boolean canWriteRasters()(Code)(Java Doc)
public boolean canWriteSequence()(Code)(Java Doc)
protected synchronized void clearAbortRequest()(Code)(Java Doc)
abstract public IIOMetadata convertImageMetadata(IIOMetadata inData, ImageTypeSpecifier imageType, ImageWriteParam param)(Code)(Java Doc)
abstract public IIOMetadata convertStreamMetadata(IIOMetadata inData, ImageWriteParam param)(Code)(Java Doc)
public void dispose()(Code)(Java Doc)
public void endInsertEmpty() throws IOException(Code)(Java Doc)
public void endReplacePixels() throws IOException(Code)(Java Doc)
public void endWriteEmpty() throws IOException(Code)(Java Doc)
public void endWriteSequence() throws IOException(Code)(Java Doc)
public Locale[] getAvailableLocales()(Code)(Java Doc)
abstract public IIOMetadata getDefaultImageMetadata(ImageTypeSpecifier imageType, ImageWriteParam param)(Code)(Java Doc)
abstract public IIOMetadata getDefaultStreamMetadata(ImageWriteParam param)(Code)(Java Doc)
public ImageWriteParam getDefaultWriteParam()(Code)(Java Doc)
public Locale getLocale()(Code)(Java Doc)
public int getNumThumbnailsSupported(ImageTypeSpecifier imageType, ImageWriteParam param, IIOMetadata streamMetadata, IIOMetadata imageMetadata)(Code)(Java Doc)
public ImageWriterSpi getOriginatingProvider()(Code)(Java Doc)
public Object getOutput()(Code)(Java Doc)
public Dimension[] getPreferredThumbnailSizes(ImageTypeSpecifier imageType, ImageWriteParam param, IIOMetadata streamMetadata, IIOMetadata imageMetadata)(Code)(Java Doc)
public void prepareInsertEmpty(int imageIndex, ImageTypeSpecifier imageType, int width, int height, IIOMetadata imageMetadata, List<? extends BufferedImage> thumbnails, ImageWriteParam param) throws IOException(Code)(Java Doc)
public void prepareReplacePixels(int imageIndex, Rectangle region) throws IOException(Code)(Java Doc)
public void prepareWriteEmpty(IIOMetadata streamMetadata, ImageTypeSpecifier imageType, int width, int height, IIOMetadata imageMetadata, List<? extends BufferedImage> thumbnails, ImageWriteParam param) throws IOException(Code)(Java Doc)
public void prepareWriteSequence(IIOMetadata streamMetadata) throws IOException(Code)(Java Doc)
protected void processImageComplete()(Code)(Java Doc)
protected void processImageProgress(float percentageDone)(Code)(Java Doc)
protected void processImageStarted(int imageIndex)(Code)(Java Doc)
protected void processThumbnailComplete()(Code)(Java Doc)
protected void processThumbnailProgress(float percentageDone)(Code)(Java Doc)
protected void processThumbnailStarted(int imageIndex, int thumbnailIndex)(Code)(Java Doc)
protected void processWarningOccurred(int imageIndex, String warning)(Code)(Java Doc)
protected void processWarningOccurred(int imageIndex, String baseName, String keyword)(Code)(Java Doc)
protected void processWriteAborted()(Code)(Java Doc)
public void removeAllIIOWriteProgressListeners()(Code)(Java Doc)
public void removeAllIIOWriteWarningListeners()(Code)(Java Doc)
public void removeIIOWriteProgressListener(IIOWriteProgressListener listener)(Code)(Java Doc)
public void removeIIOWriteWarningListener(IIOWriteWarningListener listener)(Code)(Java Doc)
public void removeImage(int imageIndex) throws IOException(Code)(Java Doc)
public void replaceImageMetadata(int imageIndex, IIOMetadata imageMetadata) throws IOException(Code)(Java Doc)
public void replacePixels(RenderedImage image, ImageWriteParam param) throws IOException(Code)(Java Doc)
public void replacePixels(Raster raster, ImageWriteParam param) throws IOException(Code)(Java Doc)
public void replaceStreamMetadata(IIOMetadata streamMetadata) throws IOException(Code)(Java Doc)
public void reset()(Code)(Java Doc)
public void setLocale(Locale locale)(Code)(Java Doc)
public void setOutput(Object output)(Code)(Java Doc)
abstract public void write(IIOMetadata streamMetadata, IIOImage image, ImageWriteParam param) throws IOException(Code)(Java Doc)
public void write(IIOImage image) throws IOException(Code)(Java Doc)
public void write(RenderedImage image) throws IOException(Code)(Java Doc)
public void writeInsert(int imageIndex, IIOImage image, ImageWriteParam param) throws IOException(Code)(Java Doc)
public void writeToSequence(IIOImage image, ImageWriteParam param) throws IOException(Code)(Java Doc)
|
|
|