Class DefaultCoverageDescription

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

AbstractContentInformation

DefaultCoverageDescription

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Content­Information, Coverage­Description

Direct Known Subclasses:

Default­Image­Description

public class DefaultCoverageDescription
extends AbstractContentInformation
implements CoverageDescription

Information about the content of a grid data cell. The following property is mandatory in a well-formed metadata according ISO 19115:

MD_Coverage­Description └─attribute­Description…… Description of the attribute described by the measurement value.

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­Coverage­Description()	Constructs an empty coverage description.
Default­Coverage­Description(Coverage­Description object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Coverage­Description	cast­Or­Copy(Coverage­Description object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Record­Type	get­Attribute­Description()	Returns the description of the attribute described by the measurement value.
Collection<Default­Attribute­Group>	get­Attribute­Groups()	Returns information on attribute groups of the resource.
Coverage­Content­Type	get­Content­Type()	Deprecated. As of ISO 19115:2014, moved to Default­Attribute­Group.get­Content­Types().
final Collection<Range­Dimension>	get­Dimensions()	Deprecated. As of ISO 19115:2014, moved to Default­Attribute­Group.get­Attributes().
Identifier	get­Processing­Level­Code()	Returns an identifier for the level of processing that has been applied to the resource, or null if none.
Collection<Range­Element­Description>	get­Range­Element­Descriptions()	Provides the description of the specific range elements of a coverage.
void	set­Attribute­Description(Record­Type new­Value)	Sets the description of the attribute described by the measurement value.
void	set­Attribute­Groups(Collection<? extends Default­Attribute­Group> new­Values)	Sets information on attribute groups of the resource.
void	set­Content­Type(Coverage­Content­Type new­Value)	Deprecated. As of ISO 19115:2014, moved to Default­Attribute­Group.set­Content­Types(Collection).
void	set­Dimensions(Collection<? extends Range­Dimension> new­Values)	Deprecated. As of ISO 19115:2014, moved to Default­Attribute­Group.set­Attributes(Collection).
void	set­Processing­Level­Code(Identifier new­Value)	Sets the identifier for the level of processing that has been applied to the resource.
void	set­Range­Element­Descriptions(Collection<? extends Range­Element­Description> new­Values)	Sets the description of the specific range elements of a coverage.

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

DefaultCoverageDescription

public DefaultCoverageDescription()

Constructs an empty coverage description.

DefaultCoverageDescription

public DefaultCoverageDescription(CoverageDescription 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(Coverage­Description)

Method Details

castOrCopy

public static DefaultCoverageDescription castOrCopy(CoverageDescription 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 an instance of Image­Description, then this method delegates to the cast­Or­Copy(…) method of the corresponding SIS subclass.
• Otherwise if the given object is already an instance of Default­Coverage­Description, then it is returned unchanged.
• Otherwise a new Default­Coverage­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.

getAttributeDescription

public RecordType getAttributeDescription()

Returns the description of the attribute described by the measurement value.

Specified by:

get­Attribute­Description in interface Coverage­Description

Returns:

description of the attribute.

setAttributeDescription

public void setAttributeDescription(RecordType newValue)

Sets the description of the attribute described by the measurement value.

Parameters:

new­Value - the new attribute description.

getProcessingLevelCode

@UML(identifier="processingLevelCode",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Identifier getProcessingLevelCode()

Returns an identifier for the level of processing that has been applied to the resource, or null if none. For image descriptions, this is the image distributor's code that identifies the level of radiometric and geometric processing that has been applied.

Returns:

identifier for the level of processing that has been applied to the resource, or null if none.

Since:

0.5

setProcessingLevelCode

public void setProcessingLevelCode(Identifier newValue)

Sets the identifier for the level of processing that has been applied to the resource.

Parameters:

new­Value - the new identifier for the level of processing.

Since:

0.5

getAttributeGroups

@UML(identifier="attributeGroup",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<DefaultAttributeGroup> getAttributeGroups()

Returns information on attribute groups of the resource.

Upcoming API change — generalization
The element type will be changed to the Attribute­Group interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).

Returns:

information on attribute groups of the resource.

Since:

0.5

setAttributeGroups

public void setAttributeGroups(Collection<? extends DefaultAttributeGroup> newValues)

Sets information on attribute groups of the resource.

Upcoming API change — generalization
The element type will be changed to the Attribute­Group interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).

Parameters:

new­Values - the new information on attribute groups of the resource.

Since:

0.5

getContentType

@Deprecated(since="1.0")
public CoverageContentType getContentType()

Deprecated.

As of ISO 19115:2014, moved to Default­Attribute­Group.get­Content­Types().

Returns the type of information represented by the cell value. This method fetches the value from the attribute groups.

Specified by:

get­Content­Type in interface Coverage­Description

Returns:

type of information represented by the cell value, or null.

setContentType

@Deprecated(since="1.0")
public void setContentType(CoverageContentType newValue)

Deprecated.

As of ISO 19115:2014, moved to Default­Attribute­Group.set­Content­Types(Collection).

Sets the type of information represented by the cell value. This method stores the value in the first writable attribute groups.

Parameters:

new­Value - the new content type.

getDimensions

@Deprecated(since="1.0")
public final Collection<RangeDimension> getDimensions()

Deprecated.

As of ISO 19115:2014, moved to Default­Attribute­Group.get­Attributes().

Returns the information on the dimensions of the cell measurement value. This method fetches the values from the first attribute groups.

Specified by:

get­Dimensions in interface Coverage­Description

Returns:

dimensions of the cell measurement value.

setDimensions

@Deprecated(since="1.0")
public void setDimensions(Collection<? extends RangeDimension> newValues)

Deprecated.

As of ISO 19115:2014, moved to Default­Attribute­Group.set­Attributes(Collection).

Sets the information on the dimensions of the cell measurement value. This method stores the values in the attribute groups.

Parameters:

new­Values - the new dimensions.

getRangeElementDescriptions

public Collection<RangeElementDescription> getRangeElementDescriptions()

Provides the description of the specific range elements of a coverage.

Specified by:

get­Range­Element­Descriptions in interface Coverage­Description

Returns:

description of the specific range elements of a coverage.

setRangeElementDescriptions

public void setRangeElementDescriptions(Collection<? extends RangeElementDescription> newValues)

Sets the description of the specific range elements of a coverage.

Parameters:

new­Values - the new range element description.