Class DefaultOnlineResource
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultOnlineResource
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- 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_OnlineResource
   └─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 XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionCreates an initially empty on line resource.DefaultOnlineResource(URI linkage) Creates an on line resource initialized to the given URI.Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultOnlineResourcecastOrCopy(OnlineResource object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the name of an application profile that can be used with the online resource.Returns the detailed text description of what the online resource is/does.Returns the code for function performed by the online resource.Returns the location (address) for on-line access using a Uniform Resource Locator address or similar addressing scheme.getName()Name of the online resource.Returns the connection protocol to be used.Returns the request used to access the resource depending on the protocol.voidsetApplicationProfile(String newValue) Sets the name of an application profile that can be used with the online resource.voidsetDescription(InternationalString newValue) Sets the detailed text description of what the online resource is/does.voidsetFunction(OnLineFunction newValue) Sets the code for function performed by the online resource.voidsetLinkage(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".voidSets the name of the online resource.voidsetProtocol(String newValue) Sets the connection protocol to be used.voidsetProtocolRequest(String newValue) Sets the request to be used.Methods inherited from class ISOMetadatagetIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
- 
Constructor Details- 
DefaultOnlineResourcepublic DefaultOnlineResource()Creates an initially empty on line resource.
- 
DefaultOnlineResourceCreates an on line resource initialized to the given URI.- Parameters:
- linkage- the location for on-line access using a Uniform Resource Locator address, or- nullif none.
 
- 
DefaultOnlineResourceConstructs 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- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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 returnsnull.
- Otherwise if the given object is already an instance of
       DefaultOnlineResource, then it is returned unchanged.
- Otherwise a new DefaultOnlineResourceinstance 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- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- If the given object is 
- 
getApplicationProfileReturns the name of an application profile that can be used with the online resource. Returnsnullif none.- Specified by:
- getApplicationProfilein interface- OnlineResource
- Returns:
- application profile that can be used with the online resource, or null.
 
- 
setApplicationProfileSets the name of an application profile that can be used with the online resource.- Parameters:
- newValue- the new application profile.
 
- 
getNameName of the online resource. Returnsnullif none.Upcoming API change — internationalization
 The return type may be changed fromStringtoInternationalStringin GeoAPI 4.0.- Specified by:
- getNamein interface- OnlineResource
- Returns:
- name of the online resource, or null.
 
- 
setNameSets the name of the online resource.Upcoming API change — internationalization
 The argument type may be changed fromStringtoInternationalStringin GeoAPI 4.0.- Parameters:
- newValue- the new name, or- nullif none.
 
- 
getDescriptionReturns the detailed text description of what the online resource is/does.- Specified by:
- getDescriptionin interface- OnlineResource
- Returns:
- text description of what the online resource is/does, or null.
 
- 
setDescriptionSets the detailed text description of what the online resource is/does.- Parameters:
- newValue- the new description, or- nullif none.
 
- 
getFunctionReturns the code for function performed by the online resource.- Specified by:
- getFunctionin interface- OnlineResource
- Returns:
- function performed by the online resource, or null.
 
- 
setFunctionSets the code for function performed by the online resource.- Parameters:
- newValue- the new function, or- nullif none.
 
- 
getLinkageReturns the location (address) for on-line access using a Uniform Resource Locator address or similar addressing scheme.- Specified by:
- getLinkagein interface- OnlineResource
- Returns:
- location for on-line access using a Uniform Resource Locator address or similar scheme, or null.
 
- 
setLinkageSets 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:
- newValue- the new linkage, or- nullif none.
 
- 
getProtocolReturns the connection protocol to be used.Example: ftp, http get KVP, http POST, etc.- Specified by:
- getProtocolin interface- OnlineResource
- Returns:
- connection protocol to be used, or null.
 
- 
setProtocolSets the connection protocol to be used.- Parameters:
- newValue- the new protocol, or- nullif 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
 
- 
setProtocolRequestSets the request to be used.- Parameters:
- newValue- the new request, or- nullif none.
- Since:
- 0.5
 
 
-