Interface StoreResource

All Superinterfaces:
Resource
All Known Implementing Classes:
AsciiGridStore, BandGroup, DataCube, ImageFileDirectory, MultiImageStore, MultiImageStore.Writable, MultiResolutionImage, PRJDataStore, RasterStore, RawRasterStore, SingleImageStore, SingleImageStore.Writable, StaxDataStore, Store, Store, Store, Store, Store, URIDataStore, WorldFileResource, WorldFileStore, WritableResource, WritableStore, WritableStore, WritableStore, WritableStore

public interface StoreResource extends Resource
A resource produced directly by a data store. This interface can be implemented by the following resources: This interface should not be implemented by resources that are the result of some operation, including filtering applied by subset(Query) methods.

Use case

This interface provides information about which DataStore produced this resource. It allows for example to fetch the parameters used for opening the data store. Combined with the resource identifier, it makes possible to save information needed for reopening the same resource later. This use case is the reason why this interface should be implemented only by resources produced directly by a data store, because otherwise the parameters and identifiers would not be sufficient information for identifying the resource.

Future evolution

This interface is not yet in public API. Whether we should commit this interface in public API is an open question. See SIS-416.
Since:
1.0
Version:
1.0
  • Method Details

    • getOriginator

      DataStore getOriginator()
      Returns the data store that produced this resource. If this resource is already a DataStore instance, then this method returns this.
      Returns:
      the data store that created this resource.