Class DefaultGridSpatialRepresentation
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.spatial.AbstractSpatialRepresentation
org.apache.sis.metadata.iso.spatial.DefaultGridSpatialRepresentation
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.spatial.GridSpatialRepresentation
,org.opengis.metadata.spatial.SpatialRepresentation
- Direct Known Subclasses:
DefaultGeorectified
,DefaultGeoreferenceable
public class DefaultGridSpatialRepresentation
extends AbstractSpatialRepresentation
implements org.opengis.metadata.spatial.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
XML
instead.
- Since:
- 0.3
- Version:
- 1.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata
ModifiableMetadata.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate List<org.opengis.metadata.spatial.Dimension>
Information about spatial-temporal axis properties.(package private) byte
The set of booleans values.private org.opengis.metadata.spatial.CellGeometry
Identification of grid data as point or cell.private Integer
Number of independent spatial-temporal axes.private static final long
Serial number for inter-operability with different versions.(package private) static final byte
Mask for thetransformationParameterAvailable
boolean value.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty grid spatial representation.DefaultGridSpatialRepresentation
(org.opengis.metadata.spatial.GridSpatialRepresentation object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptioncastOrCopy
(org.opengis.metadata.spatial.GridSpatialRepresentation object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.List<org.opengis.metadata.spatial.Dimension>
Returns information about spatial-temporal axis properties.org.opengis.metadata.spatial.CellGeometry
Returns the identification of grid data as point or cell.Returns the number of independent spatial-temporal axes.(package private) final Boolean
isDefined
(byte mask) ReturnsBoolean.TRUE
if the given flag is set, ornull
otherwise.boolean
Returns indication of whether or not parameters for transformation exists.void
setAxisDimensionProperties
(List<? extends org.opengis.metadata.spatial.Dimension> newValues) Sets the information about spatial-temporal axis properties.void
setCellGeometry
(org.opengis.metadata.spatial.CellGeometry newValue) Sets identification of grid data as point or cell.void
setNumberOfDimensions
(Integer newValue) Sets the number of independent spatial-temporal axes.void
setTransformationParameterAvailable
(boolean newValue) Sets indication of whether or not parameters for transformation exists.Methods inherited from class org.apache.sis.metadata.iso.spatial.AbstractSpatialRepresentation
castOrCopy, getScope, setScope
Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionTo
Methods inherited from class org.apache.sis.metadata.ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSet
Methods inherited from class org.apache.sis.metadata.AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
TRANSFORMATION_MASK
static final byte TRANSFORMATION_MASKMask for thetransformationParameterAvailable
boolean value.- See Also:
-
numberOfDimensions
Number of independent spatial-temporal axes. -
axisDimensionProperties
Information about spatial-temporal axis properties. -
cellGeometry
private org.opengis.metadata.spatial.CellGeometry cellGeometryIdentification of grid data as point or cell. -
booleans
byte booleansThe set of booleans values. Bits are read and written using the*_MASK
constants.
-
-
Constructor Details
-
DefaultGridSpatialRepresentation
public DefaultGridSpatialRepresentation()Constructs an initially empty grid spatial representation. -
DefaultGridSpatialRepresentation
public DefaultGridSpatialRepresentation(org.opengis.metadata.spatial.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, ornull
if none.- See Also:
-
-
Method Details
-
castOrCopy
public static DefaultGridSpatialRepresentation castOrCopy(org.opengis.metadata.spatial.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 returnsnull
. - Otherwise if the given object is an instance of
Georectified
orGeoreferenceable
, 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
DefaultGridSpatialRepresentation
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, ornull
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.
- If the given object is
-
getNumberOfDimensions
Returns the number of independent spatial-temporal axes.- Specified by:
getNumberOfDimensions
in interfaceorg.opengis.metadata.spatial.GridSpatialRepresentation
- 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:
getAxisDimensionProperties
in interfaceorg.opengis.metadata.spatial.GridSpatialRepresentation
- Returns:
- information about spatial-temporal axis properties.
-
setAxisDimensionProperties
public void setAxisDimensionProperties(List<? extends org.opengis.metadata.spatial.Dimension> newValues) Sets the information about spatial-temporal axis properties.- Parameters:
newValues
- the new axis dimension properties.
-
getCellGeometry
public org.opengis.metadata.spatial.CellGeometry getCellGeometry()Returns the identification of grid data as point or cell.- Specified by:
getCellGeometry
in interfaceorg.opengis.metadata.spatial.GridSpatialRepresentation
- Returns:
- identification of grid data as point or cell, or
null
.
-
setCellGeometry
public void setCellGeometry(org.opengis.metadata.spatial.CellGeometry newValue) Sets identification of grid data as point or cell.- Parameters:
newValue
- the new cell geometry.
-
isDefined
ReturnsBoolean.TRUE
if the given flag is set, ornull
otherwise. -
isTransformationParameterAvailable
public boolean isTransformationParameterAvailable()Returns indication of whether or not parameters for transformation exists.- Specified by:
isTransformationParameterAvailable
in interfaceorg.opengis.metadata.spatial.GridSpatialRepresentation
- 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
-true
if the transformation parameters are available.
-