Class DefaultNominalResolution

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultNominalResolution

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Nominal­Resolution

public class DefaultNominalResolution
extends ISOMetadata
implements 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_Nominal­Resolution ├─scanning­Resolution…… Distance between consistent parts of (centre, left side, right side) adjacent pixels in the scan plane. └─ground­Resolution………… 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 XML instead.

Since:

0.3

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­Nominal­Resolution()	Constructs an initially empty nominal resolution.
Default­Nominal­Resolution(Nominal­Resolution object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Nominal­Resolution	cast­Or­Copy(Nominal­Resolution object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Double	get­Ground­Resolution()	Returns the distance between consistent parts of (centre, left side, right side) adjacent pixels in the object space.
Double	get­Scanning­Resolution()	Returns the distance between consistent parts of (centre, left side, right side) adjacent pixels in the scan plane.
void	set­Ground­Resolution(Double new­Value)	Sets the distance between consistent parts of (centre, left side, right side) adjacent pixels in the object space.
void	set­Scanning­Resolution(Double new­Value)	Sets the distance between consistent parts of (centre, left side, right side) adjacent pixels in the scan plane.

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

DefaultNominalResolution

public DefaultNominalResolution()

Constructs an initially empty nominal resolution.

DefaultNominalResolution

public DefaultNominalResolution(NominalResolution 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.

See Also:

• cast­Or­Copy(Nominal­Resolution)

Method Details

castOrCopy

public static DefaultNominalResolution castOrCopy(NominalResolution 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­Nominal­Resolution, then it is returned unchanged.
• Otherwise a new Default­Nominal­Resolution 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.

getScanningResolution

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

Returns the distance between consistent parts of (centre, left side, right side) adjacent pixels in the scan plane.

Specified by:

get­Scanning­Resolution in interface Nominal­Resolution

Returns:

distance between consistent parts of adjacent pixels in the scan plane, or null.

setScanningResolution

public void setScanningResolution(Double newValue)

Sets the distance between consistent parts of (centre, left side, right side) adjacent pixels in the scan plane.

Parameters:

new­Value - the new scanning resolution value.

Throws:

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

getGroundResolution

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

Returns the distance between consistent parts of (centre, left side, right side) adjacent pixels in the object space.

Specified by:

get­Ground­Resolution in interface Nominal­Resolution

Returns:

distance between consistent parts of adjacent pixels in the object space, or null.

setGroundResolution

public void setGroundResolution(Double newValue)

Sets the distance between consistent parts of (centre, left side, right side) adjacent pixels in the object space.

Parameters:

new­Value - the new ground resolution value.

Throws:

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