org.geotools.image.io
Class TextImageReader.Spi

java.lang.Object
  javax.imageio.spi.IIOServiceProvider
      javax.imageio.spi.ImageReaderWriterSpi
          javax.imageio.spi.ImageReaderSpi
              org.geotools.image.io.TextImageReader.Spi

All Implemented Interfaces:

javax.imageio.spi.RegisterableService

Direct Known Subclasses:

TextMatrixImageReader.Spi, TextRecordImageReader.Spi

Enclosing class:

TextImageReader

public abstract static class TextImageReader.Spi

extends javax.imageio.spi.ImageReaderSpi

Service provider interface (SPI) for TextImageReaders. This SPI provides a convenient way to control the TextImageReader character encoding: the charset field. For example, many subclasses will put the following line in their constructor:

 charset = Charset.forName("ISO-LATIN-1"); // ISO Latin Alphabet No. 1 (ISO-8859-1)
 

Version:

1.0

Author:

Martin Desruisseaux

Field Summary

protected java.nio.charset.Charset	charset Encodage des caract?res ? lire, ou pour utiliser l'encodage par d?faut de la plateforme locale.
protected java.util.Locale	locale Conventions locales ? utiliser pour lire les nombres.
protected double	padValue Valeur par d?faut repr?sentant les donn?es manquantes, ou Double.NaN s'il n'y en a pas.

Fields inherited from class javax.imageio.spi.ImageReaderSpi

inputTypes, STANDARD_INPUT_TYPE, writerSpiNames

Fields inherited from class javax.imageio.spi.ImageReaderWriterSpi

extraImageMetadataFormatClassNames, extraImageMetadataFormatNames, extraStreamMetadataFormatClassNames, extraStreamMetadataFormatNames, MIMETypes, names, nativeImageMetadataFormatClassName, nativeImageMetadataFormatName, nativeStreamMetadataFormatClassName, nativeStreamMetadataFormatName, pluginClassName, suffixes, supportsStandardImageMetadataFormat, supportsStandardStreamMetadataFormat

Fields inherited from class javax.imageio.spi.IIOServiceProvider

vendorName, version

Constructor Summary

TextImageReader.Spi(java.lang.String name, java.lang.String mime)
Construct a new SPI for TextImageReader.

Method Summary

boolean	canDecodeInput(java.lang.Object source) V?rifie si le flot sp?cifi? semble ?tre un fichier ASCII lisible.
boolean	canDecodeInput(java.lang.Object source, int readAheadLimit) V?rifie si le flot sp?cifi? semble ?tre un fichier ASCII lisible.
protected java.lang.Boolean	canDecodeLine(java.lang.String line) V?rifie si la ligne sp?cifi?e peut ?tre d?cod?e.

Methods inherited from class javax.imageio.spi.ImageReaderSpi

createReaderInstance, createReaderInstance, getImageWriterSpiNames, getInputTypes, isOwnReader

Methods inherited from class javax.imageio.spi.ImageReaderWriterSpi

getExtraImageMetadataFormatNames, getExtraStreamMetadataFormatNames, getFileSuffixes, getFormatNames, getImageMetadataFormat, getMIMETypes, getNativeImageMetadataFormatName, getNativeStreamMetadataFormatName, getPluginClassName, getStreamMetadataFormat, isStandardImageMetadataFormatSupported, isStandardStreamMetadataFormatSupported

Methods inherited from class javax.imageio.spi.IIOServiceProvider

getDescription, getVendorName, getVersion, onDeregistration, onRegistration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

charset

protected java.nio.charset.Charset charset

Encodage des caract?res ? lire, ou pour utiliser l'encodage par d?faut de la plateforme locale. Ce champ est initialement nul et devrait ?tre initialis? par les classes d?riv?es qui souhaite utiliser un encodage sp?cifique.

See Also:

TextImageReader.getCharset(java.io.InputStream)

locale

protected java.util.Locale locale

Conventions locales ? utiliser pour lire les nombres. Par exemple la valeur Locale.US signifie que les nombres seront ?crits en utilisant le point comme s?parateur d?cimal (entre autres conventions). La valeur signifie qu'il faudra utiliser les conventions locales par d?faut au moment ou une image sera lue.

See Also:

TextImageReader.getLineFormat(int), TextRecordImageReader.parseLine(java.lang.String, double[])

padValue

protected double padValue

Valeur par d?faut repr?sentant les donn?es manquantes, ou Double.NaN s'il n'y en a pas. Lors de la lecture d'une image, toutes les occurences de cette valeur seront remplac?es par Double.NaN dans toutes les colonnes sauf les colonnes des x et des y.

See Also:

TextImageReader.getPadValue(int), TextRecordImageReader.parseLine(java.lang.String, double[])

Constructor Detail

TextImageReader.Spi

public TextImageReader.Spi(java.lang.String name,
                           java.lang.String mime)

Construct a new SPI for TextImageReader. This constructor initialize the following fields to default values:

• Image format names (ImageReaderWriterSpi.names): An array of lenght 1 containing the argument.
• MIME type (ImageReaderWriterSpi.MIMETypes): An array of length 1 containing the argument.
• File suffixes (ImageReaderWriterSpi.suffixes): "", "" et "" (uppercase and lowercase).
• Input types (ImageReaderSpi.inputTypes): File, URL, Reader, InputStream et ImageInputStream.

Others fields should be set by subclasses (usually in their constructors).

Parameters:

name - Format name, or to let ImageReaderWriterSpi.names unset.

mime - MIME type, or to let ImageReaderWriterSpi.MIMETypes unset.

Method Detail

canDecodeInput

public boolean canDecodeInput(java.lang.Object source)
                       throws java.io.IOException

V?rifie si le flot sp?cifi? semble ?tre un fichier ASCII lisible. Cette m?thode tente simplement de lire les premi?res lignes du fichier. La valeur retourn?e par cette m?thode n'est qu'? titre indicative. n'implique pas que la lecture va forc?ment r?ussir, et n'implique pas que la lecture va obligatoirement ?chouer.

Parameters:

source - Source dont on veut tester la lisibilit?.

Returns:

si la source semble ?tre lisible.

Throws:

java.io.IOException - si une erreur est survenue lors de la lecture.

canDecodeInput

public boolean canDecodeInput(java.lang.Object source,
                              int readAheadLimit)
                       throws java.io.IOException

V?rifie si le flot sp?cifi? semble ?tre un fichier ASCII lisible. Cette m?thode tente simplement de lire les premi?res lignes du fichier. La valeur retourn?e par cette m?thode n'est qu'? titre indicative. n'implique pas que la lecture va forc?ment r?ussir, et n'implique pas que la lecture va obligatoirement ?chouer.

Parameters:

source - Source dont on veut tester la lisibilit?.

readAheadLimit - Nombre maximal de caract?res ? lire. Si ce nombre est d?pass? sans que cette m?thode ait pu d?terminer si la source est lisible ou pas, alors cette m?thode retourne .

Returns:

si la source semble ?tre lisible.

Throws:

java.io.IOException - si une erreur est survenue lors de la lecture.

canDecodeLine

protected java.lang.Boolean canDecodeLine(java.lang.String line)

V?rifie si la ligne sp?cifi?e peut ?tre d?cod?e. Cette m?thode est appel?e automatiquement par canDecodeInput(Object,int) avec en argument une des premi?res lignes trouv?es dans la source. L'impl?mentation par d?faut v?rifie si la ligne contient au moins un nombre d?cimal.

Parameters:

line - Une des premi?res lignes du flot ? lire.

Returns:

Boolean.TRUE si la ligne peut ?tre d?cod?e, Boolean.FALSE si elle ne peut pas ?tre d?cod?e ou si on ne sait pas encore. Dans ce dernier cas, cette m?thode sera appel?e une nouvelle fois avec la ligne suivante en argument.