| java.lang.Object
 org.geotools.coverage.grid.io.AbstractGridFormat
All known Subclasses: org.geotools.gce.imagepyramid.ImagePyramidFormat, org.geotools.arcsde.gce.ArcSDERasterFormat, org.geotools.gce.mrsid.MrSIDFormat, org.geotools.gce.image.WorldImageFormat, org.geotools.gce.imagemosaic.ImageMosaicFormat, org.geotools.gce.gtopo30.GTopo30Format, org.geotools.gce.geotiff.GeoTiffFormat, org.geotools.gce.arcgrid.ArcGridFormat, org.geotools.gce.ecw.ECWFormat, org.geotools.coverage.grid.io.UnknownFormat,
| AbstractGridFormat | | abstract public class AbstractGridFormat implements Format(Code) | | 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();
}
author:
jeichar
author:
Simone Giannecchini |
| Field Summary | |
| final public static DefaultParameterDescriptor | GEOTOOLS_WRITE_PARAMS
This
GeneralParameterValue cacn be provided to the
GridCoverageWriter s through the
GridCoverageWriter.write(org.opengis.coverage.grid.GridCoverageGeneralParameterValue[]) method in order to control the writing process in terms of compression,
tiling, etc. | | final public static DefaultParameterDescriptor | READ_GRIDGEOMETRY2D
This
GeneralParameterValue cacn be provided to the
GridCoverageReader s through the
GridCoverageReader.read(GeneralParameterValue[]) methid in order
to pick up the best matching resolution level and (soon) the best
matching area. | | final public static DefaultParameterDescriptor | 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 Map | mInfo
The Map object is used by the information methods(such as getName()) as a
data source. | | 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.GridCoverageorg.opengis.parameter.GeneralParameterValue[]) method. |
| Method Summary | |
| abstract public boolean | accepts(Object input)
Tells me if this
Format can read the provided input.
Parameters:
input - The input object to test for suitablilty. | | public boolean | equals(Format f)
| | public static CoordinateReferenceSystem | getDefaultCRS()
| | abstract public GeoToolsWriteParams | getDefaultImageIOWriteParameters()
Returns an instance of
ImageWriteParam that can be used to
control a subsequent
GridCoverageWriter.write(org.opengis.coverage.grid.GridCoverageorg.opengis.parameter.GeneralParameterValue[]) ;
Be careful with using the
ImageWriteParam since their usage is
still experimental. | | public String | getDescription()
| | public String | getDocURL()
| | public String | getName()
| | public ParameterValueGroup | getReadParameters()
| | abstract public GridCoverageReader | getReader(Object source)
Gets a
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.
Parameters:
source - The source object to parse. | | abstract public GridCoverageReader | getReader(Object source, Hints hints)
Gets a
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.
Parameters:
source - The source object to parse. | | public String | getVendor()
| | public String | getVersion()
| | public ParameterValueGroup | getWriteParameters()
| | abstract public GridCoverageWriter | getWriter(Object destination)
Retrieves a
GridCoverageWriter suitable for writing to the
provided destination with this format.
In case no writers are availaible null is returned.
Parameters:
destination - The destinatin where to write. |
| GEOTOOLS_WRITE_PARAMS | | final public static DefaultParameterDescriptor GEOTOOLS_WRITE_PARAMS(Code) | | This
GeneralParameterValue cacn be provided to the
GridCoverageWriter s through the
GridCoverageWriter.write(org.opengis.coverage.grid.GridCoverageGeneralParameterValue[]) method in order to control the writing process in terms of compression,
tiling, etc.
|
| READ_GRIDGEOMETRY2D | | final public static DefaultParameterDescriptor READ_GRIDGEOMETRY2D(Code) | | This
GeneralParameterValue cacn be provided to the
GridCoverageReader s through the
GridCoverageReader.read(GeneralParameterValue[]) methid in order
to pick up the best matching resolution level and (soon) the best
matching area.
|
| USE_JAI_IMAGEREAD | | final public static DefaultParameterDescriptor USE_JAI_IMAGEREAD(Code) | | 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.
|
| mInfo | | protected Map mInfo(Code) | | The Map object is used by the information methods(such as getName()) as a
data source. The keys in the Map object (for the associated method) are
as follows: getName() key = "name" value type=String getDescription() key =
"description" value type=String getVendor() key = "vendor" value
type=String getDocURL() key = "docURL" value type=String getVersion() key =
"version" value type=String Naturally, any methods that are overridden
need not have an entry in the Map
|
| readParameters | | protected ParameterValueGroup readParameters(Code) | | ParameterValueGroup that controls the reading process for a
GridCoverageReader through the
GridCoverageReader.read(org.opengis.parameter.GeneralParameterValue[]) method.
|
| writeParameters | | protected ParameterValueGroup writeParameters(Code) | | ParameterValueGroup that controls the writing process for a
GridCoverageWriter through the
GridCoverageWriter.write(org.opengis.coverage.grid.GridCoverageorg.opengis.parameter.GeneralParameterValue[]) method.
|
| accepts | | abstract public boolean accepts(Object input)(Code) | | Tells me if this
Format can read the provided input.
Parameters:
input - The input object to test for suitablilty. True if this format can read this object, False otherwise. |
| equals | | public boolean equals(Format f)(Code) | |
See Also: org.geotools.data.coverage.grid.Format.equals(org.geotools.data.coverage.grid.Format) |
| getDefaultCRS | | public static CoordinateReferenceSystem getDefaultCRS()(Code) | | getDefaultCRS
This method provides the user with a default crs WGS84
|
| getDefaultImageIOWriteParameters | | abstract public GeoToolsWriteParams getDefaultImageIOWriteParameters()(Code) | | Returns an instance of
ImageWriteParam that can be used to
control a subsequent
GridCoverageWriter.write(org.opengis.coverage.grid.GridCoverageorg.opengis.parameter.GeneralParameterValue[]) ;
Be careful with using the
ImageWriteParam since their usage is
still experimental.
an instance of ImageWriteParam. |
| getDescription | | public String getDescription()(Code) | |
See Also: org.opengis.coverage.grid.Format.getDescription |
| getDocURL | | public String getDocURL()(Code) | |
See Also: org.opengis.coverage.grid.Format.getDocURL |
| getName | | public String getName()(Code) | |
See Also: org.opengis.coverage.grid.Format.getName |
| getReadParameters | | public ParameterValueGroup getReadParameters()(Code) | |
See Also: org.opengis.coverage.grid.Format.getReadParameters |
| getReader | | abstract public GridCoverageReader getReader(Object source)(Code) | | Gets a
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.
Parameters:
source - The source object to parse. A reader for this Format or null. |
| getReader | | abstract public GridCoverageReader getReader(Object source, Hints hints)(Code) | | Gets a
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.
Parameters:
source - The source object to parse. *
Parameters:
hints - The Hints to use when trying to instantiate thisreader. A reader for this Format or null. |
| getVendor | | public String getVendor()(Code) | |
See Also: org.opengis.coverage.grid.Format.getVendor |
| getVersion | | public String getVersion()(Code) | |
See Also: org.opengis.coverage.grid.Format.getVersion |
| getWriteParameters | | public ParameterValueGroup getWriteParameters()(Code) | |
See Also: org.opengis.coverage.grid.Format.getWriteParameters |
| getWriter | | abstract public GridCoverageWriter getWriter(Object destination)(Code) | | Retrieves a
GridCoverageWriter suitable for writing to the
provided destination with this format.
In case no writers are availaible null is returned.
Parameters:
destination - The destinatin where to write. A GridCoverageWriter suitable for writing to the provideddestination with this format. |
|
|