Class DefaultNominalResolution
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultNominalResolution
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- NominalResolution
Distance between consistent parts of (centre, left side, right side) adjacent pixels.
 The following properties are mandatory in a well-formed metadata according ISO 19115:
 
 
LE_NominalResolution
   ├─scanningResolution…… Distance between consistent parts of (centre, left side, right side) adjacent pixels in the scan plane.
   └─groundResolution………… Distance between consistent parts of (centre, left side, right side) adjacent pixels in the object space.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 XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs an initially empty nominal resolution.Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultNominalResolutioncastOrCopy(NominalResolution object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the distance between consistent parts of (centre, left side, right side) adjacent pixels in the object space.Returns the distance between consistent parts of (centre, left side, right side) adjacent pixels in the scan plane.voidsetGroundResolution(Double newValue) Sets the distance between consistent parts of (centre, left side, right side) adjacent pixels in the object space.voidsetScanningResolution(Double newValue) Sets the distance between consistent parts of (centre, left side, right side) adjacent pixels in the scan plane.Methods inherited from class ISOMetadatagetIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
- 
Constructor Details- 
DefaultNominalResolutionpublic DefaultNominalResolution()Constructs an initially empty nominal resolution.
- 
DefaultNominalResolutionConstructs 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- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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 returnsnull.
- Otherwise if the given object is already an instance of
       DefaultNominalResolution, then it is returned unchanged.
- Otherwise a new DefaultNominalResolutioninstance 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- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- If the given object is 
- 
getScanningResolutionReturns the distance between consistent parts of (centre, left side, right side) adjacent pixels in the scan plane.- Specified by:
- getScanningResolutionin interface- NominalResolution
- Returns:
- distance between consistent parts of adjacent pixels in the scan plane, or null.
 
- 
setScanningResolutionSets the distance between consistent parts of (centre, left side, right side) adjacent pixels in the scan plane.- Parameters:
- newValue- the new scanning resolution value.
- Throws:
- IllegalArgumentException- if the given value is NaN, zero or negative.
 
- 
getGroundResolutionReturns the distance between consistent parts of (centre, left side, right side) adjacent pixels in the object space.- Specified by:
- getGroundResolutionin interface- NominalResolution
- Returns:
- distance between consistent parts of adjacent pixels in the object space, or null.
 
- 
setGroundResolutionSets the distance between consistent parts of (centre, left side, right side) adjacent pixels in the object space.- Parameters:
- newValue- the new ground resolution value.
- Throws:
- IllegalArgumentException- if the given value is NaN, zero or negative.
 
 
-