Class DocumentedStoreProvider

Direct Known Subclasses:
AbstractProvider

public abstract class DocumentedStoreProvider extends URIDataStore.Provider
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
  • Field Details

    • name

      private final String name
      The primary key to use for searching in the MD_Format table, or null if none. This primary name is also the value returned by getShortName() default implementation.
    • format

      private transient org.opengis.metadata.distribution.Format format
      The format, created when first requested.
      See Also:
  • Constructor Details

    • DocumentedStoreProvider

      protected DocumentedStoreProvider(String name)
      Creates a new provider. The primary key given in argument is also the value returned by getShortName() default implementation. If this is not the desired value for the format short name, then subclass should override getShortName().
      Parameters:
      name - the primary key to use for searching in the MD_Format table, or null if none.
  • Method Details

    • getShortName

      public String 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 class DataStoreProvider
      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 class DataStoreProvider
      Returns:
      a description of the data format.
      See Also:
    • getFormat

      public 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.
      Parameters:
      listeners - where to report the warning in case of error, or null if none.
      Returns:
      a description of the data format.