Class DefaultGridSpatialRepresentation

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

AbstractSpatialRepresentation

DefaultGridSpatialRepresentation

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Grid­Spatial­Representation, Spatial­Representation

Direct Known Subclasses:

Default­Georectified, Default­Georeferenceable

public class DefaultGridSpatialRepresentation
extends AbstractSpatialRepresentation
implements GridSpatialRepresentation

Method used to represent geographic information in the dataset. The following properties are mandatory in a well-formed metadata according ISO 19115:

MD_Grid­Spatial­Representation ├─number­Of­Dimensions………………………………………………… Number of independent spatial-temporal axes. ├─axis­Dimension­Properties…………………………………… Information about spatial-temporal axis properties. │ ├─dimension­Name…………………………………………………… Name of the axis. │ └─dimension­Size…………………………………………………… Number of elements along the axis. ├─cell­Geometry………………………………………………………………… Identification of grid data as point or cell. └─transformation­Parameter­Availability…… Indication of whether or not parameters for transformation exists.

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­Grid­Spatial­Representation()	Constructs an initially empty grid spatial representation.
Default­Grid­Spatial­Representation(Grid­Spatial­Representation object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Grid­Spatial­Representation	cast­Or­Copy(Grid­Spatial­Representation object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
List<Dimension>	get­Axis­Dimension­Properties()	Returns information about spatial-temporal axis properties.
Cell­Geometry	get­Cell­Geometry()	Returns the identification of grid data as point or cell.
Integer	get­Number­Of­Dimensions()	Returns the number of independent spatial-temporal axes.
boolean	is­Transformation­Parameter­Available()	Returns indication of whether or not parameters for transformation exists.
void	set­Axis­Dimension­Properties(List<? extends Dimension> new­Values)	Sets the information about spatial-temporal axis properties.
void	set­Cell­Geometry(Cell­Geometry new­Value)	Sets identification of grid data as point or cell.
void	set­Number­Of­Dimensions(Integer new­Value)	Sets the number of independent spatial-temporal axes.
void	set­Transformation­Parameter­Available(boolean new­Value)	Sets indication of whether or not parameters for transformation exists.

Methods inherited from class AbstractSpatialRepresentation

cast­Or­Copy, get­Scope, set­Scope

Modifier and Type	Method	Description
static Abstract­Spatial­Representation	cast­Or­Copy(Spatial­Representation object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Scope	get­Scope()	Returns the level and extent of the spatial representation.
void	set­Scope(Scope new­Value)	Sets the level and extent of the spatial representation.

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

DefaultGridSpatialRepresentation

public DefaultGridSpatialRepresentation()

Constructs an initially empty grid spatial representation.

DefaultGridSpatialRepresentation

public DefaultGridSpatialRepresentation(GridSpatialRepresentation 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(Grid­Spatial­Representation)

Method Details

castOrCopy

public static DefaultGridSpatialRepresentation castOrCopy(GridSpatialRepresentation 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 an instance of Georectified or Georeferenceable, then this method delegates to the cast­Or­Copy(…) method of the corresponding SIS subclass. Note that if the given object implements more than one of the above-cited interfaces, then the cast­Or­Copy(…) method to be used is unspecified.
• Otherwise if the given object is already an instance of Default­Grid­Spatial­Representation, then it is returned unchanged.
• Otherwise a new Default­Grid­Spatial­Representation 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.

getNumberOfDimensions

@ValueRange(minimum=0.0)
public Integer getNumberOfDimensions()

Returns the number of independent spatial-temporal axes.

Specified by:

get­Number­Of­Dimensions in interface Grid­Spatial­Representation

Returns:

number of independent spatial-temporal axes, or null.

setNumberOfDimensions

public void setNumberOfDimensions(Integer newValue)

Sets the number of independent spatial-temporal axes.

Parameters:

new­Value - the new number of dimension, or null.

Throws:

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

getAxisDimensionProperties

public List<Dimension> getAxisDimensionProperties()

Returns information about spatial-temporal axis properties.

Specified by:

get­Axis­Dimension­Properties in interface Grid­Spatial­Representation

Returns:

information about spatial-temporal axis properties.

setAxisDimensionProperties

public void setAxisDimensionProperties(List<? extends Dimension> newValues)

Sets the information about spatial-temporal axis properties.

Parameters:

new­Values - the new axis dimension properties.

getCellGeometry

public CellGeometry getCellGeometry()

Returns the identification of grid data as point or cell.

Specified by:

get­Cell­Geometry in interface Grid­Spatial­Representation

Returns:

identification of grid data as point or cell, or null.

setCellGeometry

public void setCellGeometry(CellGeometry newValue)

Sets identification of grid data as point or cell.

Parameters:

new­Value - the new cell geometry.

isTransformationParameterAvailable

public boolean isTransformationParameterAvailable()

Returns indication of whether or not parameters for transformation exists.

Specified by:

is­Transformation­Parameter­Available in interface Grid­Spatial­Representation

Returns:

whether or not parameters for transformation exists.

setTransformationParameterAvailable

public void setTransformationParameterAvailable(boolean newValue)

Sets indication of whether or not parameters for transformation exists.

Parameters:

new­Value - true if the transformation parameters are available.