API / geotoolkit / ivaapbackend / CommonRemoteDataSource / CommonRemoteDataSource
ivaapbackend.CommonRemoteDataSource.CommonRemoteDataSource
Provides utility class to load data collections and individual datasets from IVAAP backend
AbstractRemoteDataSource<Data>↳
CommonRemoteDataSource
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
hostname | string | The host name for requests |
Constructors
• new CommonRemoteDataSource(options?)
| Name | Type |
|---|---|
Optional options | Options |
AbstractRemoteDataSource<CommonRemoteDataSource.Data&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
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
An object containing the properties
AbstractRemoteDataSource.getProperties
▸ Protected loadCollection<T>(url): Promise<DataCollection<T>>
Loads datasets collection
| Name | Type |
|---|---|
T | extends Dataset<Record<string, any>> |
| Name | Type | Description |
|---|---|---|
url | string | the collection url |
Promise<DataCollection<T>>
▸ Protected loadDataSet<T>(url): Promise<T>
Loads an individual dataset
| Name | Type | Description |
|---|---|---|
url | string | the data url |
Promise<T>
▸ loadMeta(url): Promise<Data>
Loads meta data
| Name | Type | Description |
|---|---|---|
url | string | url of meta information |
Promise<Data>
AbstractRemoteDataSource.loadMeta
▸ Protected setHostName(host): CommonRemoteDataSource
Sets host name
| Name | Type | Description |
|---|---|---|
host | string | the host name |
AbstractRemoteDataSource.setHostName
▸ Protected setHttpService(service): CommonRemoteDataSource
Sets a http service associated with this data source
| Name | Type | Description |
|---|---|---|
service | AbstractHttpService | the http service |
AbstractRemoteDataSource.setHttpService
▸ setProperties(properties?): CommonRemoteDataSource
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