Package org.apache.sis.internal.storage
Class DocumentedStoreProvider
java.lang.Object
org.apache.sis.storage.DataStoreProvider
org.apache.sis.internal.storage.URIDataStore.Provider
org.apache.sis.internal.storage.DocumentedStoreProvider
- Direct Known Subclasses:
AbstractProvider
Base class of data store providers having an entry in the metadata SQL database.
The primary key in the
MD_Format
table must be the name given at construction time.- Since:
- 0.8
- Version:
- 1.2
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.storage.DataStoreProvider
DataStoreProvider.Prober<S>
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.opengis.metadata.distribution.Format
The format, created when first requested.private final String
The primary key to use for searching in theMD_Format
table, ornull
if none.Fields inherited from class org.apache.sis.internal.storage.URIDataStore.Provider
CREATE_PARAM, ENCODING, LOCATION_PARAM
Fields inherited from class org.apache.sis.storage.DataStoreProvider
CREATE, LOCATION
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Creates a new provider. -
Method Summary
Modifier and TypeMethodDescriptionfinal org.opengis.metadata.distribution.Format
Returns a more complete description of the format.final org.opengis.metadata.distribution.Format
getFormat
(StoreListeners listeners) Returns a more complete description of the format, sending warnings to the given listeners if non-null.Returns a short name or abbreviation for the data format.Methods inherited from class org.apache.sis.internal.storage.URIDataStore.Provider
build, connector, descriptor, getOpenParameters, isWritable
Methods inherited from class org.apache.sis.storage.DataStoreProvider
getLogger, getSupportedVersions, open, open, probeContent, probeContent
-
Field Details
-
name
The primary key to use for searching in theMD_Format
table, ornull
if none. This primary name is also the value returned bygetShortName()
default implementation. -
format
private transient org.opengis.metadata.distribution.Format formatThe format, created when first requested.- See Also:
-
-
Constructor Details
-
DocumentedStoreProvider
Creates a new provider. The primary key given in argument is also the value returned bygetShortName()
default implementation. If this is not the desired value for the format short name, then subclass should overridegetShortName()
.- Parameters:
name
- the primary key to use for searching in theMD_Format
table, ornull
if none.
-
-
Method Details
-
getShortName
Returns a short name or abbreviation for the data format. The default implementation returns the primary key given at construction time. If that primary key is not an appropriate format short name, then subclass should override this method.- Specified by:
getShortName
in classDataStoreProvider
- Returns:
- a short name or abbreviation for the data format.
- See Also:
-
getFormat
public final org.opengis.metadata.distribution.Format getFormat()Returns a more complete description of the format.- Overrides:
getFormat
in classDataStoreProvider
- Returns:
- a description of the data format.
- See Also:
-
getFormat
Returns a more complete description of the format, sending warnings to the given listeners if non-null.- Parameters:
listeners
- where to report the warning in case of error, ornull
if none.- Returns:
- a description of the data format.
-