Class DefaultRangeDimension

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultRangeDimension

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Range­Dimension

Direct Known Subclasses:

Default­Sample­Dimension

@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 XML instead.

Since:

0.3

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Modifier and Type	Class	Description
static enum	Modifiable­Metadata.State	Whether the metadata is still editable or has been made final.

Field Summary

Fields inherited from class ISOMetadata

identifiers

Modifier and Type	Field	Description
protected Collection<Identifier>	identifiers	All identifiers associated with this metadata, or null if none.

Constructor Summary

Constructors

Constructor	Description
Default­Range­Dimension()	Constructs an initially empty range dimension.
Default­Range­Dimension(Range­Dimension object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Range­Dimension	cast­Or­Copy(Range­Dimension object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
International­String	get­Description()	Returns the description of the attribute.
International­String	get­Descriptor()	Deprecated. As of ISO 19115:2014, renamed get­Description().
Collection<Identifier>	get­Names()	Returns the identifiers for each attribute included in the resource.
Member­Name	get­Sequence­Identifier()	Returns a unique name or number that identifies attributes included in the coverage.
void	set­Description(International­String new­Value)	Sets the description of the attribute.
void	set­Descriptor(International­String new­Value)	Deprecated. As of ISO 19115:2014, renamed set­Description(International­String).
void	set­Names(Collection<? extends Identifier> new­Values)	Sets the identifiers for each attribute included in the resource.
void	set­Sequence­Identifier(Member­Name new­Value)	Sets the name or number that uniquely identifies instances of bands of wavelengths on which a sensor operates.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, set­Identifier

Modifier and Type	Method	Description
protected Identifier	get­Identifier()	Returns the first identifier which is presumed to be defined by ISO 19115 conceptual model.
Identifier­Map	get­Identifier­Map()	A map view of the identifiers collection as (authority, code) entries.
Collection<Identifier>	get­Identifiers()	Returns all identifiers associated with this object (from conceptual model and from XML document).
Metadata­Standard	get­Standard()	Returns the metadata standard implemented by subclasses, which is ISO 19115.
protected void	set­Identifier(Identifier new­Value)	Sets the identifier for metadata objects that are expected to contain at most one ISO 19115 identifier.

Methods inherited from class ModifiableMetadata

check­Write­Permission, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, merge, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Modifier and Type	Method	Description
protected void	check­Write­Permission(Object current)	Checks if changes in the metadata are allowed.
protected static <E> Collection<E>	copy­Collection(Collection<? extends E> source, Class<E> element­Type)	Creates a list or set with the content of the source collection, or returns null if the source is null or empty.
protected static <E> List<E>	copy­List(Collection<? extends E> source, Class<E> element­Type)	Creates a list with the content of the source collection, or returns null if the source is null or empty.
protected static <K,V> Map<K,V>	copy­Map(Map<? extends K, ? extends V> source, Class<K> key­Type)	Creates a map with the content of the source map, or returns null if the source is null or empty.
protected static <E> Set<E>	copy­Set(Collection<? extends E> source, Class<E> element­Type)	Creates a set with the content of the source collection, or returns null if the source is null or empty.
Modifiable­Metadata	deep­Copy(Modifiable­Metadata.State target)	Copies (if necessary) this metadata and all its children.
void	merge(Object source)	Merges the data from the given source into this metadata.
protected final <E> Collection<E>	non­Null­Collection(Collection<E> current, Class<E> element­Type)	Returns the specified collection, or a new one if current is null.
protected final <E> List<E>	non­Null­List(List<E> current, Class<E> element­Type)	Returns the specified list, or a new one if current is null.
protected final <K,V> Map<K,V>	non­Null­Map(Map<K,V> current, Class<K> key­Type)	Returns the specified map, or a new one if current is null.
protected final <E> Set<E>	non­Null­Set(Set<E> current, Class<E> element­Type)	Returns the specified set, or a new one if current is null.
protected static <E> Collection<E>	singleton(E value, Class<E> element­Type)	Creates a singleton list or set containing only the given value, if non-null.
Modifiable­Metadata.State	state()	Tells whether this instance of metadata is editable.
protected final <E> Collection<E>	write­Collection(Collection<? extends E> source, Collection<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list or set, creating it if needed.
protected final <E> List<E>	write­List(Collection<? extends E> source, List<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list, creating it if needed.
protected final <K,V> Map<K,V>	write­Map(Map<? extends K, ? extends V> source, Map<K,V> target, Class<K> key­Type)	Writes the content of the source map into the target map, creating it if needed.
protected final <E> Set<E>	write­Set(Collection<? extends E> source, Set<E> target, Class<E> element­Type)	Writes the content of the source collection into the target set, creating it if needed.

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, clone, equals, equals, get­Interface, get­Standard­Type, hash­Code, is­Empty, nil­Reasons, prune, to­String

Modifier and Type	Method	Description
Map<String,Object>	as­Map()	Returns a view of the property values in a Map.
Tree­Table	as­Tree­Table()	Returns the property types and values as a tree table.
protected Abstract­Metadata	clone()	Returns a shallow clone of this metadata.
final boolean	equals(Object object)	Performs a strict comparison of this metadata with the given object.
boolean	equals(Object object, Comparison­Mode mode)	Compares this metadata with the specified object for equality.
final Class<?>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Metadata.get­Standard­Type() for integration with Lenient­Comparable.
Type	get­Standard­Type()	Returns the metadata interface implemented by this class.
int	hash­Code()	Computes a hash code value for this metadata using Java reflection.
boolean	is­Empty()	Returns true if this metadata contains only null, nil or empty properties.
Map<String, Nil­Reason>	nil­Reasons()	Returns a view of the reasons why some properties are missing.
void	prune()	Removes all references to empty properties.
String	to­String()	Returns a string representation of this metadata.

Methods inherited from class Object

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

Constructor Details

DefaultRangeDimension

public DefaultRangeDimension()

Constructs an initially empty range dimension.

DefaultRangeDimension

public DefaultRangeDimension(RangeDimension 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.

Parameters:

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

See Also:

• cast­Or­Copy(Range­Dimension)

Method Details

castOrCopy

public static DefaultRangeDimension castOrCopy(RangeDimension 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 an instance of Sample­Dimension, then this method delegates to the cast­Or­Copy(…) method of the corresponding SIS subclass.
• Otherwise if the given object is already an instance of Default­Range­Dimension, then it is returned unchanged.
• Otherwise a new Default­Range­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.

getSequenceIdentifier

public MemberName getSequenceIdentifier()

Returns a unique name or number that identifies attributes included in the coverage.

Specified by:

get­Sequence­Identifier in interface Range­Dimension

Returns:

unique name or number, or null.

setSequenceIdentifier

public void setSequenceIdentifier(MemberName newValue)

Sets the name or number that uniquely identifies instances of bands of wavelengths on which a sensor operates.

Parameters:

new­Value - 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

setDescription

public void setDescription(InternationalString newValue)

Sets the description of the attribute.

Parameters:

new­Value - the new description.

Since:

0.5

getDescriptor

@Deprecated(since="1.0")
public InternationalString getDescriptor()

Deprecated.

As of ISO 19115:2014, renamed get­Description().

Returns the description of the range of a cell measurement value. This method fetches the value from the description.

Specified by:

get­Descriptor in interface Range­Dimension

Returns:

description of the range of a cell measurement value, or null.

setDescriptor

@Deprecated(since="1.0")
public void setDescriptor(InternationalString newValue)

Deprecated.

As of ISO 19115:2014, renamed set­Description(International­String).

Sets the description of the range of a cell measurement value. This method stores the value in the description.

Parameters:

new­Value - 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

setNames

public void setNames(Collection<? extends Identifier> newValues)

Sets the identifiers for each attribute included in the resource.

Parameters:

new­Values - the new identifiers for each attribute.

Since:

0.5