|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectAbstractGridFormat
public abstract class AbstractGridFormat
AbstractGridFormat is a convenience class so subclasses only need to populate
a Map class and set the read and write parameter fields.
For example the ArcGridFormat has the following method which sets up all the
required information: private void setInfo(){ HashMap info=new
HashMap(); info.put("name", "ArcGrid"); info.put("description", "Arc Grid
Coverage Format"); info.put("vendor", "Geotools"); info.put("docURL",
"http://gdal.velocet.ca/projects/aigrid/index.html"); info.put("version",
"1.0"); mInfo=info; readParameters=new GeneralParameterDescriptor[2];
readParameters[0]=ArcGridOperationParameter.getGRASSReadParam();
readParameters[0]=ArcGridOperationParameter.getCompressReadParam();
writeParameters=new GeneralParameterDescriptor[2];
writeParameters[0]=ArcGridOperationParameter.getGRASSWriteParam();
writeParameters[0]=ArcGridOperationParameter.getCompressWriteParam();
}
Field Summary | |
---|---|
static ParameterDescriptor<Color> |
BACKGROUND_COLOR
Control the background color to be used where the input was transparent |
static ParameterDescriptor<DecimationPolicy> |
DECIMATION_POLICY
This GeneralParameterValue can be provided to the
GridCoverageReader s through the
GridCoverageReader.read(GeneralParameterValue[]) method in order
to specify the policy a reader should adopt when setting read parameters
when evaluating a needed resolution. |
static ParameterDescriptor<List> |
ELEVATION
Optional Elevation value for this mosaic. |
static DefaultParameterDescriptor<GeoToolsWriteParams> |
GEOTOOLS_WRITE_PARAMS
This GeneralParameterValue cacn be provided to the
GridCoverageWriter s through the
GridCoverageWriter.write(org.opengis.coverage.grid.GridCoverage, GeneralParameterValue[])
method in order to control the writing process in terms of compression,
tiling, etc.GridGeometry2D |
static ParameterDescriptor<Color> |
INPUT_TRANSPARENT_COLOR
Control the transparency of the input coverages. |
protected Map<String,String> |
mInfo
The Map object is used by the information methods(such as getName()) as a data source. |
static DefaultParameterDescriptor<OverviewPolicy> |
OVERVIEW_POLICY
This GeneralParameterValue can be provided to the
GridCoverageReader s through the
GridCoverageReader.read(GeneralParameterValue[]) method in order
to specify the policy a reader should adopt when choosing the right
overview during a read operation. |
static DefaultParameterDescriptor<ProgressListener> |
PROGRESS_LISTENER
This GeneralParameterValue can be provided to the
GridCoverageReader s through the
GridCoverageReader#write(GeneralParameterValue[]) method in order to monitor a writing process |
static DefaultParameterDescriptor<GridGeometry2D> |
READ_GRIDGEOMETRY2D
This GeneralParameterValue ccn be provided to the
GridCoverageReader s through the
GridCoverageReader.read(GeneralParameterValue[]) method in order
to pick up the best matching resolution level and (soon) the best
matching area. |
protected ParameterValueGroup |
readParameters
ParameterValueGroup that controls the reading process for a
GridCoverageReader through the
GridCoverageReader.read(org.opengis.parameter.GeneralParameterValue[])
method. |
static DefaultParameterDescriptor<String> |
SUGGESTED_TILE_SIZE
This GeneralParameterValue can be provided to the
GridCoverageReader s through the
GridCoverageReader.read(GeneralParameterValue[]) method in order
to specify the suggested size of tiles to avoid long time reading
occurring with JAI ImageRead on striped images. |
static String |
TILE_SIZE_SEPARATOR
|
static ParameterDescriptor<List> |
TIME
Optional Time value for this mosaic. |
static DefaultParameterDescriptor<Boolean> |
USE_JAI_IMAGEREAD
This GeneralParameterValue can be provided to the
GridCoverageReader s through the
GridCoverageReader.read(GeneralParameterValue[]) method in order
to specify the type of image read operation requested: using a JAI
ImageRead operation (leveraging on Deferred Execution Model,
Tile Caching,...), or the direct ImageReader 's read methods. |
protected ParameterValueGroup |
writeParameters
ParameterValueGroup that controls the writing process for a
GridCoverageWriter through the
GridCoverageWriter.write(org.opengis.coverage.grid.GridCoverage, org.opengis.parameter.GeneralParameterValue[])
method. |
Constructor Summary | |
---|---|
AbstractGridFormat()
|
Method Summary | |
---|---|
boolean |
accepts(Object source)
Tells me if this Format can read the provided input . |
abstract boolean |
accepts(Object source,
Hints hints)
Tells me if this Format can read the provided input . |
boolean |
equals(Format f)
|
static CoordinateReferenceSystem |
getDefaultCRS()
getDefaultCRS This method provides the user with a default crs WGS84 |
abstract GeoToolsWriteParams |
getDefaultImageIOWriteParameters()
Returns an instance of ImageWriteParam that can be used to
control a subsequent
GridCoverageWriter.write(org.opengis.coverage.grid.GridCoverage, org.opengis.parameter.GeneralParameterValue[]) ;
Be careful with using the ImageWriteParam since their usage is
still experimental. |
String |
getDescription()
Description of the file format. |
String |
getDocURL()
Documentation URL for the format. |
String |
getName()
Name of the file format. |
abstract AbstractGridCoverage2DReader |
getReader(Object source)
Gets a GridCoverageReader for this format able to create
coverages out of the source object. |
abstract AbstractGridCoverage2DReader |
getReader(Object source,
Hints hints)
Gets a GridCoverageReader for this format able to create
coverages out of the source object using the provided
hints . |
ParameterValueGroup |
getReadParameters()
Retrieve the parameter information for a read operation. |
String |
getVendor()
Vendor or agency for the format. |
String |
getVersion()
Version number of the format. |
ParameterValueGroup |
getWriteParameters()
Retrieve the parameter information for a write operation. |
abstract GridCoverageWriter |
getWriter(Object destination)
Retrieves a GridCoverageWriter suitable for writing to the
provided destination with this format. |
abstract GridCoverageWriter |
getWriter(Object destination,
Hints hints)
Call the accepts() method before asking for a writer to determine if the current object is supported. |
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected Map<String,String> mInfo
protected ParameterValueGroup readParameters
ParameterValueGroup
that controls the reading process for a
GridCoverageReader
through the
GridCoverageReader.read(org.opengis.parameter.GeneralParameterValue[])
method.
protected ParameterValueGroup writeParameters
ParameterValueGroup
that controls the writing process for a
GridCoverageWriter
through the
GridCoverageWriter.write(org.opengis.coverage.grid.GridCoverage, org.opengis.parameter.GeneralParameterValue[])
method.
public static final DefaultParameterDescriptor<GridGeometry2D> READ_GRIDGEOMETRY2D
GeneralParameterValue
ccn be provided to the
GridCoverageReader
s through the
GridCoverageReader.read(GeneralParameterValue[])
method in order
to pick up the best matching resolution level and (soon) the best
matching area.
public static final DefaultParameterDescriptor<ProgressListener> PROGRESS_LISTENER
GeneralParameterValue
can be provided to the
GridCoverageReader
s through the
GridCoverageReader#write(GeneralParameterValue[])
method in order to monitor a writing process
public static final DefaultParameterDescriptor<GeoToolsWriteParams> GEOTOOLS_WRITE_PARAMS
GeneralParameterValue
cacn be provided to the
GridCoverageWriter
s through the
GridCoverageWriter.write(org.opengis.coverage.grid.GridCoverage, GeneralParameterValue[])
method in order to control the writing process in terms of compression,
tiling, etc.GridGeometry2D
public static final DefaultParameterDescriptor<Boolean> USE_JAI_IMAGEREAD
GeneralParameterValue
can be provided to the
GridCoverageReader
s through the
GridCoverageReader.read(GeneralParameterValue[])
method in order
to specify the type of image read operation requested: using a JAI
ImageRead operation (leveraging on Deferred Execution Model,
Tile Caching,...), or the direct ImageReader
's read methods.
public static final DefaultParameterDescriptor<OverviewPolicy> OVERVIEW_POLICY
GeneralParameterValue
can be provided to the
GridCoverageReader
s through the
GridCoverageReader.read(GeneralParameterValue[])
method in order
to specify the policy a reader should adopt when choosing the right
overview during a read operation.
public static final ParameterDescriptor<DecimationPolicy> DECIMATION_POLICY
GeneralParameterValue
can be provided to the
GridCoverageReader
s through the
GridCoverageReader.read(GeneralParameterValue[])
method in order
to specify the policy a reader should adopt when setting read parameters
when evaluating a needed resolution.
public static final DefaultParameterDescriptor<String> SUGGESTED_TILE_SIZE
GeneralParameterValue
can be provided to the
GridCoverageReader
s through the
GridCoverageReader.read(GeneralParameterValue[])
method in order
to specify the suggested size of tiles to avoid long time reading
occurring with JAI ImageRead on striped images. (Images with tiles Nx1)
Value should be a String in the form of "W,H" (without quotes) where W is
a number representing the suggested tileWidth and H is a number
representing the suggested tileHeight.
public static final String TILE_SIZE_SEPARATOR
public static final ParameterDescriptor<Color> INPUT_TRANSPARENT_COLOR
public static final ParameterDescriptor<Color> BACKGROUND_COLOR
public static final ParameterDescriptor<List> TIME
public static final ParameterDescriptor<List> ELEVATION
Constructor Detail |
---|
public AbstractGridFormat()
Method Detail |
---|
public String getName()
Format
getName
in interface Format
Format.getName()
public String getDescription()
Format
null
.
getDescription
in interface Format
Format.getDescription()
public String getVendor()
Format
getVendor
in interface Format
Format.getVendor()
public String getDocURL()
Format
getDocURL
in interface Format
Format.getDocURL()
public String getVersion()
Format
getVersion
in interface Format
Format.getVersion()
public abstract AbstractGridCoverage2DReader getReader(Object source)
GridCoverageReader
for this format able to create
coverages out of the source
object.
In case this Format
cannot reader the provided
source
object null
is returned.
source
- The source object to parse.
Format
or null.public abstract AbstractGridCoverage2DReader getReader(Object source, Hints hints)
GridCoverageReader
for this format able to create
coverages out of the source
object using the provided
hints
.
In case this Format
cannot reader the provided
source
object null
is returned.
source
- The source object to parse. *hints
- The Hints
to use when trying to instantiate this
reader.
Format
or null.public abstract GridCoverageWriter getWriter(Object destination)
GridCoverageWriter
suitable for writing to the
provided destination
with this format.
In case no writers are availaible null
is returned.
destination
- The destinatin where to write.
GridCoverageWriter
suitable for writing to the provided
destination
with this format.public boolean accepts(Object source)
Format
can read the provided input
.
input
- The input object to test for suitability.
public abstract boolean accepts(Object source, Hints hints)
Format
can read the provided input
.
input
- The input object to test for suitability.hints
- Hints
to control the accepts internal machinery.
public boolean equals(Format f)
org.geotools.data.coverage.grid.Format#equals(org.geotools.data.coverage.grid.Format)
public ParameterValueGroup getReadParameters()
Format
read
operation.
getReadParameters
in interface Format
public ParameterValueGroup getWriteParameters()
Format
write
operation.
getWriteParameters
in interface Format
public static CoordinateReferenceSystem getDefaultCRS()
public abstract GeoToolsWriteParams getDefaultImageIOWriteParameters()
ImageWriteParam
that can be used to
control a subsequent
GridCoverageWriter.write(org.opengis.coverage.grid.GridCoverage, org.opengis.parameter.GeneralParameterValue[])
;
Be careful with using the ImageWriteParam
since their usage is
still experimental.
ImageWriteParam
.public abstract GridCoverageWriter getWriter(Object destination, Hints hints)
destination
- the destination object to write a WorldImage tohints
- Hints
to control the internal machinery.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |