Class DefaultOnlineResource

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultOnlineResource

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Online­Resource

@TitleProperty(name="name")
public class DefaultOnlineResource
extends ISOMetadata
implements OnlineResource

Information about on-line sources from which the dataset, specification, or community profile name and extended metadata elements can be obtained. The following property is mandatory in a well-formed metadata according ISO 19115:

CI_Online­Resource └─linkage……………… Location (address) for on-line access using a Uniform Resource Locator address or similar addressing scheme.

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­Online­Resource()	Creates an initially empty on line resource.
Default­Online­Resource(URI linkage)	Creates an on line resource initialized to the given URI.
Default­Online­Resource(Online­Resource object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Online­Resource	cast­Or­Copy(Online­Resource object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
String	get­Application­Profile()	Returns the name of an application profile that can be used with the online resource.
International­String	get­Description()	Returns the detailed text description of what the online resource is/does.
On­Line­Function	get­Function()	Returns the code for function performed by the online resource.
URI	get­Linkage()	Returns the location (address) for on-line access using a Uniform Resource Locator address or similar addressing scheme.
String	get­Name()	Name of the online resource.
String	get­Protocol()	Returns the connection protocol to be used.
String	get­Protocol­Request()	Returns the request used to access the resource depending on the protocol.
void	set­Application­Profile(String new­Value)	Sets the name of an application profile that can be used with the online resource.
void	set­Description(International­String new­Value)	Sets the detailed text description of what the online resource is/does.
void	set­Function(On­Line­Function new­Value)	Sets the code for function performed by the online resource.
void	set­Linkage(URI new­Value)	Sets the location (address) for on-line access using a Uniform Resource Locator address or similar addressing scheme such as "http://www.statkart.no/isotc211".
void	set­Name(String new­Value)	Sets the name of the online resource.
void	set­Protocol(String new­Value)	Sets the connection protocol to be used.
void	set­Protocol­Request(String new­Value)	Sets the request to be used.

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

DefaultOnlineResource

public DefaultOnlineResource()

Creates an initially empty on line resource.

DefaultOnlineResource

public DefaultOnlineResource(URI linkage)

Creates an on line resource initialized to the given URI.

Parameters:

linkage - the location for on-line access using a Uniform Resource Locator address, or null if none.

DefaultOnlineResource

public DefaultOnlineResource(OnlineResource 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(Online­Resource)

Method Details

castOrCopy

public static DefaultOnlineResource castOrCopy(OnlineResource 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­Online­Resource, then it is returned unchanged.
• Otherwise a new Default­Online­Resource 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.

getApplicationProfile

public String getApplicationProfile()

Returns the name of an application profile that can be used with the online resource. Returns null if none.

Specified by:

get­Application­Profile in interface Online­Resource

Returns:

application profile that can be used with the online resource, or null.

setApplicationProfile

public void setApplicationProfile(String newValue)

Sets the name of an application profile that can be used with the online resource.

Parameters:

new­Value - the new application profile.

getName

public String getName()

Name of the online resource. Returns null if none.

Upcoming API change — internationalization
The return type may be changed from String to International­String in GeoAPI 4.0.

Specified by:

get­Name in interface Online­Resource

Returns:

name of the online resource, or null.

setName

public void setName(String newValue)

Sets the name of the online resource.

Upcoming API change — internationalization
The argument type may be changed from String to International­String in GeoAPI 4.0.

Parameters:

new­Value - the new name, or null if none.

getDescription

public InternationalString getDescription()

Returns the detailed text description of what the online resource is/does.

Specified by:

get­Description in interface Online­Resource

Returns:

text description of what the online resource is/does, or null.

setDescription

public void setDescription(InternationalString newValue)

Sets the detailed text description of what the online resource is/does.

Parameters:

new­Value - the new description, or null if none.

getFunction

public OnLineFunction getFunction()

Returns the code for function performed by the online resource.

Specified by:

get­Function in interface Online­Resource

Returns:

function performed by the online resource, or null.

setFunction

public void setFunction(OnLineFunction newValue)

Sets the code for function performed by the online resource.

Parameters:

new­Value - the new function, or null if none.

getLinkage

public URI getLinkage()

Returns the location (address) for on-line access using a Uniform Resource Locator address or similar addressing scheme.

Specified by:

get­Linkage in interface Online­Resource

Returns:

location for on-line access using a Uniform Resource Locator address or similar scheme, or null.

setLinkage

public void setLinkage(URI newValue)

Sets the location (address) for on-line access using a Uniform Resource Locator address or similar addressing scheme such as "http://www.statkart.no/isotc211".

Parameters:

new­Value - the new linkage, or null if none.

getProtocol

public String getProtocol()

Returns the connection protocol to be used.

Examples

ftp, http get KVP, http POST, etc.

Specified by:

get­Protocol in interface Online­Resource

Returns:

connection protocol to be used, or null.

setProtocol

public void setProtocol(String newValue)

Sets the connection protocol to be used.

Parameters:

new­Value - the new protocol, or null if none.

getProtocolRequest

@UML(identifier="protocolRequest",
     obligation=OPTIONAL,
     specification=ISO_19115)
public String getProtocolRequest()

Returns the request used to access the resource depending on the protocol. This is used mainly for POST requests.

Example

<GetFeature service="WFS" version="2.0.0"
            outputFormat="application/gml+xml;verson=3.2"
            xmlns="(…snip…)">
    <Query typeNames="Roads"/>
</GetFeature>

Returns:

Request used to access the resource.

Since:

0.5

setProtocolRequest

public void setProtocolRequest(String newValue)

Sets the request to be used.

Parameters:

new­Value - the new request, or null if none.

Since:

0.5