org.geotoolkit.coverage.amended

Class AmendedCoverageResource

Object

AbstractResource

AbstractCoverageResource

AmendedCoverageResource

All Implemented Interfaces:

FeatureResource, CoverageResource, Resource

public class AmendedCoverageResource
extends AbstractCoverageResource

Decorates a coverage reference adding possibility to override properties.

List of properties which can be override :

• CRS
• GridToCRS
• PixelInCell
• Sample dimensions

Author:

Johann Sorel (Geomatys)

Field Summary

Fields

Modifier and Type	Field and Description
protected CoordinateReferenceSystem	overrideCRS
protected List<GridSampleDimension>	overrideDims
protected MathTransform	overrideGridToCrs
protected PixelInCell	overridePixelInCell
protected CoverageResource	ref
protected List<GridSampleDimension>	refDims
protected GeneralGridGeometry	refGridGeom

Fields inherited from class AbstractCoverageResource

store

Fields inherited from class AbstractResource

identifier, listeners

Constructor Summary

Constructors

Constructor and Description
AmendedCoverageResource(CoverageResource ref, CoverageStore store)

Method Summary

Modifier and Type	Method and Description
GridCoverageReader	acquireReader() Get a reader for this coverage.
GridCoverageWriter	acquireWriter() Get a writer for this coverage.
CoverageDescription	getCoverageDescription() Get the coverage description and statistics.
CoverageResource	getDecorated() Get decorated coverage reference.
GeneralGridGeometry	getGridGeometry(int index) Get overriden grid geometry.
int	getImageIndex()
Image	getLegend() Return the legend of this coverage
Metadata	getMetadata() Returns information about the resource.
GeneralGridGeometry	getOriginalGridGeometry(int index)
CoordinateReferenceSystem	getOverrideCRS() Get overriden CRS.
List<GridSampleDimension>	getOverrideDims() Get overriden sample dimensions.
MathTransform	getOverrideGridToCrs() Get overriden grid to crs transform.
PixelInCell	getOverridePixelInCell() Get overriden PixelInCell.
List<GridSampleDimension>	getSampleDimensions(int index) Get overriden sample dimensions
boolean	isGridGeometryOverriden() Check if at least one of the grid geometry properties has been overriden.
boolean	isWritable()
void	recycle(CoverageReader reader) Default recycle implementation.
void	recycle(GridCoverageWriter writer) Default recycle implementation.
void	setOverrideCRS(CoordinateReferenceSystem overrideCRS) Set crs override.
void	setOverrideDims(List<GridSampleDimension> overrideDims) Set sample dimensions override.
void	setOverrideGridToCrs(MathTransform overrideGridToCrs) Set grid to crs transform override.
void	setOverridePixelInCell(PixelInCell overridePixelInCell) Set PixelInCell override.

Methods inherited from class AbstractCoverageResource

dispose, fireDataUpdated, fireMosaicAdded, fireMosaicDeleted, fireMosaicUpdated, firePyramidAdded, firePyramidDeleted, firePyramidUpdated, fireTileAdded, fireTileDeleted, fireTileUpdated, getName, getStore

Methods inherited from class AbstractResource

addStorageListener, forwardContentEvent, forwardStructureEvent, getIdentifier, removeStorageListener, sendContentEvent, sendStructureEvent, toString

Methods inherited from class Object

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

Methods inherited from interface CoverageResource

features, getType

Methods inherited from interface FeatureResource

subset

Methods inherited from interface Resource

addStorageListener, getIdentifier, removeStorageListener

Field Detail

ref

protected final CoverageResource ref

refGridGeom

protected GeneralGridGeometry refGridGeom

refDims

protected List<GridSampleDimension> refDims

overrideCRS

protected CoordinateReferenceSystem overrideCRS

overridePixelInCell

protected PixelInCell overridePixelInCell

overrideGridToCrs

protected MathTransform overrideGridToCrs

overrideDims

protected List<GridSampleDimension> overrideDims

Constructor Detail

AmendedCoverageResource

public AmendedCoverageResource(CoverageResource ref,
                               CoverageStore store)

Method Detail

getDecorated

public CoverageResource getDecorated()

Get decorated coverage reference.

Returns:

CoverageResource, never null.

isGridGeometryOverriden

public boolean isGridGeometryOverriden()

Check if at least one of the grid geometry properties has been overriden.

Returns:

true of grid geometry is override

getOriginalGridGeometry

public GeneralGridGeometry getOriginalGridGeometry(int index)
                                            throws CoverageStoreException

Parameters:

index -

Returns:

Throws:

CoverageStoreException

getOverrideCRS

public CoordinateReferenceSystem getOverrideCRS()

Get overriden CRS.

Returns:

CoordinateReferenceSystem, can be null

setOverrideCRS

public void setOverrideCRS(CoordinateReferenceSystem overrideCRS)

Set crs override.

Parameters:

overrideCRS - , can be null

getOverridePixelInCell

public PixelInCell getOverridePixelInCell()

Get overriden PixelInCell.

Returns:

PixelInCell, can be null

setOverridePixelInCell

public void setOverridePixelInCell(PixelInCell overridePixelInCell)

Set PixelInCell override. Default is PixelInCell.CELL_CENTER.

Parameters:

overridePixelInCell - , can be null

getOverrideGridToCrs

public MathTransform getOverrideGridToCrs()

Get overriden grid to crs transform.

Returns:

MathTransform, can be null

setOverrideGridToCrs

public void setOverrideGridToCrs(MathTransform overrideGridToCrs)

Set grid to crs transform override. This transform is relative to PixelInCell.CELL_CENTER if PixelInCell property has not been override.

Parameters:

overrideGridToCrs - , can be null

getOverrideDims

public List<GridSampleDimension> getOverrideDims()

Get overriden sample dimensions.

Returns:

List, can be null

setOverrideDims

public void setOverrideDims(List<GridSampleDimension> overrideDims)

Set sample dimensions override.

Parameters:

overrideDims - , can be null

getGridGeometry

public GeneralGridGeometry getGridGeometry(int index)
                                    throws CoverageStoreException

Get overriden grid geometry.

Parameters:

index - image index in reader

Returns:

overridden grid geometry or original one is there are no overrides.

Throws:

CoverageStoreException

getSampleDimensions

public List<GridSampleDimension> getSampleDimensions(int index)
                                              throws CoverageStoreException

Get overriden sample dimensions

Parameters:

index - image index in reader

Returns:

overridden sample dimensions or original ones is there are no overrides.

Throws:

CoverageStoreException

getImageIndex

public int getImageIndex()

Returns:

int image index in reader/writer.

getCoverageDescription

public CoverageDescription getCoverageDescription()

Get the coverage description and statistics.

Specified by:

getCoverageDescription in interface CoverageResource

Overrides:

getCoverageDescription in class AbstractCoverageResource

Returns:

CoverageDescripion, can be null

isWritable

public boolean isWritable()
                   throws DataStoreException

Returns:

true if coverage is writable

Throws:

DataStoreException

acquireReader

public GridCoverageReader acquireReader()
                                 throws CoverageStoreException

Get a reader for this coverage. When you have finished using it, return it using the recycle method.

Returns:

GridCoverageReader

Throws:

CoverageStoreException

acquireWriter

public GridCoverageWriter acquireWriter()
                                 throws CoverageStoreException

Get a writer for this coverage. When you have finished using it, return it using the recycle method.

Returns:

GridCoverageWriter

Throws:

CoverageStoreException

recycle

public void recycle(CoverageReader reader)

Default recycle implementation. Dispose the reader.

Specified by:

recycle in interface CoverageResource

Overrides:

recycle in class AbstractCoverageResource

recycle

public void recycle(GridCoverageWriter writer)

Default recycle implementation. Dispose the writer.

Specified by:

recycle in interface CoverageResource

Overrides:

recycle in class AbstractCoverageResource

getLegend

public Image getLegend()
                throws DataStoreException

Return the legend of this coverage

Returns:

Throws:

DataStoreException

getMetadata

public Metadata getMetadata()
                     throws DataStoreException

Description copied from interface: Resource

Returns information about the resource. The returned metadata object, can contain information such as the spatiotemporal extent of the resource, contact information about the creator or distributor, data quality, update frequency, usage constraints and more.

Specified by:

getMetadata in interface FeatureResource

Specified by:

getMetadata in interface Resource

Overrides:

getMetadata in class AbstractCoverageResource

Returns:

information about the resource, not null.

Throws:

DataStoreException - if an error occurred while reading the data.