Class DefaultEvaluationMethod

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultEvaluationMethod

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object

Direct Known Subclasses:

Abstract­Data­Evaluation, Default­Aggregation­Derivation

@TitleProperty(name="evaluationMethodDescription")
@UML(identifier="DQ_EvaluationMethod",
     specification=UNSPECIFIED)
public class DefaultEvaluationMethod
extends ISOMetadata

Description of the evaluation method and procedure applied.

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:

1.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­Evaluation­Method()	Constructs an initially empty evaluation method.
Default­Evaluation­Method(Default­Evaluation­Method object)	Constructs a new instance initialized with the values from the specified metadata object.
Default­Evaluation­Method(Evaluation­Method­Type type, Char­Sequence description)	Constructs an evaluation method initialized to the given description.

Method Summary

Modifier and Type	Method	Description
Collection<Temporal>	get­Dates()	Returns the date or range of dates on which a data quality measure was applied.
International­String	get­Evaluation­Method­Description()	Returns the description of the evaluation method.
Evaluation­Method­Type	get­Evaluation­Method­Type()	Returns the type of method used to evaluate quality of the data.
Citation	get­Evaluation­Procedure()	Returns the reference to the procedure information.
Collection<Citation>	get­Reference­Documents()	Returns information on documents which are referenced in developing and applying a data quality evaluation method.
Metadata­Standard	get­Standard()	Returns the metadata standard, which is ISO 19157.
void	set­Dates(Collection<? extends Temporal> new­Values)	Sets the date or range of dates on which a data quality measure was applied.
void	set­Evaluation­Method­Description(International­String new­Value)	Sets the description of the evaluation method.
void	set­Evaluation­Method­Type(Evaluation­Method­Type new­Value)	Sets the type of method used to evaluate quality of the data.
void	set­Evaluation­Procedure(Citation new­Value)	Sets the reference to the procedure information.
void	set­Reference­Documents(Collection<? extends Citation> new­Values)	Sets the information on documents referenced in data quality evaluation method.

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

DefaultEvaluationMethod

public DefaultEvaluationMethod()

Constructs an initially empty evaluation method.

DefaultEvaluationMethod

public DefaultEvaluationMethod(EvaluationMethodType type,
 CharSequence description)

Constructs an evaluation method initialized to the given description.

Parameters:

type - the method type, or null if none.

description - the method description as a String or an International­String object, or null if none.

Since:

1.5

DefaultEvaluationMethod

public DefaultEvaluationMethod(DefaultEvaluationMethod 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.

Method Details

getEvaluationMethodType

@UML(identifier="evaluationMethodType",
     obligation=OPTIONAL,
     specification=UNSPECIFIED)
public EvaluationMethodType getEvaluationMethodType()

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

Returns:

type of method used to evaluate quality, or null if none.

setEvaluationMethodType

public void setEvaluationMethodType(EvaluationMethodType newValue)

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

Parameters:

new­Value - the new evaluation method type.

getEvaluationMethodDescription

@UML(identifier="evaluationMethodDescription",
     obligation=OPTIONAL,
     specification=UNSPECIFIED)
public InternationalString getEvaluationMethodDescription()

Returns the description of the evaluation method.

Returns:

description of the evaluation method, or null if none.

setEvaluationMethodDescription

public void setEvaluationMethodDescription(InternationalString newValue)

Sets the description of the evaluation method.

Parameters:

new­Value - the new evaluation method description.

getEvaluationProcedure

@UML(identifier="evaluationProcedure",
     obligation=OPTIONAL,
     specification=UNSPECIFIED)
public Citation getEvaluationProcedure()

Returns the reference to the procedure information.

Returns:

reference to the procedure information, or null if none.

setEvaluationProcedure

public void setEvaluationProcedure(Citation newValue)

Sets the reference to the procedure information.

Parameters:

new­Value - the new evaluation procedure.

getReferenceDocuments

@UML(identifier="referenceDoc",
     obligation=OPTIONAL,
     specification=UNSPECIFIED)
public Collection<Citation> getReferenceDocuments()

Returns information on documents which are referenced in developing and applying a data quality evaluation method.

Returns:

documents referenced in data quality evaluation method.

setReferenceDocuments

public void setReferenceDocuments(Collection<? extends Citation> newValues)

Sets the information on documents referenced in data quality evaluation method.

Parameters:

new­Values - the new name of measures.

getDates

@UML(identifier="dateTime",
     obligation=OPTIONAL,
     specification=UNSPECIFIED)
public Collection<Temporal> getDates()

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.

Returns:

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

setDates

public void setDates(Collection<? extends Temporal> newValues)

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.

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.