Class DefaultCoverageResult

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

AbstractResult

DefaultCoverageResult

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Coverage­Result, Result

public class DefaultCoverageResult
extends AbstractResult
implements CoverageResult

Result of a data quality measure organising the measured values as a coverage. The following properties are mandatory or conditional in a well-formed metadata according ISO 19157:

DQ_Coverage­Result ├─spatial­Representation­Type…………………… Method used to spatially represent the coverage result. ├─result­Spatial­Representation……………… Digital representation of data quality measures composing the coverage result. ├─result­Content…………………………………………………… Description of the content of the result coverage, i.e. semantic definition of the data quality measures. ├─result­Format……………………………………………………… Information about the format of the result coverage data. │ └─format­Specification­Citation…… Citation/URL of the specification format. │ ├─title…………………………………………………… Name by which the cited resource is known. │ └─date……………………………………………………… Reference date for the cited resource. └─result­File…………………………………………………………… Information about the data file containing the result coverage data. └─file­Format………………………………………………… Defines the format of the transfer data file.

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

Method Summary

Modifier and Type	Method	Description
static Default­Coverage­Result	cast­Or­Copy(Coverage­Result object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Range­Dimension>	get­Result­Content()	Provides the description of the content of the result coverage.
Coverage­Description	get­Result­Content­Description()	Deprecated. Replaced by get­Result­Content().
Data­File	get­Result­File()	Returns the information about the data file containing the result coverage data.
Format	get­Result­Format()	Returns the information about the format of the result coverage data.
Spatial­Representation	get­Result­Spatial­Representation()	Returns the digital representation of data quality measures composing the coverage result.
Spatial­Representation­Type	get­Spatial­Representation­Type()	Returns the method used to spatially represent the coverage result.
Metadata­Standard	get­Standard()	Returns the metadata standard, which is ISO 19157.
void	set­Result­Content(Collection<Range­Dimension> new­Values)	Sets the description of the content of the result coverage.
void	set­Result­Content­Description(Coverage­Description new­Value)	Deprecated. Replaced by set­Result­Content(Collection).
void	set­Result­File(Data­File new­Value)	Sets the information about the data file containing the result coverage data.
void	set­Result­Format(Format new­Value)	Sets the information about the format of the result coverage data.
void	set­Result­Spatial­Representation(Spatial­Representation new­Value)	Sets the digital representation of data quality measures composing the coverage result.
void	set­Spatial­Representation­Type(Spatial­Representation­Type new­Value)	Sets the method used to spatially represent the coverage result.

Methods inherited from class AbstractResult

cast­Or­Copy, get­Date­Time, get­Result­Scope, set­Date­Time, set­Result­Scope

Modifier and Type	Method	Description
static Abstract­Result	cast­Or­Copy(Result object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Temporal	get­Date­Time()	Returns the date when the result was generated.
Scope	get­Result­Scope()	Returns the scope of the result.
void	set­Date­Time(Temporal new­Value)	Sets the date when the result was generated.
void	set­Result­Scope(Scope new­Value)	Sets the scope of the result.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, 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).
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

DefaultCoverageResult

public DefaultCoverageResult()

Constructs an initially empty coverage result.

DefaultCoverageResult

public DefaultCoverageResult(CoverageResult 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­Result)

Method Details

castOrCopy

public static DefaultCoverageResult castOrCopy(CoverageResult 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­Coverage­Result, then it is returned unchanged.
• Otherwise a new Default­Coverage­Result 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.

getSpatialRepresentationType

public SpatialRepresentationType getSpatialRepresentationType()

Returns the method used to spatially represent the coverage result.

Specified by:

get­Spatial­Representation­Type in interface Coverage­Result

Returns:

spatial representation of the coverage result.

setSpatialRepresentationType

public void setSpatialRepresentationType(SpatialRepresentationType newValue)

Sets the method used to spatially represent the coverage result.

Parameters:

new­Value - the new spatial representation type value.

getResultSpatialRepresentation

public SpatialRepresentation getResultSpatialRepresentation()

Returns the digital representation of data quality measures composing the coverage result.

Specified by:

get­Result­Spatial­Representation in interface Coverage­Result

Returns:

digital representation of data quality measures composing the coverage result.

setResultSpatialRepresentation

public void setResultSpatialRepresentation(SpatialRepresentation newValue)

Sets the digital representation of data quality measures composing the coverage result.

Parameters:

new­Value - the new spatial representation value.

getResultContent

@UML(identifier="resultContent",
     obligation=CONDITIONAL,
     specification=UNSPECIFIED)
public Collection<RangeDimension> getResultContent()

Provides the description of the content of the result coverage. This is the semantic definition of the data quality measures.

Returns:

description of the content of the result coverage.

Since:

1.3

setResultContent

public void setResultContent(Collection<RangeDimension> newValues)

Sets the description of the content of the result coverage.

Parameters:

new­Values - the new descriptions.

Since:

1.3

getResultContentDescription

@Deprecated(since="1.3")
public CoverageDescription getResultContentDescription()

Deprecated.

Replaced by get­Result­Content().

Returns the description of the content of the result coverage, i.e. semantic definition of the data quality measures.

Specified by:

get­Result­Content­Description in interface Coverage­Result

Returns:

description of the content of the result coverage, or null.

setResultContentDescription

@Deprecated(since="1.3")
public void setResultContentDescription(CoverageDescription newValue)

Deprecated.

Replaced by set­Result­Content(Collection).

Sets the description of the content of the result coverage, i.e. semantic definition of the data quality measures.

Parameters:

new­Value - the new content description value.

getResultFormat

public Format getResultFormat()

Returns the information about the format of the result coverage data.

Specified by:

get­Result­Format in interface Coverage­Result

Returns:

format of the result coverage data, or null.

setResultFormat

public void setResultFormat(Format newValue)

Sets the information about the format of the result coverage data.

Parameters:

new­Value - the new result format value.

getResultFile

public DataFile getResultFile()

Returns the information about the data file containing the result coverage data.

Specified by:

get­Result­File in interface Coverage­Result

Returns:

data file containing the result coverage data, or null.

setResultFile

public void setResultFile(DataFile newValue)

Sets the information about the data file containing the result coverage data.

Parameters:

new­Value - the new result file value.

getStandard

public MetadataStandard getStandard()

Returns the metadata standard, which is ISO 19157.

Overrides:

get­Standard in class ISOMetadata

Returns:

the metadata standard, which is ISO 19157.