Class DefaultQuantitativeResult

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

AbstractResult

DefaultQuantitativeResult

All Implemented Interfaces:

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

public class DefaultQuantitativeResult
extends AbstractResult
implements QuantitativeResult

Information about the value (or set of values) obtained from applying a data quality measure. See the Quantitative­Result GeoAPI interface for more details. The following properties are mandatory in a well-formed metadata according ISO 19157:

DQ_Quantitative­Result ├─value­Unit…………………… Value unit for reporting a data quality result. └─value……………………………… Quantitative value or values, content determined by the evaluation procedure used.

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

Method Summary

Modifier and Type	Method	Description
static Default­Quantitative­Result	cast­Or­Copy(Quantitative­Result object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
International­String	get­Error­Statistic()	Deprecated. Removed from ISO_19157:2013.
Metadata­Standard	get­Standard()	Returns the metadata standard, which is ISO 19157.
List<Record>	get­Values()	Returns the quantitative value or values, content determined by the evaluation procedure used.
Record­Type	get­Value­Type()	Returns the value type for reporting a data quality result.
Unit<?>	get­Value­Unit()	Returns the value unit for reporting a data quality result.
void	set­Error­Statistic(International­String new­Value)	Deprecated. Removed from ISO_19157:2013.
void	set­Values(List<? extends Record> new­Values)	Sets the quantitative value or values, content determined by the evaluation procedure used.
void	set­Value­Type(Record­Type new­Value)	Sets the value type for reporting a data quality result.
void	set­Value­Unit(Unit<?> new­Value)	Sets the value unit for reporting a data quality 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, 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.
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

DefaultQuantitativeResult

public DefaultQuantitativeResult()

Constructs an initially empty quantitative result.

DefaultQuantitativeResult

public DefaultQuantitativeResult(QuantitativeResult 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(Quantitative­Result)

Method Details

castOrCopy

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

getValues

public List<Record> getValues()

Returns the quantitative value or values, content determined by the evaluation procedure used.

Specified by:

get­Values in interface Quantitative­Result

Returns:

Quantitative value or values.

setValues

public void setValues(List<? extends Record> newValues)

Sets the quantitative value or values, content determined by the evaluation procedure used.

Parameters:

new­Values - the new values.

getValueType

public RecordType getValueType()

Returns the value type for reporting a data quality result.

Default value

If no type has been set but all values are of the same type, then this method defaults to that type. Otherwise this method returns null.

Specified by:

get­Value­Type in interface Quantitative­Result

Returns:

value type for reporting a data quality result, or null.

setValueType

public void setValueType(RecordType newValue)

Sets the value type for reporting a data quality result. A null value restores the default value documented in get­Value­Type().

Parameters:

new­Value - the new value type.

getValueUnit

public Unit<?> getValueUnit()

Returns the value unit for reporting a data quality result.

Specified by:

get­Value­Unit in interface Quantitative­Result

Returns:

value unit for reporting a data quality result, or null.

setValueUnit

public void setValueUnit(Unit<?> newValue)

Sets the value unit for reporting a data quality result.

Parameters:

new­Value - the new value unit.

getErrorStatistic

@Deprecated(since="1.3")
public InternationalString getErrorStatistic()

Deprecated.

Removed from ISO_19157:2013.

Returns the statistical method used to determine the value.

Specified by:

get­Error­Statistic in interface Quantitative­Result

Returns:

statistical method used to determine the value, or null.

setErrorStatistic

@Deprecated(since="1.3")
public void setErrorStatistic(InternationalString newValue)

Deprecated.

Removed from ISO_19157:2013.

Sets the statistical method used to determine the value, or null if none.

Parameters:

new­Value - the new error statistic.

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.