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:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Modifier and Type	Class	Description
static enum	Modifiable­Metadata.State	Whether the metadata is still editable or has been made final.

Field Summary

Fields inherited from class ISOMetadata

identifiers

Modifier and Type	Field	Description
protected Collection<Identifier>	identifiers	All identifiers associated with this metadata, or null if none.

Constructor Summary

Constructors

Constructor	Description
Default­Feature­Catalogue­Description()	Constructs an initially empty feature catalogue description.
Default­Feature­Catalogue­Description(Feature­Catalogue­Description object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Feature­Catalogue­Description	cast­Or­Copy(Feature­Catalogue­Description object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Citation>	get­Feature­Catalogue­Citations()	Returns the complete bibliographic reference to one or more external feature catalogues.
Collection<Default­Feature­Type­Info>	get­Feature­Type­Info()	Returns the subset of feature types from cited feature catalogue occurring in resource.
final Collection<Generic­Name>	get­Feature­Types()	Deprecated. As of ISO 19115:2014, replaced by get­Feature­Type­Info().
Collection<Locale>	get­Languages()	Deprecated. Replaced by get­Locales­And­Charsets().key­Set().
Map<Locale,Charset>	get­Locales­And­Charsets()	Returns the language(s) and character set(s) used within the catalogue.
Boolean	is­Compliant()	Returns whether or not the cited feature catalogue complies with ISO 19110.
boolean	is­Included­With­Dataset()	Returns whether or not the feature catalogue is included with the resource.
void	set­Compliant(Boolean new­Value)	Sets whether or not the cited feature catalogue complies with ISO 19110.
void	set­Feature­Catalogue­Citations(Collection<? extends Citation> new­Values)	Sets the complete bibliographic reference to one or more external feature catalogues.
void	set­Feature­Type­Info(Collection<? extends Default­Feature­Type­Info> new­Values)	Sets the subset of feature types from cited feature catalogue occurring in resource.
void	set­Feature­Types(Collection<? extends Generic­Name> new­Values)	Deprecated. As of ISO 19115:2014, replaced by set­Feature­Type­Info(Collection).
void	set­Included­With­Dataset(boolean new­Value)	Sets whether or not the feature catalogue is included with the resource.
void	set­Languages(Collection<? extends Locale> new­Values)	Deprecated. Replaced by putting keys in get­Locales­And­Charsets() map.
void	set­Locales­And­Charsets(Map<? extends Locale, ? extends Charset> new­Values)	Sets the language(s) and character set(s) used within the catalogue.

Methods inherited from class AbstractContentInformation

cast­Or­Copy

Modifier and Type	Method	Description
static Abstract­Content­Information	cast­Or­Copy(Content­Information object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, set­Identifier

Modifier and Type	Method	Description
protected Identifier	get­Identifier()	Returns the first identifier which is presumed to be defined by ISO 19115 conceptual model.
Identifier­Map	get­Identifier­Map()	A map view of the identifiers collection as (authority, code) entries.
Collection<Identifier>	get­Identifiers()	Returns all identifiers associated with this object (from conceptual model and from XML document).
Metadata­Standard	get­Standard()	Returns the metadata standard implemented by subclasses, which is ISO 19115.
protected void	set­Identifier(Identifier new­Value)	Sets the identifier for metadata objects that are expected to contain at most one ISO 19115 identifier.

Methods inherited from class ModifiableMetadata

check­Write­Permission, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, merge, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Modifier and Type	Method	Description
protected void	check­Write­Permission(Object current)	Checks if changes in the metadata are allowed.
protected static <E> Collection<E>	copy­Collection(Collection<? extends E> source, Class<E> element­Type)	Creates a list or set with the content of the source collection, or returns null if the source is null or empty.
protected static <E> List<E>	copy­List(Collection<? extends E> source, Class<E> element­Type)	Creates a list with the content of the source collection, or returns null if the source is null or empty.
protected static <K,V> Map<K,V>	copy­Map(Map<? extends K, ? extends V> source, Class<K> key­Type)	Creates a map with the content of the source map, or returns null if the source is null or empty.
protected static <E> Set<E>	copy­Set(Collection<? extends E> source, Class<E> element­Type)	Creates a set with the content of the source collection, or returns null if the source is null or empty.
Modifiable­Metadata	deep­Copy(Modifiable­Metadata.State target)	Copies (if necessary) this metadata and all its children.
void	merge(Object source)	Merges the data from the given source into this metadata.
protected final <E> Collection<E>	non­Null­Collection(Collection<E> current, Class<E> element­Type)	Returns the specified collection, or a new one if current is null.
protected final <E> List<E>	non­Null­List(List<E> current, Class<E> element­Type)	Returns the specified list, or a new one if current is null.
protected final <K,V> Map<K,V>	non­Null­Map(Map<K,V> current, Class<K> key­Type)	Returns the specified map, or a new one if current is null.
protected final <E> Set<E>	non­Null­Set(Set<E> current, Class<E> element­Type)	Returns the specified set, or a new one if current is null.
protected static <E> Collection<E>	singleton(E value, Class<E> element­Type)	Creates a singleton list or set containing only the given value, if non-null.
Modifiable­Metadata.State	state()	Tells whether this instance of metadata is editable.
protected final <E> Collection<E>	write­Collection(Collection<? extends E> source, Collection<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list or set, creating it if needed.
protected final <E> List<E>	write­List(Collection<? extends E> source, List<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list, creating it if needed.
protected final <K,V> Map<K,V>	write­Map(Map<? extends K, ? extends V> source, Map<K,V> target, Class<K> key­Type)	Writes the content of the source map into the target map, creating it if needed.
protected final <E> Set<E>	write­Set(Collection<? extends E> source, Set<E> target, Class<E> element­Type)	Writes the content of the source collection into the target set, creating it if needed.

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, clone, equals, equals, get­Interface, get­Standard­Type, hash­Code, is­Empty, nil­Reasons, prune, to­String

Modifier and Type	Method	Description
Map<String,Object>	as­Map()	Returns a view of the property values in a Map.
Tree­Table	as­Tree­Table()	Returns the property types and values as a tree table.
protected Abstract­Metadata	clone()	Returns a shallow clone of this metadata.
final boolean	equals(Object object)	Performs a strict comparison of this metadata with the given object.
boolean	equals(Object object, Comparison­Mode mode)	Compares this metadata with the specified object for equality.
final Class<?>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Metadata.get­Standard­Type() for integration with Lenient­Comparable.
Type	get­Standard­Type()	Returns the metadata interface implemented by this class.
int	hash­Code()	Computes a hash code value for this metadata using Java reflection.
boolean	is­Empty()	Returns true if this metadata contains only null, nil or empty properties.
Map<String, Nil­Reason>	nil­Reasons()	Returns a view of the reasons why some properties are missing.
void	prune()	Removes all references to empty properties.
String	to­String()	Returns a string representation of this metadata.

Methods inherited from class Object

finalize, get­Class, notify, notify­All, wait, wait, wait

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:

• cast­Or­Copy(Feature­Catalogue­Description)

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.