Module org.apache.sis.storage

Package org.apache.sis.storage

Class AbstractGridCoverageResource

Object

AbstractResource

AbstractGridCoverageResource

All Implemented Interfaces:

Data­Set, Grid­Coverage­Resource, Resource

public abstract class AbstractGridCoverageResource
extends AbstractResource
implements GridCoverageResource

Default implementations of several methods for classes that want to implement the Grid­Coverage­Resource interface. Subclasses should override the following methods:

• Grid­Coverage­Resource.get­Grid­Geometry() (mandatory)
• Grid­Coverage­Resource.get­Sample­Dimensions() (mandatory)

This class also provides the following helper methods for implementation of the read(…) method in subclasses:

• can­Not­Read(String, Grid­Geometry, Throwable) for reporting a failure to read operation.
• log­Read­Operation(Object, Grid­Geometry, long) for logging a notice about a read operation.

Since:

1.2

Field Summary

Fields inherited from class AbstractResource

listeners

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Abstract­Grid­Coverage­Resource(Store­Listeners parent­Listeners, boolean hidden)	Creates a new resource which can send notifications to the given set of listeners.
protected	Abstract­Grid­Coverage­Resource(Resource parent)	Creates a new resource, potentially as a child of another resource.

Method Summary

Modifier and Type	Method	Description
protected Data­Store­Exception	can­Not­Read(String filename, Grid­Geometry request, Throwable cause)	Creates an exception for a failure to load data.
protected Metadata	create­Metadata()	Invoked in a synchronized block the first time that get­Metadata() is invoked.
Optional<Envelope>	get­Envelope()	Returns the envelope of the grid geometry if known.
protected void	log­Read­Operation(Object file, Grid­Geometry domain, long start­Time)	Logs the execution of a Grid­Coverage­Resource.read(Grid­Geometry, int...) operation.

Methods inherited from class AbstractResource

add­Listener, clear­Cache, get­Identifier, get­Metadata, get­Synchronization­Lock, remove­Listener

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, to­String, wait, wait, wait

Methods inherited from interface GridCoverageResource

get­Grid­Geometry, get­Loading­Strategy, get­Resolutions, get­Sample­Dimensions, read, set­Loading­Strategy, subset

Methods inherited from interface Resource

add­Listener, get­Identifier, get­Metadata, remove­Listener

Constructor Details

AbstractGridCoverageResource

protected AbstractGridCoverageResource(Resource parent)

Creates a new resource, potentially as a child of another resource. The parent resource is typically, but not necessarily, an Aggregate.

Parameters:

parent - the parent resource, or null if none.

Since:

1.4

AbstractGridCoverageResource

protected AbstractGridCoverageResource(StoreListeners parentListeners,
 boolean hidden)

Creates a new resource which can send notifications to the given set of listeners. If hidden is false (the recommended value), then this resource will have its own set of listeners with this resource declared as the source of events. It will be possible to add and remove listeners independently from the set of parent listeners. Conversely if hidden is true, then the given listeners will be used directly and this resource will not appear as the source of any event.

In any cases, the listeners of all parents (ultimately the data store that created this resource) will always be notified, either directly if hidden is true or indirectly if hidden is false.

Parameters:

parent­Listeners - listeners of the parent resource, or null if none. This is usually the listeners of the Data­Store that created this resource.

hidden - false if this resource shall use its own Store­Listeners with the specified parent, or true for using parent­Listeners directly.

Method Details

getEnvelope

public Optional<Envelope> getEnvelope()
                               throws DataStoreException

Returns the envelope of the grid geometry if known. The envelope is absent if the grid geometry does not provide this information.

Specified by:

get­Envelope in interface Data­Set

Overrides:

get­Envelope in class Abstract­Resource

Returns:

the grid geometry envelope.

Throws:

Data­Store­Exception - if an error occurred while computing the grid geometry.

See Also:

• Grid­Geometry.get­Envelope()

createMetadata

protected Metadata createMetadata()
                           throws DataStoreException

Invoked in a synchronized block the first time that get­Metadata() is invoked. The default implementation populates metadata based on information provided by get­Identifier(), get­Envelope(), get­Grid­Geometry() and get­Sample­Dimensions(). Subclasses should override if they can provide more information. The default value can be completed by casting to Default­Metadata.

Overrides:

create­Metadata in class Abstract­Resource

Returns:

the newly created metadata, or null if unknown.

Throws:

Data­Store­Exception - if an error occurred while reading metadata from this resource.

canNotRead

protected DataStoreException canNotRead(String filename,
 GridGeometry request,
 Throwable cause)

Creates an exception for a failure to load data. The exception sub-type is inferred from the arguments. If the failure is caused by an envelope outside the resource domain, then that envelope will be inferred from the request argument.

Parameters:

filename - some identification (typically a file name) of the data that cannot be read.

request - the requested domain, or null if unspecified.

cause - the cause of the failure, or null if none.

Returns:

the exception to throw.

See Also:

• No­Such­Data­Exception
• Data­Store­Referencing­Exception
• Data­Store­Content­Exception

logReadOperation

protected void logReadOperation(Object file,
 GridGeometry domain,
 long startTime)

Logs the execution of a Grid­Coverage­Resource.read(Grid­Geometry, int...) operation. The log level will be Level.FINE if the operation was quick enough, or Performance­Level.SLOWNESS or higher level otherwise.

Parameters:

file - the file that was opened, or null for Store­Listeners.get­Source­Name().

domain - domain of the created grid coverage.

start­Time - value of System.nano­Time() when the loading process started.