Module org.apache.sis.metadata

Package org.apache.sis.metadata.iso

Class DefaultMetadataScope

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultMetadataScope

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object

@UML(identifier="MD_MetadataScope",
     specification=ISO_19115)
public class DefaultMetadataScope
extends ISOMetadata

Information about the scope of the resource. The following property is mandatory in a well-formed metadata according ISO 19115:

MD_Metadata­Scope └─resource­Scope…… Resource scope

Note on International Standard versions
This class is derived from a new type defined in the ISO 19115 international standard published in 2014, while GeoAPI 3.0 is based on the version published in 2003. Consequently this implementation class does not yet implement a GeoAPI interface, but is expected to do so after the next GeoAPI releases. When the interface will become available, all references to this implementation class in Apache SIS will be replaced be references to the Metadata­Scope interface.

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.5

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Field Summary

Fields inherited from class ISOMetadata

identifiers

Constructor Summary

Constructors

Constructor	Description
Default­Metadata­Scope()	Constructs an initially empty metadata scope.
Default­Metadata­Scope(Default­Metadata­Scope object)	Constructs a new instance initialized with the values from the specified metadata object.
Default­Metadata­Scope(Scope­Code resource­Scope, Char­Sequence name)	Constructs a metadata scope initialized to the given value.

Method Summary

Modifier and Type	Method	Description
International­String	get­Name()	Returns a description of the scope, or null if none.
Scope­Code	get­Resource­Scope()	Returns the code for the scope.
void	set­Name(International­String new­Value)	Sets the description of the scope.
void	set­Resource­Scope(Scope­Code new­Value)	Sets the code for the scope.

Methods inherited from class ISOMetadata

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

Methods inherited from class ModifiableMetadata

check­Write­Permission, collection­Type, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, 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

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

Constructor Details

DefaultMetadataScope

public DefaultMetadataScope()

Constructs an initially empty metadata scope.

DefaultMetadataScope

public DefaultMetadataScope(ScopeCode resourceScope,
 CharSequence name)

Constructs a metadata scope initialized to the given value.

Parameters:

resource­Scope - code for the scope.

name - description of the scope, or null if none.

DefaultMetadataScope

public DefaultMetadataScope(DefaultMetadataScope 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.

Method Details

getResourceScope

@UML(identifier="resourceScope",
     obligation=MANDATORY,
     specification=ISO_19115)
public ScopeCode getResourceScope()

Returns the code for the scope.

Returns:

the code for the scope.

setResourceScope

public void setResourceScope(ScopeCode newValue)

Sets the code for the scope.

Parameters:

new­Value - the new code for the scope.

getName

@UML(identifier="name",
     obligation=OPTIONAL,
     specification=ISO_19115)
public InternationalString getName()

Returns a description of the scope, or null if none.

Returns:

description of the scope, or null if none.

setName

public void setName(InternationalString newValue)

Sets the description of the scope.

Parameters:

new­Value - the new description of the scope.