Class DefaultRangeDimension
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultRangeDimension
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- RangeDimension
- Direct Known Subclasses:
- DefaultSampleDimension
@TitleProperty(name="sequenceIdentifier")
public class DefaultRangeDimension
extends ISOMetadata
implements RangeDimension
Information on the range of each dimension of a cell measurement value.
 
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 range dimension.Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultRangeDimensioncastOrCopy(RangeDimension object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the description of the attribute.Deprecated.Returns the identifiers for each attribute included in the resource.Returns a unique name or number that identifies attributes included in the coverage.voidsetDescription(InternationalString newValue) Sets the description of the attribute.voidsetDescriptor(InternationalString newValue) Deprecated.As of ISO 19115:2014, renamedsetDescription(InternationalString).voidsetNames(Collection<? extends Identifier> newValues) Sets the identifiers for each attribute included in the resource.voidsetSequenceIdentifier(MemberName newValue) Sets the name or number that uniquely identifies instances of bands of wavelengths on which a sensor operates.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- 
DefaultRangeDimensionpublic DefaultRangeDimension()Constructs an initially empty range dimension.
- 
DefaultRangeDimensionConstructs 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.- 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 an instance of SampleDimension, then this method delegates to thecastOrCopy(…)method of the corresponding SIS subclass.
- Otherwise if the given object is already an instance of
       DefaultRangeDimension, then it is returned unchanged.
- Otherwise a new DefaultRangeDimensioninstance 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 
- 
getSequenceIdentifierReturns a unique name or number that identifies attributes included in the coverage.- Specified by:
- getSequenceIdentifierin interface- RangeDimension
- Returns:
- unique name or number, or null.
 
- 
setSequenceIdentifierSets the name or number that uniquely identifies instances of bands of wavelengths on which a sensor operates.- Parameters:
- newValue- the new sequence identifier.
 
- 
getDescription@UML(identifier="description", obligation=OPTIONAL, specification=ISO_19115) public InternationalString getDescription()Returns the description of the attribute.- Returns:
- description of the attribute, or null.
- Since:
- 0.5
 
- 
setDescriptionSets the description of the attribute.- Parameters:
- newValue- the new description.
- Since:
- 0.5
 
- 
getDescriptorDeprecated.As of ISO 19115:2014, renamedgetDescription().Returns the description of the range of a cell measurement value. This method fetches the value from the description.- Specified by:
- getDescriptorin interface- RangeDimension
- Returns:
- description of the range of a cell measurement value, or null.
 
- 
setDescriptorDeprecated.As of ISO 19115:2014, renamedsetDescription(InternationalString).Sets the description of the range of a cell measurement value. This method stores the value in the description.- Parameters:
- newValue- the new descriptor.
 
- 
getNames@UML(identifier="name", obligation=OPTIONAL, specification=ISO_19115) public Collection<Identifier> getNames()Returns the identifiers for each attribute included in the resource. These identifiers can be use to provide names for the attribute from a standard set of names.- Returns:
- identifiers for each attribute included in the resource.
- Since:
- 0.5
 
- 
setNamesSets the identifiers for each attribute included in the resource.- Parameters:
- newValues- the new identifiers for each attribute.
- Since:
- 0.5
 
 
- 
getDescription().