Module org.apache.sis.metadata

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

Class DefaultBasicMeasure

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultBasicMeasure

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object

@UML(identifier="DQM_BasicMeasure",
     specification=UNSPECIFIED)
public class DefaultBasicMeasure
extends ISOMetadata

Data quality basic measure. The following property is mandatory in a well-formed metadata according ISO 19157:

DQM_Basic­Measure ├─name…………………… Name of the data quality basic measure applied to the data. ├─definition…… Definition of the data quality basic measure. ├─example…………… Illustration of the use of a data quality measure. └─value­Type……… Value type for the result of the basic measure (shall be one of the data types defined in ISO/TS 19103:2005).

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

Field Summary

Fields inherited from class ISOMetadata

identifiers

Constructor Summary

Constructors

Constructor	Description
Default­Basic­Measure()	Constructs an initially empty basic measure.
Default­Basic­Measure(Default­Basic­Measure object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
International­String	get­Definition()	Returns the definition of the data quality basic measure.
Default­Measure­Description	get­Example()	Returns the illustration of the use of a data quality measure.
International­String	get­Name()	Returns the name of the data quality basic measure.
Metadata­Standard	get­Standard()	Returns the metadata standard, which is ISO 19157.
Type­Name	get­Value­Type()	Returns the value type for the result of the basic measure.
void	set­Definition(International­String new­Value)	Sets the definition of the data quality basic measure.
void	set­Example(Default­Measure­Description new­Values)	Sets the illustration of the use of a data quality measure.
void	set­Name(International­String new­Value)	Sets the name of the data quality basic measure.
void	set­Value­Type(Type­Name new­Value)	Sets the value type for the result of the basic measure.

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

DefaultBasicMeasure

public DefaultBasicMeasure()

Constructs an initially empty basic measure.

DefaultBasicMeasure

public DefaultBasicMeasure(DefaultBasicMeasure 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

getName

@UML(identifier="name",
     obligation=MANDATORY,
     specification=UNSPECIFIED)
public InternationalString getName()

Returns the name of the data quality basic measure.

Returns:

name of the data quality basic measure.

setName

public void setName(InternationalString newValue)

Sets the name of the data quality basic measure.

Parameters:

new­Value - the new basic measure name.

getDefinition

@UML(identifier="definition",
     obligation=MANDATORY,
     specification=UNSPECIFIED)
public InternationalString getDefinition()

Returns the definition of the data quality basic measure.

Returns:

definition of the data quality basic measure.

setDefinition

public void setDefinition(InternationalString newValue)

Sets the definition of the data quality basic measure.

Parameters:

new­Value - the new basic measure definition.

getExample

@UML(identifier="example",
     obligation=OPTIONAL,
     specification=UNSPECIFIED)
public DefaultMeasureDescription getExample()

Returns the illustration of the use of a data quality measure.

Returns:

usage example, or null if none.

setExample

public void setExample(DefaultMeasureDescription newValues)

Sets the illustration of the use of a data quality measure.

Parameters:

new­Values - the new basic measure example.

getValueType

@UML(identifier="valueType",
     obligation=MANDATORY,
     specification=UNSPECIFIED)
public TypeName getValueType()

Returns the value type for the result of the basic measure.

Returns:

value type of the result for the basic measure.

setValueType

public void setValueType(TypeName newValue)

Sets the value type for the result of the basic measure.

Parameters:

new­Value - the new basic measure value type.

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.