RPFTOCReader (Geotools modules 31-SNAPSHOT API)

Object
- AbstractGridCoverage2DReader
- - BaseGridCoverage2DReader
  - - BaseGDALGridCoverage2DReader
    - - RPFTOCReader

All Implemented Interfaces:

GridCoverageReader, GridCoverage2DReader
```
public final class RPFTOCReader
extends BaseGDALGridCoverage2DReader
implements GridCoverageReader
```
This class can read a RPFTOC data source and create a GridCoverage2D from the data.

Since:

2.5.x

Author:

Daniele Romagnoli, GeoSolutions., Simone Giannecchini (simboss), GeoSolutions

Field Summary
- Fields inherited from class BaseGDALGridCoverage2DReader
  DEFAULT_WORLDFILE_EXT
- Fields inherited from class BaseGridCoverage2DReader
  multiLevelRoi, nodata, resourceInfo
- Fields inherited from class AbstractGridCoverage2DReader
  closeMe, coverageFactory, coverageName, crs, dtLayout, EPS, gzipped, highestRes, hints, inStream, inStreamSPI, numOverviews, offsets, originalEnvelope, originalGridRange, overViewResolutions, raster2Model, scales, source
- Fields inherited from interface GridCoverage2DReader
  ELEVATION_DOMAIN, ELEVATION_DOMAIN_MAXIMUM, ELEVATION_DOMAIN_MINIMUM, ELEVATION_DOMAIN_RESOLUTION, FILE_SOURCE_PROPERTY, HAS_ELEVATION_DOMAIN, HAS_TIME_DOMAIN, MULTICRS_EPSGCODES, MULTICRS_READER, PAM_DATASET, REPROJECTING_READER, SOURCE_URL_PROPERTY, TIME_DOMAIN, TIME_DOMAIN_MAXIMUM, TIME_DOMAIN_MINIMUM, TIME_DOMAIN_RESOLUTION

Constructor Summary

Constructors
Constructor	Description
`RPFTOCReader(Object input)`	Creates a new instance of a `RPFTOCReader`.
`RPFTOCReader(Object input, Hints hints)`	Creates a new instance of a `RPFTOCReader`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getCoverageName()`	Override coverage name because of the default structure of the folders.
`Format`	`getFormat()`	Returns the format handled by this `GridCoverageReader`.

Methods inherited from class BaseGDALGridCoverage2DReader
getInfo, setCoverageProperties

Methods inherited from class BaseGridCoverage2DReader
getGridCoverageCount, getHighestRes, getInfo, getInputFile, getMultiLevelRoi, getMultiLevelROIProvider, getNodata, parsePRJFile, parseWorldFile, read

Methods inherited from class AbstractGridCoverage2DReader
addAllSiblings, addSiblings, checkName, collectScaleOffset, createImageCoverage, createImageCoverage, createImageCoverage, createImageCoverage, decimationOnReadingControl, dispose, finalize, getCoordinateReferenceSystem, getCoordinateReferenceSystem, getDatasetLayout, getDatasetLayout, getDynamicParameters, getDynamicParameters, getFiles, getGridCoverageNames, getGroundControlPoints, getGroundControlPoints, getHighestRes, getImageLayout, getImageLayout, getMetadataNames, getMetadataNames, getMetadataValue, getMetadataValue, getOriginalEnvelope, getOriginalEnvelope, getOriginalGridRange, getOriginalGridRange, getOriginalGridToWorld, getOriginalGridToWorld, getOverviewGridEnvelope, getOverviewGridEnvelope, getPamDataset, getPamDataset, getReadingResolutions, getReadingResolutions, getRescaledRasterToModel, getResolution, getResolutionLevels, getResolutionLevels, getSibling, getSource, getSourceAsFile, read, setlayout, setLayout, setReadParams, setReadParams

Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface GridCoverageReader
dispose, getGridCoverageCount, getGridCoverageNames, getMetadataNames, getMetadataNames, getMetadataValue, getMetadataValue, getSource

- Constructor Detail
  - RPFTOCReader
```
public RPFTOCReader(Object input)
             throws DataSourceException
```
    Creates a new instance of a RPFTOCReader. I assume nothing about file extension.
    
    Parameters:
    
    input - Source object for which we want to build an RPFTOCReader.
    
    Throws:
    
    DataSourceException
  - RPFTOCReader
```
public RPFTOCReader(Object input,
                    Hints hints)
             throws DataSourceException
```
    Creates a new instance of a RPFTOCReader. I assume nothing about file extension.
    
    Parameters:
    
    input - Source object for which we want to build an RPFTOCReader.
    
    hints - Hints to be used by this reader throughout his life.
    
    Throws:
    
    DataSourceException
- Method Detail
  - getFormat
```
public Format getFormat()
```
    Description copied from interface: GridCoverageReader
    
    Returns the format handled by this GridCoverageReader.
    
    Specified by:
    
    getFormat in interface GridCoverageReader
    
    See Also:
    
    GridCoverageReader.getFormat()
  - getCoverageName
```
public String getCoverageName()
```
    Override coverage name because of the default structure of the folders. Very often XXX/RPF/A.TOC The parent directory is a better alternative
    
    Overrides:
    
    getCoverageName in class BaseGridCoverage2DReader
    
    Returns:
    
    the coverage name