|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.imageio.ImageWriter
org.geotools.image.io.GeographicImageWriter
org.geotools.image.io.StreamImageWriter
org.geotools.image.io.text.TextImageWriter
public abstract class TextImageWriter
Base class for text image encoders. "Text images" are usually ASCII files containing pixel values (often geophysical values, like sea level anomalies).
Nested Class Summary | |
---|---|
static class |
TextImageWriter.Spi
Service provider interface (SPI) for TextImageWriter s. |
Field Summary |
---|
Fields inherited from class org.geotools.image.io.StreamImageWriter |
---|
closeOnReset |
Fields inherited from class javax.imageio.ImageWriter |
---|
availableLocales, locale, originatingProvider, output, progressListeners, warningListeners, warningLocales |
Constructor Summary | |
---|---|
protected |
TextImageWriter(javax.imageio.spi.ImageWriterSpi provider)
Constructs a TextImageWriter . |
Method Summary | |
---|---|
protected void |
close()
Closes the writer created by #getWriter() . |
protected java.text.NumberFormat |
createNumberFormat(javax.imageio.IIOImage image,
javax.imageio.ImageWriteParam parameters)
Returns a number format to be used for formatting the sample values in the given image. |
protected java.nio.charset.Charset |
getCharset(javax.imageio.ImageWriteParam parameters)
Returns the character set to use for encoding the string to the output stream. |
protected java.util.Locale |
getDataLocale(javax.imageio.ImageWriteParam parameters)
Returns the locale to use for encoding values, or null for the
default. |
protected java.text.FieldPosition |
getExpectedFractionPosition(java.text.NumberFormat format)
Returns the expected position of the fraction part for numbers to be formatted using the given format. |
protected java.lang.String |
getLineSeparator(javax.imageio.ImageWriteParam parameters)
Returns the line separator to use when writing to the output stream. |
protected java.io.BufferedWriter |
getWriter(javax.imageio.ImageWriteParam parameters)
Returns the output as an buffered writer. |
Methods inherited from class org.geotools.image.io.StreamImageWriter |
---|
dispose, finalize, getOutputStream, reset, setOutput |
Methods inherited from class org.geotools.image.io.GeographicImageWriter |
---|
canWriteRasters, computeSize, convertImageMetadata, convertStreamMetadata, createRectIter, getDefaultImageMetadata, getDefaultStreamMetadata, processImageComplete, processImageStarted, processThumbnailComplete, processThumbnailStarted, processWarningOccurred, processWarningOccurred, warningOccurred |
Methods inherited from class javax.imageio.ImageWriter |
---|
abort, abortRequested, addIIOWriteProgressListener, addIIOWriteWarningListener, canInsertEmpty, canInsertImage, canRemoveImage, canReplaceImageMetadata, canReplacePixels, canReplaceStreamMetadata, canWriteEmpty, canWriteSequence, clearAbortRequest, endInsertEmpty, endReplacePixels, endWriteEmpty, endWriteSequence, getAvailableLocales, getDefaultWriteParam, getLocale, getNumThumbnailsSupported, getOriginatingProvider, getOutput, getPreferredThumbnailSizes, prepareInsertEmpty, prepareReplacePixels, prepareWriteEmpty, prepareWriteSequence, processImageProgress, processImageStarted, processThumbnailProgress, processThumbnailStarted, processWarningOccurred, processWarningOccurred, processWriteAborted, removeAllIIOWriteProgressListeners, removeAllIIOWriteWarningListeners, removeIIOWriteProgressListener, removeIIOWriteWarningListener, removeImage, replaceImageMetadata, replacePixels, replacePixels, replaceStreamMetadata, setLocale, write, write, write, writeInsert, writeToSequence |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected TextImageWriter(javax.imageio.spi.ImageWriterSpi provider)
TextImageWriter
.
originatingProvider
- The ImageWriterSpi
that
is constructing this object, or null
.Method Detail |
---|
protected java.util.Locale getDataLocale(javax.imageio.ImageWriteParam parameters)
null
for the
default. The default implementation returns the
locale specified to the TextImageWriter.Spi
object given to this
TextImageWriter
constructor. Subclasses can override this method if they
want to specify the data locale in some other way.
Note: This locale should not be confused with ImageWriter.getLocale()
.
parameters
- The write parameters, or null
for the defaults.
TextImageWriter.Spi.locale
protected java.nio.charset.Charset getCharset(javax.imageio.ImageWriteParam parameters) throws java.io.IOException
TextImageWriter.Spi
object given to this TextImageWriter
constructor.
Subclasses can override this method if they want to specify the character encoding in
some other way.
parameters
- The write parameters, or null
for the defaults.
null
for the platform default encoding.
java.io.IOException
- If reading from the output stream failed.TextImageWriter.Spi.charset
protected java.lang.String getLineSeparator(javax.imageio.ImageWriteParam parameters)
TextImageWriter.Spi
object given to this TextImageWriter
constructor. Subclasses
can override this method if they want to specify the line separator in some other way.
parameters
- The write parameters, or null
for the defaults.
TextImageWriter.Spi.lineSeparator
protected java.io.BufferedWriter getWriter(javax.imageio.ImageWriteParam parameters) throws java.lang.IllegalStateException, java.io.IOException
File
, URL
, URLConnection
, Writer
,
OutputStream
and ImageOutputStream
.
This method creates a new writer only when first invoked.
All subsequent calls will returns the same instance. Consequently, the returned writer
should never be closed by the caller. It may be closed automatically
when setOutput(Object)
, reset()
or dispose()
methods are invoked.
parameters
- The write parameters, or null
for the defaults.
ImageWriter.getOutput()
as a BufferedWriter
.
java.lang.IllegalStateException
- if the output is not set.
java.io.IOException
- If the output stream can't be created for an other reason.ImageWriter.getOutput()
,
StreamImageWriter.getOutputStream()
protected java.text.NumberFormat createNumberFormat(javax.imageio.IIOImage image, javax.imageio.ImageWriteParam parameters)
image
- The image or raster to be written.parameters
- The write parameters, or null
if the whole image will be written.
protected java.text.FieldPosition getExpectedFractionPosition(java.text.NumberFormat format)
createNumberFormat(javax.imageio.IIOImage, javax.imageio.ImageWriteParam)
, but the
given format doesn't need to be the instance returned by the later.
format
- The format to be used for formatting numbers.
protected void close() throws java.io.IOException
#getWriter()
. This method does nothing if
the writer is the output instance given by the user rather
than a writer created by this class from a File
or URL
output.
close
in class StreamImageWriter
java.io.IOException
- if an error occured while closing the stream.StreamImageWriter.closeOnReset
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |