Package org.geotools.coverageio.jp2k
Class JP2KFormat
Object
AbstractGridFormat
JP2KFormat
- All Implemented Interfaces:
Format
An implementation of
Format
for the JP2K format.- Author:
- Daniele Romagnoli, GeoSolutions, Simone Giannecchini (simboss), GeoSolutions
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final DefaultParameterDescriptor<Boolean>
ThisGeneralParameterValue
can be provided to theGridCoverageReader
s through theGridCoverageReader.read(GeneralParameterValue[])
method in order to specify to use multithreading when leveraging on a JAI ImageRead operation.Fields inherited from class AbstractGridFormat
BACKGROUND_COLOR, BANDS, DECIMATION_POLICY, ELEVATION, FOOTPRINT_BEHAVIOR, GEOTOOLS_WRITE_PARAMS, INPUT_TRANSPARENT_COLOR, INTERPOLATION, mInfo, OVERVIEW_POLICY, PROGRESS_LISTENER, READ_GRIDGEOMETRY2D, readParameters, RESCALE_PIXELS, SUGGESTED_TILE_SIZE, TILE_SIZE_SEPARATOR, TIME, USE_JAI_IMAGEREAD, writeParameters
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Tells me if thisFormat
can read the providedinput
.Returns an instance ofImageWriteParam
that can be used to control a subsequentGridCoverageWriter.write(org.geotools.api.coverage.grid.GridCoverage, org.geotools.api.parameter.GeneralParameterValue[])
;Gets aGridCoverageReader
for this format able to create coverages out of thesource
object.Gets aGridCoverageReader
for this format able to create coverages out of thesource
object using the providedhints
.Retrieves aGridCoverageWriter
suitable for writing to the provideddestination
with this format.Call the accepts() method before asking for a writer to determine if the current object is supported.protected void
setInfo()
Sets the metadata information.Methods inherited from class AbstractGridFormat
accepts, equals, getDefaultCRS, getDescription, getDocURL, getName, getReadParameters, getVendor, getVersion, getWriteParameters
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface Format
getDescription, getDocURL, getName, getReadParameters, getVendor, getVersion, getWriteParameters
-
Field Details
-
USE_MULTITHREADING
ThisGeneralParameterValue
can be provided to theGridCoverageReader
s through theGridCoverageReader.read(GeneralParameterValue[])
method in order to specify to use multithreading when leveraging on a JAI ImageRead operation. This will be achieved with the use of the ImageReadMT operation of the ImageIO-Ext.
-
-
Constructor Details
-
JP2KFormat
public JP2KFormat()Creates an instance and sets the metadata.
-
-
Method Details
-
setInfo
protected void setInfo()Sets the metadata information. -
getReader
Description copied from class:AbstractGridFormat
Gets aGridCoverageReader
for this format able to create coverages out of thesource
object using the providedhints
.In case this
Format
cannot reader the providedsource
objectnull
is returned.- Specified by:
getReader
in classAbstractGridFormat
- Parameters:
source
- The source object to parse. *hints
- TheHints
to use when trying to instantiate this reader.- Returns:
- A reader for this
Format
or null. - See Also:
-
org.geotools.data.coverage.grid.AbstractGridFormat#getReader(Object, Hints)
-
getReader
Description copied from class:AbstractGridFormat
Gets aGridCoverageReader
for this format able to create coverages out of thesource
object.In case this
Format
cannot reader the providedsource
objectnull
is returned.- Specified by:
getReader
in classAbstractGridFormat
- Parameters:
source
- The source object to parse.- Returns:
- A reader for this
Format
or null. - See Also:
-
org.geotools.data.coverage.grid.AbstractGridFormat#getReader(Object)
-
getWriter
Description copied from class:AbstractGridFormat
Retrieves aGridCoverageWriter
suitable for writing to the provideddestination
with this format.In case no writers are available
null
is returned.- Specified by:
getWriter
in classAbstractGridFormat
- Parameters:
destination
- The destinatin where to write.- Returns:
- A
GridCoverageWriter
suitable for writing to the provideddestination
with this format. - See Also:
-
Actually, the plugin does not support write capabilities. The method throws an
UnsupportedOperationException
.
-
getDefaultImageIOWriteParameters
Description copied from class:AbstractGridFormat
Returns an instance ofImageWriteParam
that can be used to control a subsequentGridCoverageWriter.write(org.geotools.api.coverage.grid.GridCoverage, org.geotools.api.parameter.GeneralParameterValue[])
;Be careful with using the
ImageWriteParam
since their usage is still experimental.- Specified by:
getDefaultImageIOWriteParameters
in classAbstractGridFormat
- Returns:
- an instance of
ImageWriteParam
. - See Also:
-
Actually, the plugin does not support write capabilities. The method throws an
UnsupportedOperationException
.
-
getWriter
Description copied from class:AbstractGridFormat
Call the accepts() method before asking for a writer to determine if the current object is supported.- Specified by:
getWriter
in classAbstractGridFormat
- Parameters:
destination
- the destination object to write a WorldImage tohints
-Hints
to control the internal machinery.- Returns:
- a new WorldImageWriter for the destination
- See Also:
-
Actually, the plugin does not support write capabilities. The method throws an
UnsupportedOperationException
.
-
accepts
Description copied from class:AbstractGridFormat
Tells me if thisFormat
can read the providedinput
.- Specified by:
accepts
in classAbstractGridFormat
- Parameters:
input
- The input object to test for suitability.hints
-Hints
to control the accepts internal machinery.- Returns:
- True if this format can read this object, False otherwise.
- See Also:
-
org.geotools.data.coverage.grid.AbstractGridFormat#accepts(java.lang.Object input)
-