com.ontimize.util.gis.client.interfaces
Interface IGisClientManager

All Known Implementing Classes:
DefaultGisClientManager

public interface IGisClientManager

Gis client manager interface


Method Summary
 void clearConfiguration(java.lang.Object configurationId)
          Clear all the data on client side related to the given Gis layers configuration
 void clearLayersCache(java.lang.Object layersId)
          Clear the client data cache related to the given layers identifiers layersId
 void deleteLayer(java.lang.Object layerKeys)
          Delete the layer layerId
 void deleteLayerData(java.lang.Object layerKeys, java.lang.Object deletedKeys)
          Delete the data identified by deletedKeys from the layer layerId
 IGisCacheManager getCacheManager()
          Get cache manager
 java.lang.Object getConfigurationParameters(java.lang.Object configurationId)
          Get the initial configuration parameters for the gis viewer with the identifier configurationId
 IGisDataDispatcher getDataDispatcher()
          Get Gis data dispatcher
 java.lang.Object getDataHandlerReference(java.lang.Object layerKeys)
          Get the reference of the data handler related to the given layer
 IGisDataRequestsManager getDataRequestsManager()
          Get Gis data requests manager
 void getLayerData(java.lang.Object requesterId, java.lang.Object layerKeys, java.lang.Object appliedFilters)
          Request the data related to the filters appliedFilters from the layer layerId, the requester receives the data throught the method setData() of interface IDataRequester
 java.lang.Object getLayerDataSynchronous(java.lang.Object requesterId, java.lang.Object layerKeys, java.lang.Object appliedFilters)
          Synchonous request of data related to the filters appliedFilters from the layer layerId, the requester waits for the client manager data returning
 java.lang.Object getLayersInformation(java.lang.Object layersConfigurationId)
          Get the layers configuration with the identifier layersConfigurationId
 IGisClientSideDataManager getLocalDataManager()
          Gets the client side data manager, if exists
 com.ontimize.locator.ReferenceLocator getReferenceLocator()
           
 java.lang.String getRemotePreference(java.lang.String preference)
          Get a remote preference
 IGisServerManager getServerManager()
          Get gis server manager reference
 void insertLayer(java.lang.Object insertParameters)
          Insert a new layer with the parameters insertParameters
 java.lang.Object insertLayerData(java.lang.Object layerKeys, java.lang.Object insertedValues)
          Insert the given data insertedValues into the layer indentified by layerId
 void updateLayer(java.lang.Object layerKeys, java.lang.Object updateParameters)
          Update the parameters defined at updateParameters for the layer with reference layerId
 void updateLayerData(java.lang.Object layerKeys, java.lang.Object updatedKeys, java.lang.Object newValues)
          Update the data identified by updatedKeys with the values newValues for the layer layerId
 void updateRemotePreference(java.lang.String preference, java.lang.String param)
          Updates a remote preference
 

Method Detail

insertLayer

void insertLayer(java.lang.Object insertParameters)
Insert a new layer with the parameters insertParameters

Parameters:
insertParameters - New layer configuration parameters

updateLayer

void updateLayer(java.lang.Object layerKeys,
                 java.lang.Object updateParameters)
Update the parameters defined at updateParameters for the layer with reference layerId

Parameters:
layerKeys - Identifiers for the layer to update
updateParameters - Parameters to update

deleteLayer

void deleteLayer(java.lang.Object layerKeys)
Delete the layer layerId

Parameters:
layerKeys - Identifiers for the layer to delete

insertLayerData

java.lang.Object insertLayerData(java.lang.Object layerKeys,
                                 java.lang.Object insertedValues)
Insert the given data insertedValues into the layer indentified by layerId

Parameters:
layerKeys - Identifiers for the layer to insert
insertedValues - New values to insert

updateLayerData

void updateLayerData(java.lang.Object layerKeys,
                     java.lang.Object updatedKeys,
                     java.lang.Object newValues)
Update the data identified by updatedKeys with the values newValues for the layer layerId

Parameters:
layerKeys - Identifiers for the layer to update
updatedKeys - Identifiers of the values to update
newValues - Values to update

deleteLayerData

void deleteLayerData(java.lang.Object layerKeys,
                     java.lang.Object deletedKeys)
Delete the data identified by deletedKeys from the layer layerId

Parameters:
layerKeys - Identifiers for the layer to delete
deletedKeys - Identifiers of the values to delete

getLayerData

void getLayerData(java.lang.Object requesterId,
                  java.lang.Object layerKeys,
                  java.lang.Object appliedFilters)
Request the data related to the filters appliedFilters from the layer layerId, the requester receives the data throught the method setData() of interface IDataRequester

Parameters:
requesterId - Reference to the object that request the data
layerKeys - Identifiers for the layer to request
appliedFilters - Defined filters for the data request

getLayerDataSynchronous

java.lang.Object getLayerDataSynchronous(java.lang.Object requesterId,
                                         java.lang.Object layerKeys,
                                         java.lang.Object appliedFilters)
Synchonous request of data related to the filters appliedFilters from the layer layerId, the requester waits for the client manager data returning

Parameters:
requesterId - Reference to the object that request the data
layerKeys - Identifiers for the layer to request
appliedFilters - Defined filters for the data request
Returns:
requested layer data

getDataHandlerReference

java.lang.Object getDataHandlerReference(java.lang.Object layerKeys)
Get the reference of the data handler related to the given layer

Parameters:
layerKeys - Identifiers for the layer
Returns:
reference of the requested data handler

clearLayersCache

void clearLayersCache(java.lang.Object layersId)
Clear the client data cache related to the given layers identifiers layersId

Parameters:
layersId - Indentifier of the layers to delete from the cache

updateRemotePreference

void updateRemotePreference(java.lang.String preference,
                            java.lang.String param)
Updates a remote preference

Parameters:
preference - Preference name
param - Preference value

getRemotePreference

java.lang.String getRemotePreference(java.lang.String preference)
Get a remote preference

Parameters:
preference - Preference name

getDataRequestsManager

IGisDataRequestsManager getDataRequestsManager()
Get Gis data requests manager

Returns:
data requests manager

getDataDispatcher

IGisDataDispatcher getDataDispatcher()
Get Gis data dispatcher

Returns:
data dispatcher

getCacheManager

IGisCacheManager getCacheManager()
Get cache manager

Returns:
cache manager

getServerManager

IGisServerManager getServerManager()
Get gis server manager reference

Returns:
server manager

getLocalDataManager

IGisClientSideDataManager getLocalDataManager()
Gets the client side data manager, if exists

Returns:
client side data manager

getLayersInformation

java.lang.Object getLayersInformation(java.lang.Object layersConfigurationId)
Get the layers configuration with the identifier layersConfigurationId

Parameters:
layersConfigurationId - Identifier for the layers configuration data
Returns:
requested layers configuration data

getConfigurationParameters

java.lang.Object getConfigurationParameters(java.lang.Object configurationId)
Get the initial configuration parameters for the gis viewer with the identifier configurationId

Parameters:
configurationId - Identifier for the configuration data
Returns:
requested configuration data

clearConfiguration

void clearConfiguration(java.lang.Object configurationId)
Clear all the data on client side related to the given Gis layers configuration

Parameters:
configurationId - Layers configuration to clear

getReferenceLocator

com.ontimize.locator.ReferenceLocator getReferenceLocator()