Module org.apache.sis.metadata

Package org.apache.sis.metadata.iso.quality

Class DefaultConformanceResult

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

AbstractResult

DefaultConformanceResult

All Implemented Interfaces:

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

public class DefaultConformanceResult
extends AbstractResult
implements ConformanceResult

Information about the outcome of evaluating the value(s) against a specified acceptable conformance quality level. See the Conformance­Result GeoAPI interface for more details. The following properties are mandatory in a well-formed metadata according ISO 19157:

DQ_Conformance­Result ├─specification…………… Citation of product specification or user requirement against which data is being evaluated. │ ├─title……………………… Name by which the cited resource is known. │ └─date………………………… Reference date for the cited resource. └─pass…………………………………… Indication of the conformance result.

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

Field Summary

Fields inherited from class ISOMetadata

identifiers

Constructor Summary

Constructors

Constructor	Description
Default­Conformance­Result()	Constructs an initially empty conformance result.
Default­Conformance­Result(Citation specification, Char­Sequence explanation, boolean pass)	Creates a conformance result initialized to the given values.
Default­Conformance­Result(Conformance­Result object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Conformance­Result	cast­Or­Copy(Conformance­Result object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
International­String	get­Explanation()	Returns the explanation of the meaning of conformance for this result.
Citation	get­Specification()	Returns the citation of product specification or user requirement against which data is being evaluated.
Metadata­Standard	get­Standard()	Returns the metadata standard, which is ISO 19157.
Boolean	pass()	Returns an indication of the conformance result.
void	set­Explanation(International­String new­Value)	Sets the explanation of the meaning of conformance for this result.
void	set­Pass(Boolean new­Value)	Sets the indication of the conformance result.
void	set­Specification(Citation new­Value)	Sets the citation of product specification or user requirement against which data is being evaluated.

Methods inherited from class AbstractResult

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

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, set­Identifier, transition­To

Methods inherited from class ModifiableMetadata

check­Write­Permission, collection­Type, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, equals, equals, get­Interface, hash­Code, is­Empty, prune, to­String

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Constructor Details

DefaultConformanceResult

public DefaultConformanceResult()

Constructs an initially empty conformance result.

DefaultConformanceResult

public DefaultConformanceResult(Citation specification,
 CharSequence explanation,
 boolean pass)

Creates a conformance result initialized to the given values.

Parameters:

specification - specification or requirement against which data is being evaluated, or null.

explanation - the meaning of conformance for this result, or null.

pass - indication of the conformance result, or null.

DefaultConformanceResult

public DefaultConformanceResult(ConformanceResult 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(Conformance­Result)

Method Details

castOrCopy

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

getSpecification

public Citation getSpecification()

Returns the citation of product specification or user requirement against which data is being evaluated.

Specified by:

get­Specification in interface Conformance­Result

Returns:

citation of product specification or user requirement, or null.

setSpecification

public void setSpecification(Citation newValue)

Sets the citation of product specification or user requirement against which data is being evaluated.

Parameters:

new­Value - the new specification.

getExplanation

public InternationalString getExplanation()

Returns the explanation of the meaning of conformance for this result.

Specified by:

get­Explanation in interface Conformance­Result

Returns:

explanation of the meaning of conformance, or null.

setExplanation

public void setExplanation(InternationalString newValue)

Sets the explanation of the meaning of conformance for this result.

Parameters:

new­Value - the new explanation.

pass

public Boolean pass()

Returns an indication of the conformance result.

Specified by:

pass in interface Conformance­Result

Returns:

indication of the conformance result, or null.

setPass

public void setPass(Boolean newValue)

Sets the indication of the conformance result.

Parameters:

new­Value - true if the test pass.

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.