org.apache.sis.metadata.iso.content

Class DefaultSampleDimension

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultRangeDimension

DefaultSampleDimension

All Implemented Interfaces:

Serializable, Cloneable, Emptiable, LenientComparable, IdentifiedObject, RangeDimension

Direct Known Subclasses:

DefaultBand

The characteristic of each dimension (layer) 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 SampleDimension interface.

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

Defined in the sis-metadata module

Field Summary

Fields inherited from class ISOMetadata

identifiers, LOGGER

Constructor Summary

Constructors

Constructor and Description
DefaultSampleDimension() Constructs an initially empty sample dimension.
DefaultSampleDimension(DefaultSampleDimension object) Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Methods

Modifier and Type	Method and Description
Integer	getBitsPerValue() Returns the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.
Double	getMaxValue() Returns the maximum value of data values in each dimension included in the resource.
Double	getMeanValue() Returns the mean value of data values in each dimension included in the resource.
Double	getMinValue() Returns the minimum value of data values in each dimension included in the resource.
Double	getNominalSpatialResolution() Returns the smallest distance between which separate points can be distinguished, as specified in instrument design.
Integer	getNumberOfValues() Returns the number of values used in a thematic classification resource.
Double	getOffset() Returns the physical value corresponding to a cell value of zero.
Record	getOtherProperty() Returns instance of other/attributeType that defines attributes not explicitly included in CoverageContentType, or null if none.
RecordType	getOtherPropertyType() Returns type of other attribute description.
Double	getScaleFactor() Returns the scale factor which has been applied to the cell value.
Double	getStandardDeviation() Returns the standard deviation of data values in each dimension included in the resource.
TransferFunctionType	getTransferFunctionType() Returns type of transfer function to be used when scaling a physical value for a given element.
Unit<?>	getUnits() Returns the units of data in the dimension.
void	setBitsPerValue(Integer newValue) Sets the maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.
void	setMaxValue(Double newValue) Sets the maximum value of data values in each dimension included in the resource.
void	setMeanValue(Double newValue) Sets the mean value of data values in each dimension included in the resource.
void	setMinValue(Double newValue) Sets the minimum value of data values in each dimension included in the resource.
void	setNominalSpatialResolution(Double newValue) Sets the smallest distance between which separate points can be distinguished, as specified in instrument design.
void	setNumberOfValues(Integer newValue) Sets the number of values used in a thematic classification resource.
void	setOffset(Double newValue) Sets the physical value corresponding to a cell value of zero.
void	setOtherProperty(Record newValue) Sets a new instance of other/attributeType that defines attributes not explicitly included in CoverageContentType.
void	setOtherPropertyType(RecordType newValue) Sets a new type of other attribute description.
void	setScaleFactor(Double newValue) Sets the scale factor which has been applied to the cell value.
void	setStandardDeviation(Double newValue) Sets the standard deviation of data values in each dimension included in the resource.
void	setTransferFunctionType(TransferFunctionType newValue) Sets the type of transfer function to be used when scaling a physical value for a given element.
void	setUnits(Unit<?> newValue) Sets the units of data in the dimension.

Methods inherited from class DefaultRangeDimension

castOrCopy, getDescription, getDescriptor, getNames, getSequenceIdentifier, setDescription, setDescriptor, setNames, setSequenceIdentifier

Methods inherited from class ISOMetadata

getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, singleton, unmodifiable, writeCollection, writeList, writeSet

Methods inherited from class AbstractMetadata

asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

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, since 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.

See Also:

#castOrCopy(SampleDimension)

Method Detail

getMinValue

Returns the minimum value of data values in each dimension included in the resource.

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.

Parameters:

newValue - The new new minimum value.

getMaxValue

Returns the maximum value of data values in each dimension included in the resource.

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.

Parameters:

newValue - The new new maximum value.

getMeanValue

Returns the mean value of data values in each dimension included in the resource.

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.

Parameters:

newValue - The new mean value of data values in each dimension included in the resource.

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:

newValue - The new number of values used in a thematic classification resource.

Throws:

IllegalArgumentException - if the given value is negative.

getStandardDeviation

Returns the standard deviation of data values in each dimension included in the resource.

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.

Parameters:

newValue - The new standard deviation of data values in each dimension included in the resource.

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:

newValue - The new units of data in the dimension.

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:

newValue - The new scale factor which has been applied to the cell value.

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:

newValue - The new physical value corresponding to a cell value of zero, or null if none..

getTransferFunctionType

public TransferFunctionType getTransferFunctionType()

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

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:

newValue - The new transfer function value.

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:

newValue - The new maximum number of significant bits.

Throws:

IllegalArgumentException - if the given value is zero or negative.

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.

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:

newValue - The new nominal spatial resolution.

Throws:

IllegalArgumentException - if the given value is negative.

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:

newValue - The new type of other attribute description.

getOtherProperty

Returns instance of other/attributeType that defines attributes not explicitly included in CoverageContentType, 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 CoverageContentType.

Parameters:

newValue - The new instance of other/attributeType.