org.apache.sis.metadata.iso.content

Class DefaultRangeElementDescription

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultRangeElementDescription

All Implemented Interfaces:

Serializable, Cloneable, 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_Range­Element­Description ├─name……………………………………………… Designation associated with a set of range elements. ├─definition……………………………… Description of a set of specific range elements. └─range­Element………………………… 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 XML instead.

Since:

0.3

See Also:

Serialized Form

Defined in the sis-metadata module

Field Summary

Fields inherited from class ISOMetadata

identifiers

Constructor Summary

Constructors

Constructor and Description
DefaultRangeElementDescription() Constructs an initially empty range element description.
DefaultRangeElementDescription(RangeElementDescription object) Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method and Description
static DefaultRangeElementDescription	castOrCopy(RangeElementDescription object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.
InternationalString	getDefinition() Returns the description of a set of specific range elements.
InternationalString	getName() Returns the designation associated with a set of range elements.
Collection<Record>	getRangeElements() Returns the specific range elements, i.e. range elements associated with a name and their definition.
void	setDefinition(InternationalString newValue) Sets the description of a set of specific range elements.
void	setName(InternationalString newValue) Sets the designation associated with a set of range elements.
void	setRangeElements(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

freeze, get­Identifier­Map, get­Identifiers, get­Standard

Methods inherited from class ModifiableMetadata

check­Write­Permission, clone, collection­Type, copy­Collection, copy­List, copy­Set, is­Modifiable, non­Null­Collection, non­Null­List, non­Null­Set, singleton, unmodifiable, write­Collection, write­List, write­Set

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, equals, equals, get­Interface, hash­Code, is­Empty, prune, to­String

Methods inherited from class Object

finalize, get­Class, notify, notify­All, wait, wait, wait

Constructor Detail

DefaultRangeElementDescription

public DefaultRangeElementDescription()

Constructs an initially empty range element description.

DefaultRangeElementDescription

public DefaultRangeElementDescription(RangeElementDescription object)

Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, since the other metadata contained in the given object are not recursively copied.

Parameters:

object - the metadata to copy values from, or null if none.

See Also:

cast­Or­Copy(Range­Element­Description)

Method Detail

castOrCopy

public static DefaultRangeElementDescription castOrCopy(RangeElementDescription 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­Range­Element­Description, then it is returned unchanged.
• Otherwise a new Default­Range­Element­Description instance is created using the copy constructor and returned. Note that this is a shallow copy operation, since 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.

getName

public InternationalString getName()

Returns the designation associated with a set of range elements.

Specified by:

get­Name in interface Range­Element­Description

Returns:

designation associated with a set of range elements, or null.

setName

public void setName(InternationalString newValue)

Sets the designation associated with a set of range elements.

Parameters:

new­Value - the new name value.

getDefinition

public InternationalString getDefinition()

Returns the description of a set of specific range elements.

Specified by:

get­Definition in interface Range­Element­Description

Returns:

description of a set of specific range elements, or null.

setDefinition

public void setDefinition(InternationalString newValue)

Sets the description of a set of specific range elements.

Parameters:

new­Value - the new definition value.

getRangeElements

public Collection<Record> getRangeElements()

Returns the specific range elements, i.e. range elements associated with a name and their definition.

Specified by:

get­Range­Elements in interface Range­Element­Description

Returns:

specific range elements.

TODO:

implements Record in order to use the annotation.

setRangeElements

public void setRangeElements(Collection<? extends Record> newValues)

Sets the specific range elements, i.e. range elements associated with a name and their definition.

Parameters:

new­Values - the new range element values.