Module org.apache.sis.metadata
Package org.apache.sis.metadata.iso.spatial

Class DefaultDimension

Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultDimension
All Implemented Interfaces:
Serializable, Emptiable, Lenient­Comparable, Identified­Object, Dimension
@TitleProperty(name="dimensionName") public class DefaultDimension extends ISOMetadata implements Dimension
Axis properties. The following properties are mandatory in a well-formed metadata according ISO 19115:
MD_Dimension   ├─dimension­Name…… Name of the axis.   └─dimension­Size…… Number of elements along the axis.

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:

  • Constructor Details

    • DefaultDimension

      public DefaultDimension()
      Constructs an initially empty dimension.

    • DefaultDimension

      public DefaultDimension(DimensionNameType dimensionName, int dimensionSize)
      Creates a dimension initialized to the given type and size.
      Parameters:
      dimension­Name - the name of the axis, or null if none, or null if none.
      dimension­Size - the number of elements along the axis, or null if none.
      Throws:
      Illegal­Argument­Exception - if dimension­Size is negative.

    • DefaultDimension

      public DefaultDimension(Dimension 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:

  • Method Details

    • castOrCopy

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

    • getDimensionName

      public DimensionNameType getDimensionName()
      Returns the name of the axis.
      Specified by:
      get­Dimension­Name in interface Dimension
      Returns:
      name of the axis, or null.

    • setDimensionName

      public void setDimensionName(DimensionNameType newValue)
      Sets the name of the axis.
      Parameters:
      new­Value - the new dimension name.

    • getDimensionSize

      @ValueRange(minimum=0.0) public Integer getDimensionSize()
      Returns the number of elements along the axis.
      Specified by:
      get­Dimension­Size in interface Dimension
      Returns:
      number of elements along the axis, or null.

    • setDimensionSize

      public void setDimensionSize(Integer newValue)
      Sets the number of elements along the axis.
      Parameters:
      new­Value - the new dimension size, or null.
      Throws:
      Illegal­Argument­Exception - if the given value is negative.

    • getResolution

      @ValueRange(minimum=0.0, isMinIncluded=false) public Double getResolution()
      Returns the degree of detail in the grid dataset.
      Specified by:
      get­Resolution in interface Dimension
      Returns:
      degree of detail in the grid dataset, or null.

    • setResolution

      public void setResolution(Double newValue)
      Sets the degree of detail in the grid dataset.
      Parameters:
      new­Value - the new resolution, or null.
      Throws:
      Illegal­Argument­Exception - if the given value is NaN, zero or negative.

    • getDimensionTitle

      @UML(identifier="dimensionTitle", obligation=OPTIONAL, specification=ISO_19115) public InternationalString getDimensionTitle()
      Returns the enhancement / modifier of the dimension name.

      Example

      dimensionName = "column", dimensionTitle = "longitude"
      Returns:
      the enhancement / modifier of the dimension name.
      Since:
      0.5

    • setDimensionTitle

      public void setDimensionTitle(InternationalString newValue)
      Sets the enhancement / modifier of the dimension name.
      Parameters:
      new­Value - the new enhancement / modifier of the dimension name.
      Since:
      0.5

    • getDimensionDescription

      @UML(identifier="dimensionDescription", obligation=OPTIONAL, specification=ISO_19115) public InternationalString getDimensionDescription()
      Return the axis dimension description.
      Returns:
      the axis dimension description.
      Since:
      0.5

    • setDimensionDescription

      public void setDimensionDescription(InternationalString newValue)
      Sets the axis dimension description.
      Parameters:
      new­Value - the new axis dimension description.
      Since:
      0.5