Package org.apache.sis.internal.storage
Annotation Type StoreMetadata
Metadata about of
DataStoreProvider
.
Some data stores can only read data while other can read and write.
This is not a committed API since the way to represent data store capabilities is likely to change.
- Since:
- 0.8
- Version:
- 1.1
-
Required Element Summary
Required ElementsModifier and TypeRequired ElementDescriptionIndicates whether the data store created by theopen(…)
method can read and/or write data.Returns a name for the data store format. -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionString[]
Returns the suffixes that may be used with the name of the "main" file.Returns the types of resource that theDataStoreProvider
may be able to produce.boolean
Returnstrue
if the data store should be tested last when searching for a data store capable to open a given file.
-
Element Details
-
formatName
String formatNameReturns a name for the data store format. This is not guaranteed to be a unique identifier! Should not be used as a way to uniquely identify a provider. In many cases, this is the same thanDataStoreProvider.getShortName()
.- Returns:
- a name for the data store format.
- See Also:
-
capabilities
Capability[] capabilitiesIndicates whether the data store created by theopen(…)
method can read and/or write data.- Returns:
- information about whether the data store implementation can read and/or write data.
-
-
-
fileSuffixes
String[] fileSuffixesReturns the suffixes that may be used with the name of the "main" file. The "main" file is the file that users specify when opening the dataset. The returned array should not include the suffixes of auxiliary files.Example: GeoTIFF data are contained in files with theThe suffixes are case-insensitive (no need to declare both lower-case and upper-case variants) and shall not contain the leading dot. The first element in the list is the preferred suffix to use for new files.".tif"
or".tiff"
suffix, sometimes accompanied by auxiliary files with".prj"
and".tfw"
suffixes. This method should return an array containing only"tif"
or"tiff"
strings, without the leading dot.The same suffixes may be used by many different formats. For example, the
".xml"
suffix is used for files in many mutually incompatible formats. Consequently, the file suffixes shall not be used as format identifiers.- Returns:
- the filename suffixes, case insensitive. Never null but can be empty.
- Default:
- {}
-
resourceTypes
Returns the types of resource that theDataStoreProvider
may be able to produce. Values in this array may beAggregate
,FeatureSet
orGridCoverageResource
.- Returns:
- information about the expected resource types which might be encounter with this format.
- Default:
- {}
-
yieldPriority
boolean yieldPriorityReturnstrue
if the data store should be tested last when searching for a data store capable to open a given file. This method should returntrue
if the data store claims to be able to open a wide variety of files, in order to allow specialized data stores to be tested before generic data stores.If many data stores yield priority, the ordering between them is unspecified.
- Returns:
true
if this data store should be tested after all "normal priority" data stores.
- Default:
- false
-