Class AbstractElement

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

AbstractElement

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Element

Direct Known Subclasses:

Abstract­Completeness, Abstract­Logical­Consistency, Abstract­Metaquality, Abstract­Positional­Accuracy, Abstract­Temporal­Quality, Abstract­Thematic­Accuracy, Default­Usability

@TitleProperty(name="standaloneQualityReportDetails")
public class AbstractElement
extends ISOMetadata
implements Element

Aspect of quantitative quality information. See the Element GeoAPI interface for more details. The following property is mandatory in a well-formed metadata according ISO 19157:

DQ_Element └─result…………… Value obtained from applying a data quality measure.

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
Abstract­Element()	Constructs an initially empty element.
Abstract­Element(Element object)	Constructs a new instance initialized with the values from the specified metadata object.
Abstract­Element(Result result)	Creates an element initialized to the given result.

Method Summary

Modifier and Type	Method	Description
static Abstract­Element	cast­Or­Copy(Element object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Date>	get­Dates()	Deprecated. Replaced by Default­Evaluation­Method.get­Dates().
Collection<Element>	get­Derived­Elements()	Returns the original elements in case of aggregation or derivation.
Default­Evaluation­Method	get­Evaluation­Method()	Returns the evaluation information.
International­String	get­Evaluation­Method­Description()	Deprecated. Replaced by Default­Evaluation­Method.get­Evaluation­Method­Description().
Evaluation­Method­Type	get­Evaluation­Method­Type()	Deprecated. Replaced by Default­Evaluation­Method.get­Evaluation­Method­Type().
Citation	get­Evaluation­Procedure()	Deprecated. Replaced by Default­Evaluation­Method.get­Evaluation­Procedure().
International­String	get­Measure­Description()	Deprecated. Replaced by Default­Measure­Reference.get­Measure­Description().
Identifier	get­Measure­Identification()	Deprecated. Replaced by Default­Measure­Reference.get­Measure­Identification().
Default­Measure­Reference	get­Measure­Reference()	Returns an identifier of a measure fully described elsewhere.
Collection<International­String>	get­Names­Of­Measure()	Deprecated. Replaced by Default­Measure­Reference.get­Names­Of­Measure().
Collection<Result>	get­Results()	Returns the value(s) obtained from applying a data quality measure.
International­String	get­Standalone­Quality­Report­Details()	Returns the clause in the standalone quality report where this data quality element is described.
Metadata­Standard	get­Standard()	Returns the metadata standard, which is ISO 19157.
void	set­Dates(Collection<? extends Date> new­Values)	Deprecated. Replaced by Default­Evaluation­Method.set­Dates(Collection).
void	set­Derived­Elements(Collection<? extends Element> new­Values)	Sets the original elements in case of aggregation or derivation.
void	set­Evaluation­Method(Default­Evaluation­Method new­Value)	Sets the evaluation information.
void	set­Evaluation­Method­Description(International­String new­Value)	Deprecated. Replaced by Default­Evaluation­Method.set­Evaluation­Method­Description(International­String).
void	set­Evaluation­Method­Type(Evaluation­Method­Type new­Value)	Deprecated. Replaced by Default­Evaluation­Method.set­Evaluation­Method­Type(Evaluation­Method­Type).
void	set­Evaluation­Procedure(Citation new­Value)	Deprecated. Replaced by Default­Evaluation­Method.set­Evaluation­Procedure(Citation).
void	set­Measure­Description(International­String new­Value)	Deprecated. Replaced by Default­Measure­Reference.set­Measure­Description(International­String).
void	set­Measure­Identification(Identifier new­Value)	Deprecated. Replaced by Default­Measure­Reference.set­Measure­Identification(Identifier).
void	set­Measure­Reference(Default­Measure­Reference new­Values)	Sets an identifier of a measure fully described elsewhere.
void	set­Names­Of­Measure(Collection<? extends International­String> new­Values)	Deprecated. Replaced by Default­Measure­Reference.set­Names­Of­Measure(Collection).
void	set­Results(Collection<? extends Result> new­Values)	Sets the value(s) obtained from applying a data quality measure.
void	set­Standalone­Quality­Report­Details(International­String new­Value)	Sets the clause in the standalone quality report where this data quality element is described.

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

AbstractElement

public AbstractElement()

Constructs an initially empty element.

AbstractElement

public AbstractElement(Result result)

Creates an element initialized to the given result.

Parameters:

result - the value obtained from applying a data quality measure against a specified acceptable conformance quality level.

AbstractElement

public AbstractElement(Element 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(Element)

Method Details

castOrCopy

public static AbstractElement castOrCopy(Element 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 Positional­Accuracy, Thematic­Accuracy, Logical­Consistency or Completeness, then this method delegates to the cast­Or­Copy(…) method of the corresponding SIS subclass. Note that if the given object implements more than one of the above-cited interfaces, then the cast­Or­Copy(…) method to be used is unspecified.
• Otherwise if the given object is already an instance of Abstract­Element, then it is returned unchanged.
• Otherwise a new Abstract­Element 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.

getStandaloneQualityReportDetails

@UML(identifier="standaloneQualityReportDetails",
     obligation=OPTIONAL,
     specification=UNSPECIFIED)
public InternationalString getStandaloneQualityReportDetails()

Returns the clause in the standalone quality report where this data quality element is described. May apply to any related data quality element (original results in case of derivation or aggregation).

Returns:

clause where this data quality element is described, or null if none.

Since:

1.3

setStandaloneQualityReportDetails

public void setStandaloneQualityReportDetails(InternationalString newValue)

Sets the clause in the standalone quality report where this data quality element is described.

Parameters:

new­Value - the clause in the standalone quality report.

Since:

1.3

getMeasureReference

@UML(identifier="measure",
     obligation=OPTIONAL,
     specification=UNSPECIFIED)
public DefaultMeasureReference getMeasureReference()

Returns an identifier of a measure fully described elsewhere.

Returns:

reference to the measure used, or null if none.

Since:

1.3

setMeasureReference

public void setMeasureReference(DefaultMeasureReference newValues)

Sets an identifier of a measure fully described elsewhere.

Parameters:

new­Values - the new measure identifier.

Since:

1.3

getNamesOfMeasure

@Deprecated(since="1.3")
public Collection<InternationalString> getNamesOfMeasure()

Deprecated.

Replaced by Default­Measure­Reference.get­Names­Of­Measure().

Returns the name of the test applied to the data.

Specified by:

get­Names­Of­Measure in interface Element

Returns:

name of the test applied to the data.

setNamesOfMeasure

@Deprecated(since="1.3")
public void setNamesOfMeasure(Collection<? extends InternationalString> newValues)

Deprecated.

Replaced by Default­Measure­Reference.set­Names­Of­Measure(Collection).

Sets the name of the test applied to the data.

Parameters:

new­Values - the new name of measures.

getMeasureIdentification

@Deprecated(since="1.3")
public Identifier getMeasureIdentification()

Deprecated.

Replaced by Default­Measure­Reference.get­Measure­Identification().

Returns the code identifying a registered standard procedure, or null if none.

Specified by:

get­Measure­Identification in interface Element

Returns:

code identifying a registered standard procedure, or null.

setMeasureIdentification

@Deprecated(since="1.3")
public void setMeasureIdentification(Identifier newValue)

Deprecated.

Replaced by Default­Measure­Reference.set­Measure­Identification(Identifier).

Sets the code identifying a registered standard procedure.

Parameters:

new­Value - the new measure identification.

getMeasureDescription

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

Deprecated.

Replaced by Default­Measure­Reference.get­Measure­Description().

Returns the description of the measure being determined.

Specified by:

get­Measure­Description in interface Element

Returns:

description of the measure being determined, or null.

setMeasureDescription

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

Deprecated.

Replaced by Default­Measure­Reference.set­Measure­Description(International­String).

Sets the description of the measure being determined.

Parameters:

new­Value - the new measure description.

getEvaluationMethod

@UML(identifier="evaluationMethod",
     obligation=OPTIONAL,
     specification=UNSPECIFIED)
public DefaultEvaluationMethod getEvaluationMethod()

Returns the evaluation information.

Returns:

information about the evaluation method, or null if none.

Since:

1.3

setEvaluationMethod

public void setEvaluationMethod(DefaultEvaluationMethod newValue)

Sets the evaluation information.

Parameters:

new­Value - the new evaluation information.

Since:

1.3

getEvaluationMethodType

@Deprecated(since="1.3")
public EvaluationMethodType getEvaluationMethodType()

Deprecated.

Replaced by Default­Evaluation­Method.get­Evaluation­Method­Type().

Returns the type of method used to evaluate quality of the dataset.

Specified by:

get­Evaluation­Method­Type in interface Element

Returns:

type of method used to evaluate quality, or null.

setEvaluationMethodType

@Deprecated(since="1.3")
public void setEvaluationMethodType(EvaluationMethodType newValue)

Deprecated.

Replaced by Default­Evaluation­Method.set­Evaluation­Method­Type(Evaluation­Method­Type).

Sets the type of method used to evaluate quality of the dataset.

Parameters:

new­Value - the new evaluation method type.

getEvaluationMethodDescription

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

Deprecated.

Replaced by Default­Evaluation­Method.get­Evaluation­Method­Description().

Returns the description of the evaluation method.

Specified by:

get­Evaluation­Method­Description in interface Element

Returns:

description of the evaluation method, or null.

setEvaluationMethodDescription

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

Deprecated.

Replaced by Default­Evaluation­Method.set­Evaluation­Method­Description(International­String).

Sets the description of the evaluation method.

Parameters:

new­Value - the new evaluation method description.

getEvaluationProcedure

@Deprecated(since="1.3")
public Citation getEvaluationProcedure()

Deprecated.

Replaced by Default­Evaluation­Method.get­Evaluation­Procedure().

Returns the reference to the procedure information, or null if none.

Specified by:

get­Evaluation­Procedure in interface Element

Returns:

reference to the procedure information, or null.

setEvaluationProcedure

@Deprecated(since="1.3")
public void setEvaluationProcedure(Citation newValue)

Deprecated.

Replaced by Default­Evaluation­Method.set­Evaluation­Procedure(Citation).

Sets the reference to the procedure information.

Parameters:

new­Value - the new evaluation procedure.

getDates

@Deprecated(since="1.3")
public Collection<Date> getDates()

Deprecated.

Replaced by Default­Evaluation­Method.get­Dates().

Returns the date or range of dates on which a data quality measure was applied. The collection size is 1 for a single date, or 2 for a range. Returns an empty collection if this information is not available.

Specified by:

get­Dates in interface Element

Returns:

date or range of dates on which a data quality measure was applied.

setDates

@Deprecated(since="1.3")
public void setDates(Collection<? extends Date> newValues)

Deprecated.

Replaced by Default­Evaluation­Method.set­Dates(Collection).

Sets the date or range of dates on which a data quality measure was applied. The collection size is 1 for a single date, or 2 for a range.

Parameters:

new­Values - the new dates, or null.

getResults

public Collection<Result> getResults()

Returns the value(s) obtained from applying a data quality measure. May be an outcome of evaluating the obtained value (or set of values) against a specified acceptable conformance quality level.

Specified by:

get­Results in interface Element

Returns:

set of values obtained from applying a data quality measure.

setResults

public void setResults(Collection<? extends Result> newValues)

Sets the value(s) obtained from applying a data quality measure.

Parameters:

new­Values - the new set of value.

getDerivedElements

@UML(identifier="derivedElement",
     obligation=OPTIONAL,
     specification=UNSPECIFIED)
public Collection<Element> getDerivedElements()

Returns the original elements in case of aggregation or derivation.

Returns:

original element(s) when there is an aggregation or derivation.

Since:

1.3

setDerivedElements

public void setDerivedElements(Collection<? extends Element> newValues)

Sets the original elements in case of aggregation or derivation.

Parameters:

new­Values - the new elements.

Since:

1.3

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.