Module org.apache.sis.metadata
Package org.apache.sis.metadata.iso.content

Class DefaultFeatureCatalogueDescription

Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
AbstractContentInformation
DefaultFeatureCatalogueDescription
All Implemented Interfaces:
Serializable, Emptiable, Lenient­Comparable, Identified­Object, Content­Information, Feature­Catalogue­Description
public class DefaultFeatureCatalogueDescription extends AbstractContentInformation implements FeatureCatalogueDescription
Information identifying the feature catalogue or the conceptual schema. The following properties are mandatory in a well-formed metadata according ISO 19115:
MD_Feature­Catalogue­Description   ├─included­With­Dataset………………… Indication of whether or not the feature catalogue is included with the dataset.   └─feature­Catalogue­Citation…… Complete bibliographic reference to one or more external feature catalogues.       ├─title…………………………………………… Name by which the cited resource is known.       └─date……………………………………………… Reference date for the cited resource.

Limitations

  • Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
  • Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases. Serialization support is appropriate for short term storage or RMI between applications running the same version of Apache SIS. For long term storage, use XML instead.
Since:
0.3
See Also:

  • Constructor Details

    • DefaultFeatureCatalogueDescription

      public DefaultFeatureCatalogueDescription()
      Constructs an initially empty feature catalogue description.

    • DefaultFeatureCatalogueDescription

      public DefaultFeatureCatalogueDescription(FeatureCatalogueDescription object)
      Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.
      Parameters:
      object - the metadata to copy values from, or null if none.
      See Also:

  • Method Details

    • castOrCopy

      public static DefaultFeatureCatalogueDescription castOrCopy(FeatureCatalogueDescription object)
      Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:
      • If the given object is null, then this method returns null.
      • Otherwise if the given object is already an instance of Default­Feature­Catalogue­Description, then it is returned unchanged.
      • Otherwise a new Default­Feature­Catalogue­Description instance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.
      Parameters:
      object - the object to get as a SIS implementation, or null if none.
      Returns:
      a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

    • isCompliant

      public Boolean isCompliant()
      Returns whether or not the cited feature catalogue complies with ISO 19110.
      Specified by:
      is­Compliant in interface Feature­Catalogue­Description
      Returns:
      whether or not the cited feature catalogue complies with ISO 19110, or null.

    • setCompliant

      public void setCompliant(Boolean newValue)
      Sets whether or not the cited feature catalogue complies with ISO 19110.
      Parameters:
      new­Value - the new compliance value.

    • getLocalesAndCharsets

      @UML(identifier="locale", obligation=CONDITIONAL, specification=ISO_19115) public Map<Locale,Charset> getLocalesAndCharsets()
      Returns the language(s) and character set(s) used within the catalogue.
      Returns:
      language(s) and character set(s) used within the catalogue.
      Since:
      1.0

    • setLocalesAndCharsets

      public void setLocalesAndCharsets(Map<? extends Locale,? extends Charset> newValues)
      Sets the language(s) and character set(s) used within the catalogue.
      Parameters:
      new­Values - the new language(s) and character set(s) used within the catalogue.
      Since:
      1.0

    • getLanguages

      @Deprecated(since="1.0") public Collection<Locale> getLanguages()
      Deprecated.
      Replaced by get­Locales­And­Charsets()​.key­Set().
      Returns the language(s) used within the catalogue.
      Specified by:
      get­Languages in interface Feature­Catalogue­Description
      Returns:
      language(s) used within the catalogue.

    • setLanguages

      @Deprecated(since="1.0") public void setLanguages(Collection<? extends Locale> newValues)
      Deprecated.
      Replaced by putting keys in get­Locales­And­Charsets() map.
      Sets the language(s) used within the catalogue.
      Parameters:
      new­Values - the new languages.

    • isIncludedWithDataset

      public boolean isIncludedWithDataset()
      Returns whether or not the feature catalogue is included with the resource.
      Specified by:
      is­Included­With­Dataset in interface Feature­Catalogue­Description
      Returns:
      whether or not the feature catalogue is included with the resource.

    • setIncludedWithDataset

      public void setIncludedWithDataset(boolean newValue)
      Sets whether or not the feature catalogue is included with the resource.
      Parameters:
      new­Value - true if the feature catalogue is included.

    • getFeatureTypeInfo

      @UML(identifier="featureTypes", obligation=OPTIONAL, specification=ISO_19115) public Collection<DefaultFeatureTypeInfo> getFeatureTypeInfo()
      Returns the subset of feature types from cited feature catalogue occurring in resource.
      Upcoming API change — generalization
      The element type will be changed to the Feature­Type­Info interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).
      Returns:
      subset of feature types occurring in resource.
      Since:
      0.5

    • setFeatureTypeInfo

      public void setFeatureTypeInfo(Collection<? extends DefaultFeatureTypeInfo> newValues)
      Sets the subset of feature types from cited feature catalogue occurring in resource.
      Upcoming API change — generalization
      The element type will be changed to the Feature­Type­Info interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).
      Parameters:
      new­Values - the new feature types.
      Since:
      0.5

    • getFeatureTypes

      @Deprecated(since="1.0") public final Collection<GenericName> getFeatureTypes()
      Deprecated.
      As of ISO 19115:2014, replaced by get­Feature­Type­Info().
      Returns the names of feature types.
      Specified by:
      get­Feature­Types in interface Feature­Catalogue­Description
      Returns:
      the feature type names.

    • setFeatureTypes

      @Deprecated(since="1.0") public void setFeatureTypes(Collection<? extends GenericName> newValues)
      Deprecated.
      As of ISO 19115:2014, replaced by set­Feature­Type­Info(Collection).
      Sets the names of feature types.
      Parameters:
      new­Values - the new feature type names.

    • getFeatureCatalogueCitations

      public Collection<Citation> getFeatureCatalogueCitations()
      Returns the complete bibliographic reference to one or more external feature catalogues.
      Specified by:
      get­Feature­Catalogue­Citations in interface Feature­Catalogue­Description
      Returns:
      bibliographic reference to one or more external feature catalogues.

    • setFeatureCatalogueCitations

      public void setFeatureCatalogueCitations(Collection<? extends Citation> newValues)
      Sets the complete bibliographic reference to one or more external feature catalogues.
      Parameters:
      new­Values - the feature catalogue citations.