API / geotoolkit / ivaapbackend / RemoteDataSource / RemoteDataSource
ivaapbackend.RemoteDataSource.RemoteDataSource
Provides implementation of data source for loading data from IVAAP backend that stores dataset identifier, its content, and list of links after the loading completed.
| Name | Type |
|---|---|
T | extends object |
↳
RemoteDataSource
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
hostname | string | The host name for requests |
Constructors
• new RemoteDataSource<T>(options?)
| Name | Type |
|---|---|
T | extends object |
| Name | Type |
|---|---|
Optional options | Options |
AbstractRemoteDataSource<T&gt;.constructor
Methods
▸ dispose(): void
Dispose
void
AbstractRemoteDataSource.dispose
▸ getClassName(): string
string
AbstractRemoteDataSource.getClassName
▸ Protected getHostName(): string
Gets host name
string
AbstractRemoteDataSource.getHostName
▸ Protected getHttpService(): AbstractHttpService
Gets a http service associated with this data source
AbstractRemoteDataSource.getHttpService
▸ getId(): string
Gets data identifier
string
▸ getLinks(): Link[]
Gets links
Link[]
▸ getMetaData(): T
Returns meta information from IVAAP backend
T
meta meta data
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
An object containing the properties
AbstractRemoteDataSource.getProperties
▸ loadMeta(url, onProgress?, cancel?): Promise<T>
Load meta data
| Name | Type | Description |
|---|---|---|
url | string | url of metaData information |
Optional onProgress | (event: ProgressEvent<EventTarget>) => void | a function to be executed to handle progress |
Optional cancel | Cancel | a Cancel object that can be used to cancel the loading |
Promise<T>
The promise for the MetaData
AbstractRemoteDataSource.loadMeta
▸ Protected setHostName(host): RemoteDataSource<T>
Sets host name
| Name | Type | Description |
|---|---|---|
host | string | the host name |
AbstractRemoteDataSource.setHostName
▸ Protected setHttpService(service): RemoteDataSource<T>
Sets a http service associated with this data source
| Name | Type | Description |
|---|---|---|
service | AbstractHttpService | the http service |
AbstractRemoteDataSource.setHttpService
▸ Protected setId(id): RemoteDataSource<T>
Sets data identifier
| Name | Type | Description |
|---|---|---|
id | string | the identifier |
▸ Protected setLinks(links): RemoteDataSource<T>
Sets links
| Name | Type | Description |
|---|---|---|
links | Link[] | the links |
▸ Protected setMetaData(meta): RemoteDataSource<T>
Sets meta information
| Name | Type | Description |
|---|---|---|
meta | T | the meta information |
▸ setProperties(properties?): RemoteDataSource<T>
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
this
AbstractRemoteDataSource.setProperties
▸ Static getClassName(): string
string