Class DefaultFeatureCatalogueDescription
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
AbstractContentInformation
DefaultFeatureCatalogueDescription
- All Implemented Interfaces:
Serializable,Emptiable,LenientComparable,IdentifiedObject,ContentInformation,FeatureCatalogueDescription
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_FeatureCatalogueDescription
├─includedWithDataset………………… Indication of whether or not the feature catalogue is included with the dataset.
└─featureCatalogueCitation…… 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
XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
-
Nested Class Summary
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State -
Field Summary
Fields inherited from class ISOMetadata
identifiers -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty feature catalogue description.Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionReturns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the complete bibliographic reference to one or more external feature catalogues.Returns the subset of feature types from cited feature catalogue occurring in resource.final Collection<GenericName>Deprecated.Deprecated.Replaced bygetLocalesAndCharsets().keySet().Returns the language(s) and character set(s) used within the catalogue.Returns whether or not the cited feature catalogue complies with ISO 19110.booleanReturns whether or not the feature catalogue is included with the resource.voidsetCompliant(Boolean newValue) Sets whether or not the cited feature catalogue complies with ISO 19110.voidsetFeatureCatalogueCitations(Collection<? extends Citation> newValues) Sets the complete bibliographic reference to one or more external feature catalogues.voidsetFeatureTypeInfo(Collection<? extends DefaultFeatureTypeInfo> newValues) Sets the subset of feature types from cited feature catalogue occurring in resource.voidsetFeatureTypes(Collection<? extends GenericName> newValues) Deprecated.As of ISO 19115:2014, replaced bysetFeatureTypeInfo(Collection).voidsetIncludedWithDataset(boolean newValue) Sets whether or not the feature catalogue is included with the resource.voidsetLanguages(Collection<? extends Locale> newValues) Deprecated.Replaced by putting keys ingetLocalesAndCharsets()map.voidsetLocalesAndCharsets(Map<? extends Locale, ? extends Charset> newValues) Sets the language(s) and character set(s) used within the catalogue.Methods inherited from class AbstractContentInformation
castOrCopyMethods inherited from class ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Constructor Details
-
DefaultFeatureCatalogueDescription
public DefaultFeatureCatalogueDescription()Constructs an initially empty feature catalogue description. -
DefaultFeatureCatalogueDescription
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, ornullif none.- See Also:
-
-
Method Details
-
castOrCopy
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 returnsnull. - Otherwise if the given object is already an instance of
DefaultFeatureCatalogueDescription, then it is returned unchanged. - Otherwise a new
DefaultFeatureCatalogueDescriptioninstance 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, ornullif none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
nullif the argument was null.
- If the given object is
-
isCompliant
Returns whether or not the cited feature catalogue complies with ISO 19110.- Specified by:
isCompliantin interfaceFeatureCatalogueDescription- Returns:
- whether or not the cited feature catalogue complies with ISO 19110, or
null.
-
setCompliant
Sets whether or not the cited feature catalogue complies with ISO 19110.- Parameters:
newValue- 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
Sets the language(s) and character set(s) used within the catalogue.- Parameters:
newValues- the new language(s) and character set(s) used within the catalogue.- Since:
- 1.0
-
getLanguages
Deprecated.Replaced bygetLocalesAndCharsets().keySet().Returns the language(s) used within the catalogue.- Specified by:
getLanguagesin interfaceFeatureCatalogueDescription- Returns:
- language(s) used within the catalogue.
-
setLanguages
Deprecated.Replaced by putting keys ingetLocalesAndCharsets()map.Sets the language(s) used within the catalogue.- Parameters:
newValues- the new languages.
-
isIncludedWithDataset
public boolean isIncludedWithDataset()Returns whether or not the feature catalogue is included with the resource.- Specified by:
isIncludedWithDatasetin interfaceFeatureCatalogueDescription- 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:
newValue-trueif 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 theFeatureTypeInfointerface when GeoAPI will provide it (tentatively in GeoAPI 3.1).- Returns:
- subset of feature types occurring in resource.
- Since:
- 0.5
-
setFeatureTypeInfo
Sets the subset of feature types from cited feature catalogue occurring in resource.Upcoming API change — generalization
The element type will be changed to theFeatureTypeInfointerface when GeoAPI will provide it (tentatively in GeoAPI 3.1).- Parameters:
newValues- the new feature types.- Since:
- 0.5
-
getFeatureTypes
Deprecated.As of ISO 19115:2014, replaced bygetFeatureTypeInfo().Returns the names of feature types.- Specified by:
getFeatureTypesin interfaceFeatureCatalogueDescription- Returns:
- the feature type names.
-
setFeatureTypes
Deprecated.As of ISO 19115:2014, replaced bysetFeatureTypeInfo(Collection).Sets the names of feature types.- Parameters:
newValues- the new feature type names.
-
getFeatureCatalogueCitations
Returns the complete bibliographic reference to one or more external feature catalogues.- Specified by:
getFeatureCatalogueCitationsin interfaceFeatureCatalogueDescription- Returns:
- bibliographic reference to one or more external feature catalogues.
-
setFeatureCatalogueCitations
Sets the complete bibliographic reference to one or more external feature catalogues.- Parameters:
newValues- the feature catalogue citations.
-
getFeatureTypeInfo().