Class DefaultSampleDimension

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultRangeDimension

DefaultSampleDimension

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Range­Dimension

Direct Known Subclasses:

Default­Band

@UML(identifier="MD_SampleDimension",
     specification=ISO_19115)
public class DefaultSampleDimension
extends DefaultRangeDimension

The characteristic of each dimension (layer) included in the resource. The following property is conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:

MD_Sample­Dimension └─units……………………… Units of data in each dimension included in the resource.

Note on International Standard versions
This class is derived from a new type defined in the ISO 19115 international standard published in 2014, while GeoAPI 3.0 is based on the version published in 2003. Consequently this implementation class does not yet implement a GeoAPI interface, but is expected to do so after the next GeoAPI releases. When the interface will become available, all references to this implementation class in Apache SIS will be replaced be references to the Sample­Dimension interface.

Terminology

Data values should be physical values expressed in the unit of measurement given by get­Units(). Cell values are values stored in the device, before conversion to data values by application of scale factor and offset.

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.5

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­Sample­Dimension()	Constructs an initially empty sample dimension.
Default­Sample­Dimension(Default­Sample­Dimension object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
Integer	get­Bits­Per­Value()	Returns the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.
Double	get­Max­Value()	Returns the maximum value of data values in each dimension included in the resource.
Double	get­Mean­Value()	Returns the mean value of data values in each dimension included in the resource.
Double	get­Min­Value()	Returns the minimum value of data values in each dimension included in the resource.
Double	get­Nominal­Spatial­Resolution()	Returns the smallest distance between which separate points can be distinguished, as specified in instrument design.
Integer	get­Number­Of­Values()	Returns the number of values used in a thematic classification resource.
Double	get­Offset()	Returns the physical value corresponding to a cell value of zero.
Record	get­Other­Property()	Returns instance of other/attributeType that defines attributes not explicitly included in Coverage­Content­Type, or null if none.
Record­Type	get­Other­Property­Type()	Returns type of other attribute description.
Collection<Range­Element­Description>	get­Range­Element­Descriptions()	Provides the description and values of the specific range elements of a sample dimension.
Double	get­Scale­Factor()	Returns the scale factor which has been applied to the cell value.
Double	get­Standard­Deviation()	Returns the standard deviation of data values in each dimension included in the resource.
Transfer­Function­Type	get­Transfer­Function­Type()	Returns type of transfer function to be used when scaling a physical value for a given element.
Unit<?>	get­Units()	Returns the units of data in the dimension.
void	set­Bits­Per­Value(Integer new­Value)	Sets the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.
void	set­Max­Value(Double new­Value)	Sets the maximum value of data values in each dimension included in the resource.
void	set­Mean­Value(Double new­Value)	Sets the mean value of data values in each dimension included in the resource.
void	set­Min­Value(Double new­Value)	Sets the minimum value of data values in each dimension included in the resource.
void	set­Nominal­Spatial­Resolution(Double new­Value)	Sets the smallest distance between which separate points can be distinguished, as specified in instrument design.
void	set­Number­Of­Values(Integer new­Value)	Sets the number of values used in a thematic classification resource.
void	set­Offset(Double new­Value)	Sets the physical value corresponding to a cell value of zero.
void	set­Other­Property(Record new­Value)	Sets a new instance of other/attributeType that defines attributes not explicitly included in Coverage­Content­Type.
void	set­Other­Property­Type(Record­Type new­Value)	Sets a new type of other attribute description.
void	set­Range­Element­Descriptions(Collection<? extends Range­Element­Description> new­Values)	Sets the description and values of the specific range elements of a sample dimension.
void	set­Scale­Factor(Double new­Value)	Sets the scale factor which has been applied to the cell value.
void	set­Standard­Deviation(Double new­Value)	Sets the standard deviation of data values in each dimension included in the resource.
void	set­Transfer­Function­Type(Transfer­Function­Type new­Value)	Sets the type of transfer function to be used when scaling a physical value for a given element.
void	set­Units(Unit<?> new­Value)	Sets the units of data in the dimension.

Methods inherited from class DefaultRangeDimension

cast­Or­Copy, get­Description, get­Descriptor, get­Names, get­Sequence­Identifier, set­Description, set­Descriptor, set­Names, set­Sequence­Identifier

Modifier and Type	Method	Description
static Default­Range­Dimension	cast­Or­Copy(Range­Dimension object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
International­String	get­Description()	Returns the description of the attribute.
International­String	get­Descriptor()	Deprecated. As of ISO 19115:2014, renamed Default­Range­Dimension.get­Description().
Collection<Identifier>	get­Names()	Returns the identifiers for each attribute included in the resource.
Member­Name	get­Sequence­Identifier()	Returns a unique name or number that identifies attributes included in the coverage.
void	set­Description(International­String new­Value)	Sets the description of the attribute.
void	set­Descriptor(International­String new­Value)	Deprecated. As of ISO 19115:2014, renamed Default­Range­Dimension.set­Description(International­String).
void	set­Names(Collection<? extends Identifier> new­Values)	Sets the identifiers for each attribute included in the resource.
void	set­Sequence­Identifier(Member­Name new­Value)	Sets the name or number that uniquely identifies instances of bands of wavelengths on which a sensor operates.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, 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).
Metadata­Standard	get­Standard()	Returns the metadata standard implemented by subclasses, which is ISO 19115.
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

DefaultSampleDimension

public DefaultSampleDimension()

Constructs an initially empty sample dimension.

DefaultSampleDimension

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

Note on properties validation

This constructor does not verify the property values of the given metadata (e.g. whether it contains unexpected negative values). This is because invalid metadata exist in practice, and verifying their validity in this copy constructor is often too late. Note that this is not the only hole, as invalid metadata instances can also be obtained by unmarshalling an invalid XML document.

Parameters:

object - the metadata to copy values from, or null if none.

Method Details

getNumberOfValues

@ValueRange(minimum=0.0)
@UML(identifier="numberOfValues",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Integer getNumberOfValues()

Returns the number of values used in a thematic classification resource.

Returns:

the number of values used in a thematic classification resource, or null if none.

setNumberOfValues

public void setNumberOfValues(Integer newValue)

Sets the number of values used in a thematic classification resource.

Parameters:

new­Value - the new number of values used in a thematic classification resource.

Throws:

Illegal­Argument­Exception - if the given value is negative.

getMinValue

@UML(identifier="minValue",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Double getMinValue()

Returns the minimum value of data values in each dimension included in the resource. This value should be expressed in the unit of measurement given by get­Units().

Returns:

minimum value of data values in each dimension included in the resource, or null if unspecified.

setMinValue

public void setMinValue(Double newValue)

Sets the minimum value of data values in each dimension included in the resource. This value should be expressed in the unit of measurement given by get­Units().

Parameters:

new­Value - the new new minimum value.

getMaxValue

@UML(identifier="maxValue",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Double getMaxValue()

Returns the maximum value of data values in each dimension included in the resource. This value should be expressed in the unit of measurement given by get­Units().

Returns:

maximum value of data values in each dimension included in the resource, or null if unspecified.

setMaxValue

public void setMaxValue(Double newValue)

Sets the maximum value of data values in each dimension included in the resource. This value should be expressed in the unit of measurement given by get­Units().

Parameters:

new­Value - the new new maximum value.

getMeanValue

@UML(identifier="meanValue",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Double getMeanValue()

Returns the mean value of data values in each dimension included in the resource. This value should be expressed in the unit of measurement given by get­Units().

Returns:

the mean value of data values in each dimension included in the resource, or null if none.

setMeanValue

public void setMeanValue(Double newValue)

Sets the mean value of data values in each dimension included in the resource. This value should be expressed in the unit of measurement given by get­Units().

Parameters:

new­Value - the new mean value of data values in each dimension included in the resource.

getStandardDeviation

@UML(identifier="standardDeviation",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Double getStandardDeviation()

Returns the standard deviation of data values in each dimension included in the resource. This value should be expressed in the unit of measurement given by get­Units().

Returns:

standard deviation of data values in each dimension included in the resource, or null if none.

setStandardDeviation

public void setStandardDeviation(Double newValue)

Sets the standard deviation of data values in each dimension included in the resource. This value should be expressed in the unit of measurement given by get­Units().

Parameters:

new­Value - the new standard deviation of data values in each dimension included in the resource.

getUnits

@UML(identifier="units",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public Unit<?> getUnits()

Returns the units of data in the dimension.

Returns:

the units of data in the dimension, or null if unspecified.

setUnits

public void setUnits(Unit<?> newValue)

Sets the units of data in the dimension.

Parameters:

new­Value - the new units of data in the dimension.

getScaleFactor

@UML(identifier="scaleFactor",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Double getScaleFactor()

Returns the scale factor which has been applied to the cell value.

Returns:

scale factor which has been applied to the cell value, or null if none.

setScaleFactor

public void setScaleFactor(Double newValue)

Sets the scale factor which has been applied to the cell value.

Parameters:

new­Value - the new scale factor which has been applied to the cell value.

getOffset

@UML(identifier="offset",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Double getOffset()

Returns the physical value corresponding to a cell value of zero.

Returns:

the physical value corresponding to a cell value of zero, or null if none.

setOffset

public void setOffset(Double newValue)

Sets the physical value corresponding to a cell value of zero.

Parameters:

new­Value - the new physical value corresponding to a cell value of zero.

getTransferFunctionType

public TransferFunctionType getTransferFunctionType()

Returns type of transfer function to be used when scaling a physical value for a given element.

Note on XML marshalling

ISO 19115-2 defines this property in a subtype for historical reasons. Apache SIS moves this property up in the hierarchy since this property can apply to any sample dimension, not only the measurements in the electromagnetic spectrum. However, this property will not appear in XML documents unless this Sample­Dimension is actually a Band.

Returns:

type of transfer function, or null.

setTransferFunctionType

public void setTransferFunctionType(TransferFunctionType newValue)

Sets the type of transfer function to be used when scaling a physical value for a given element.

Parameters:

new­Value - the new transfer function value.

getBitsPerValue

@ValueRange(minimum=1.0)
@UML(identifier="bitsPerValue",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Integer getBitsPerValue()

Returns the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.

Returns:

maximum number of significant bits in the uncompressed representation for the value in each band of each pixel, or null if none.

setBitsPerValue

public void setBitsPerValue(Integer newValue)

Sets the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.

Parameters:

new­Value - the new maximum number of significant bits.

Throws:

Illegal­Argument­Exception - if the given value is zero or negative.

getRangeElementDescriptions

public Collection<RangeElementDescription> getRangeElementDescriptions()

Provides the description and values of the specific range elements of a sample dimension. Example: missing data.

Returns:

description and values of the specific range elements.

Since:

1.3

setRangeElementDescriptions

public void setRangeElementDescriptions(Collection<? extends RangeElementDescription> newValues)

Sets the description and values of the specific range elements of a sample dimension.

Parameters:

new­Values - the new range element description.

Since:

1.3

getNominalSpatialResolution

@ValueRange(minimum=0.0,
            isMinIncluded=false)
public Double getNominalSpatialResolution()

Returns the smallest distance between which separate points can be distinguished, as specified in instrument design.

Note on XML marshalling

ISO 19115-2 defines this property in a subtype for historical reasons. Apache SIS moves this property up in the hierarchy since this property can apply to any sample dimension, not only the measurements in the electromagnetic spectrum. However, this property will not appear in XML documents unless this Sample­Dimension is actually a Band.

Returns:

smallest distance between which separate points can be distinguished, or null.

setNominalSpatialResolution

public void setNominalSpatialResolution(Double newValue)

Sets the smallest distance between which separate points can be distinguished, as specified in instrument design.

Parameters:

new­Value - the new nominal spatial resolution.

Throws:

Illegal­Argument­Exception - if the given value is negative.

getOtherPropertyType

@UML(identifier="otherPropertyType",
     obligation=OPTIONAL,
     specification=ISO_19115)
public RecordType getOtherPropertyType()

Returns type of other attribute description.

Returns:

type of other attribute description, or null if none.

setOtherPropertyType

public void setOtherPropertyType(RecordType newValue)

Sets a new type of other attribute description.

Parameters:

new­Value - the new type of other attribute description.

getOtherProperty

@UML(identifier="otherProperty",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Record getOtherProperty()

Returns instance of other/attributeType that defines attributes not explicitly included in Coverage­Content­Type, or null if none.

Returns:

instance of other/attributeType that defines attributes, or null if none.

setOtherProperty

public void setOtherProperty(Record newValue)

Sets a new instance of other/attributeType that defines attributes not explicitly included in Coverage­Content­Type.

Parameters:

new­Value - the new instance of other/attributeType.