Class DefaultRangeElementDescription
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultRangeElementDescription
- All Implemented Interfaces:
Serializable,Emptiable,LenientComparable,IdentifiedObject,RangeElementDescription
@TitleProperty(name="name")
public class DefaultRangeElementDescription
extends ISOMetadata
implements RangeElementDescription
Description of specific range elements.
The following properties are mandatory in a well-formed metadata according ISO 19115:
MI_RangeElementDescription
├─name……………………………………………… Designation associated with a set of range elements.
├─definition……………………………… Description of a set of specific range elements.
└─rangeElement………………………… Specific range elements, i.e. range elements associated with a name and their definition.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 Summary
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State -
Field Summary
Fields inherited from class ISOMetadata
identifiers -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty range element description.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 the description of a set of specific range elements.getName()Returns the designation associated with a set of range elements.Returns the specific range elements, i.e. range elements associated with a name and their definition.voidsetDefinition(InternationalString newValue) Sets the description of a set of specific range elements.voidsetName(InternationalString newValue) Sets the designation associated with a set of range elements.voidsetRangeElements(Collection<? extends Record> newValues) Sets the specific range elements, i.e. range elements associated with a name and their definition.Methods 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
-
DefaultRangeElementDescription
public DefaultRangeElementDescription()Constructs an initially empty range element description. -
DefaultRangeElementDescription
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.- 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 already an instance of
DefaultRangeElementDescription, then it is returned unchanged. - Otherwise a new
DefaultRangeElementDescriptioninstance 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
-
getName
Returns the designation associated with a set of range elements.- Specified by:
getNamein interfaceRangeElementDescription- Returns:
- designation associated with a set of range elements, or
null.
-
setName
Sets the designation associated with a set of range elements.- Parameters:
newValue- the new name value.
-
getDefinition
Returns the description of a set of specific range elements.- Specified by:
getDefinitionin interfaceRangeElementDescription- Returns:
- description of a set of specific range elements, or
null.
-
setDefinition
Sets the description of a set of specific range elements.- Parameters:
newValue- the new definition value.
-
getRangeElements
Returns the specific range elements, i.e. range elements associated with a name and their definition.- Specified by:
getRangeElementsin interfaceRangeElementDescription- Returns:
- specific range elements.
- TODO:
- implements
Recordin order to use the annotation.
-
setRangeElements
Sets the specific range elements, i.e. range elements associated with a name and their definition.- Parameters:
newValues- the new range element values.
-