Class DefaultDimension
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultDimension
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- 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
   ├─dimensionName…… Name of the axis.
   └─dimensionSize…… 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 XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs an initially empty dimension.DefaultDimension(Dimension object) Constructs a new instance initialized with the values from the specified metadata object.DefaultDimension(DimensionNameType dimensionName, int dimensionSize) Creates a dimension initialized to the given type and size.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultDimensioncastOrCopy(Dimension object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Return the axis dimension description.Returns the name of the axis.Returns the number of elements along the axis.Returns the enhancement / modifier of the dimension name.Returns the degree of detail in the grid dataset.voidsetDimensionDescription(InternationalString newValue) Sets the axis dimension description.voidsetDimensionName(DimensionNameType newValue) Sets the name of the axis.voidsetDimensionSize(Integer newValue) Sets the number of elements along the axis.voidsetDimensionTitle(InternationalString newValue) Sets the enhancement / modifier of the dimension name.voidsetResolution(Double newValue) Sets the degree of detail in the grid dataset.Methods inherited from class ISOMetadatagetIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
- 
Constructor Details- 
DefaultDimensionpublic DefaultDimension()Constructs an initially empty dimension.
- 
DefaultDimensionCreates a dimension initialized to the given type and size.- Parameters:
- dimensionName- the name of the axis, or- nullif none, or- nullif none.
- dimensionSize- the number of elements along the axis, or- nullif none.
- Throws:
- IllegalArgumentException- if- dimensionSizeis negative.
 
- 
DefaultDimensionConstructs 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- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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 already an instance of
       DefaultDimension, then it is returned unchanged.
- Otherwise a new DefaultDimensioninstance 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- nullif 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 
- 
getDimensionNameReturns the name of the axis.- Specified by:
- getDimensionNamein interface- Dimension
- Returns:
- name of the axis, or null.
 
- 
setDimensionNameSets the name of the axis.- Parameters:
- newValue- the new dimension name.
 
- 
getDimensionSizeReturns the number of elements along the axis.- Specified by:
- getDimensionSizein interface- Dimension
- Returns:
- number of elements along the axis, or null.
 
- 
setDimensionSizeSets the number of elements along the axis.- Parameters:
- newValue- the new dimension size, or- null.
- Throws:
- IllegalArgumentException- if the given value is negative.
 
- 
getResolutionReturns the degree of detail in the grid dataset.- Specified by:
- getResolutionin interface- Dimension
- Returns:
- degree of detail in the grid dataset, or null.
 
- 
setResolutionSets the degree of detail in the grid dataset.- Parameters:
- newValue- the new resolution, or- null.
- Throws:
- IllegalArgumentException- 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
 
- 
setDimensionTitleSets the enhancement / modifier of the dimension name.- Parameters:
- newValue- 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
 
- 
setDimensionDescriptionSets the axis dimension description.- Parameters:
- newValue- the new axis dimension description.
- Since:
- 0.5
 
 
-