Module org.opengis.geoapi

Package org.opengis.metadata.citation

Interface OnlineResource

@Classifier(DATATYPE)
@UML(identifier="CI_OnlineResource",
     specification=ISO_19115)
public interface OnlineResource

Information about on-line sources from which the dataset, specification, or community profile name and extended metadata elements can be obtained.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
default String	getApplicationProfile()	Name of an application profile that can be used with the online resource.
default InternationalString	getDescription()	Detailed text description of what the online resource is/does.
default OnLineFunction	getFunction()	Code for function performed by the online resource.
URI	getLinkage()	Location (address) for on-line access using a Uniform Resource Locator address or similar addressing scheme.
default String	getName()	Name of the online resource.
default String	getProtocol()	Connection protocol to be used.
default String	getProtocolRequest()	Request used to access the resource depending on the protocol.

Method Details

getLinkage

@Profile(level=CORE)
@UML(identifier="linkage",
     obligation=MANDATORY,
     specification=ISO_19115)
URI getLinkage()

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

Example: "http://www.statkart.no/isotc211".

Returns:

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

getProtocol

@UML(identifier="protocol",
     obligation=OPTIONAL,
     specification=ISO_19115)
default String getProtocol()

Connection protocol to be used.

Example: ftp, http get KVP, http POST, etc.

Returns:

connection protocol to be used, or null.

getApplicationProfile

@UML(identifier="applicationProfile",
     obligation=OPTIONAL,
     specification=ISO_19115)
default String getApplicationProfile()

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

Returns:

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

getName

@UML(identifier="name",
     obligation=OPTIONAL,
     specification=ISO_19115)
default String getName()

Name of the online resource.

Upcoming API change — internationalization
The return type will be changed from String to InternationalString in GeoAPI 4.0.

Returns:

name of the online resource, or null.

getDescription

@UML(identifier="description",
     obligation=OPTIONAL,
     specification=ISO_19115)
default InternationalString getDescription()

Detailed text description of what the online resource is/does.

Returns:

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

getFunction

@UML(identifier="function",
     obligation=OPTIONAL,
     specification=ISO_19115)
default OnLineFunction getFunction()

Code for function performed by the online resource.

Returns:

function performed by the online resource, or null.

getProtocolRequest

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

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;version=3.2"
            xmlns="(…snip…)">
    <Query typeNames="Roads"/>
</GetFeature>

Returns:

request used to access the resource, or null.

Since:

3.1