Module org.apache.sis.metadata
Class DefaultGridSpatialRepresentation
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
AbstractSpatialRepresentation
DefaultGridSpatialRepresentation
- All Implemented Interfaces:
Serializable,Emptiable,LenientComparable,IdentifiedObject,GridSpatialRepresentation,SpatialRepresentation
- Direct Known Subclasses:
DefaultGeorectified,DefaultGeoreferenceable
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_GridSpatialRepresentation
├─numberOfDimensions………………………………………………… Number of independent spatial-temporal axes.
├─axisDimensionProperties…………………………………… Information about spatial-temporal axis properties.
│ ├─dimensionName…………………………………………………… Name of the axis.
│ └─dimensionSize…………………………………………………… Number of elements along the axis.
├─cellGeometry………………………………………………………………… Identification of grid data as point or cell.
└─transformationParameterAvailability…… 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
XMLinstead.
- Since:
- 0.3
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State -
Field Summary
Fields inherited from class ISOMetadata
identifiers -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty grid spatial representation.Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionReturns a SIS metadata implementation with the values of the given arbitrary implementation.Returns information about spatial-temporal axis properties.Returns the identification of grid data as point or cell.Returns the number of independent spatial-temporal axes.booleanReturns indication of whether or not parameters for transformation exists.voidsetAxisDimensionProperties(List<? extends Dimension> newValues) Sets the information about spatial-temporal axis properties.voidsetCellGeometry(CellGeometry newValue) Sets identification of grid data as point or cell.voidsetNumberOfDimensions(Integer newValue) Sets the number of independent spatial-temporal axes.voidsetTransformationParameterAvailable(boolean newValue) Sets indication of whether or not parameters for transformation exists.Methods inherited from class AbstractSpatialRepresentation
castOrCopy, getScope, setScopeMethods inherited from class ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Constructor Details
-
DefaultGridSpatialRepresentation
public DefaultGridSpatialRepresentation()Constructs an initially empty grid spatial representation. -
DefaultGridSpatialRepresentation
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, ornullif none.- See Also:
-
-
Method Details
-
castOrCopy
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 returnsnull. - Otherwise if the given object is an instance of
GeorectifiedorGeoreferenceable, then this method delegates to thecastOrCopy(…)method of the corresponding SIS subclass. Note that if the given object implements more than one of the above-cited interfaces, then thecastOrCopy(…)method to be used is unspecified. - Otherwise if the given object is already an instance of
DefaultGridSpatialRepresentation, then it is returned unchanged. - Otherwise a new
DefaultGridSpatialRepresentationinstance 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, ornullif 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
-
getNumberOfDimensions
Returns the number of independent spatial-temporal axes.- Specified by:
getNumberOfDimensionsin interfaceGridSpatialRepresentation- Returns:
- number of independent spatial-temporal axes, or
null.
-
setNumberOfDimensions
Sets the number of independent spatial-temporal axes.- Parameters:
newValue- the new number of dimension, ornull.- Throws:
IllegalArgumentException- if the given value is negative.
-
getAxisDimensionProperties
Returns information about spatial-temporal axis properties.- Specified by:
getAxisDimensionPropertiesin interfaceGridSpatialRepresentation- Returns:
- information about spatial-temporal axis properties.
-
setAxisDimensionProperties
Sets the information about spatial-temporal axis properties.- Parameters:
newValues- the new axis dimension properties.
-
getCellGeometry
Returns the identification of grid data as point or cell.- Specified by:
getCellGeometryin interfaceGridSpatialRepresentation- Returns:
- identification of grid data as point or cell, or
null.
-
setCellGeometry
Sets identification of grid data as point or cell.- Parameters:
newValue- the new cell geometry.
-
isTransformationParameterAvailable
public boolean isTransformationParameterAvailable()Returns indication of whether or not parameters for transformation exists.- Specified by:
isTransformationParameterAvailablein interfaceGridSpatialRepresentation- 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:
newValue-trueif the transformation parameters are available.
-