com.supermap.services.providers

Class RestRealspaceProvider

java.lang.Object

com.supermap.services.providers.RestProviderBase

com.supermap.services.providers.RestRealspaceProvider

All Implemented Interfaces:

Disposable, ProviderContextAware, RealspaceProvider

public class RestRealspaceProvider
extends RestProviderBase
implements RealspaceProvider, ProviderContextAware

Rest realspace service provider.

RestRealspaceProvider provides access to SuperMap 3D related services from iServer realspace REST service and encapsulates GIS functionality related to SuperMap 3D.

RestRealspaceProvider supports access to 3D scenes and 3D datasets; does not support symbol operations; does not support 3D data caching.

Nested Class Summary

Nested classes/interfaces inherited from class com.supermap.services.providers.RestProviderBase

RestProviderBase.CacheModel, RestProviderBase.RestRequestException

Field Summary

Fields inherited from class com.supermap.services.providers.RestProviderBase

JAVA_POSTFIX, javaConverter, JSON_POSTFIX, jsonConverter, jsonDecoder, lock, logger, message

Constructor Summary

Constructors

Constructor and Description
RestRealspaceProvider() The Constructor.
RestRealspaceProvider(RestRealspaceProviderSetting setting) The Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cleanCacheData(java.lang.String dataName) Clears the cache of dynamic publishing data.
java.lang.String	getCacheAccessKey() Returns the password used to encrypt the cached data.
RealspaceDataResult	getData(RealspaceDataParam dataParam) Gets 3D tile data results.
RealspaceDataResult	getData(java.lang.String sceneName, java.lang.String layerName, RealspaceDataParam dataParam) According to the scene name and layer name and tile parameters three-dimensional tile data results.
byte[]	getDataConfig(java.lang.String dataName) Gets the configuration file for the 3D cache data by name.
byte[]	getDataConfig(java.lang.String dataName, CompressType compressType) Gets the configuration file for the 3D cache data by name.
java.util.List<RealspaceDataInfo>	getDataInfos() Gets all the 3D data of the current Provider.
java.lang.String	getDataVersion(java.lang.String dataName, int xIndex, int yIndex, int level, java.lang.String fileExtension) Obtain the latest version number of the tile data according to the index.
java.lang.String	getDataVersion(java.lang.String dataName, java.lang.String relativePath) Obtains the latest version number of the tile data according to the relative path.
java.lang.String	getLayerExtendXML(java.lang.String sceneName, java.lang.String layerName) Gets the layer extension information for the specified layer
PrjCoordSys	getLayerPrj(java.lang.String sceneName, java.lang.String layerName) Gets the projection information for the specified layer
byte[]	getModelIndex(java.lang.String dataName) Gets the model index file for the 3D cache data by name.
java.util.List<OfflineDataInfo>	getOfflineDataPaths(java.lang.String sceneName, java.lang.String layerName) Gets all offline data paths for a particular 3D layer under a particular 3D scene
protected RestProviderSetting	getRestProviderSetting() Return the rest service provider configuration information.
SceneInfo	getSceneInfo(java.lang.String sceneName) According to the name of the 3D scene, gets the information of the 3D scene.
java.util.List<java.lang.String>	getSceneNames() Gets the names of all available 3D scenes in the current service provider.
RealspaceTilesRevisionInfo	getTilesRevisionInfo(java.lang.String dataName, long revisionNumber) Gets the tile change information for the specified version number.
byte[]	getVectorIndex(java.lang.String dataName) Obtains the index file of the 3D vector cache data by name.
boolean	isDataAvailable(java.lang.String dataName) Whether the three-dimensional data is available.
boolean	isSceneAvailable(java.lang.String sceneName) Whether the 3D scene is available.
boolean	isSecurityEnabled() Whether the security mechanism is enabled.
RealspaceDataResult[]	outputDataToMemory(java.lang.String sceneName, java.lang.String layerName, Output3DDataToMemoryParam outputParam) Generates 3D tiles into memory based on scene name and layer name
void	setProviderContext(ProviderContext context) Sets the service provider context

Methods inherited from class com.supermap.services.providers.RestProviderBase

clearCache, dispose, executeRequest, executeRequest, executeRequest, executeRequestForByteArray, executeRequestForByteArray, executeRequestForByteArray, executeRequestForByteArray, executeRequestForList, executeRequestForList, executeRequestForList, executeRequestForList, executeRequestForStream, executeRequestForStream, executeRequestForStream, executeRequestForText, executeRequestForText, executeRequestForText, handleExeption, init, newAndSetClient, rectifyRestServiceRootURL

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RestRealspaceProvider

public RestRealspaceProvider()

The Constructor.

RestRealspaceProvider

public RestRealspaceProvider(RestRealspaceProviderSetting setting)

The Constructor.

Parameters:

setting - Rest realspace service provider parameter object.

Method Detail

setProviderContext

public void setProviderContext(ProviderContext context)

Description copied from interface: ProviderContextAware

Sets the service provider context

Specified by:

setProviderContext in interface ProviderContextAware

Parameters:

context - service provider context

getSceneNames

public java.util.List<java.lang.String> getSceneNames()
                                               throws RealspaceException

Description copied from interface: RealspaceProvider

Gets the names of all available 3D scenes in the current service provider.

Specified by:

getSceneNames in interface RealspaceProvider

Returns:

List of available scene names.

Throws:

RealspaceException - 3D exception information.

getSceneInfo

public SceneInfo getSceneInfo(java.lang.String sceneName)
                       throws RealspaceException

Description copied from interface: RealspaceProvider

According to the name of the 3D scene, gets the information of the 3D scene.

Specified by:

getSceneInfo in interface RealspaceProvider

Parameters:

sceneName - the name of the 3D scene.

Returns:

3D scene information.

Throws:

RealspaceException - 3D exception information.

getDataConfig

public byte[] getDataConfig(java.lang.String dataName)
                     throws RealspaceException

Description copied from interface: RealspaceProvider

Gets the configuration file for the 3D cache data by name.

Specified by:

getDataConfig in interface RealspaceProvider

Parameters:

dataName - The name of the 3D data. Corresponds to the name of the 3D layer in the SuperMap 3D scene (LayerName).

Returns:

3D cache data configuration file.

Throws:

RealspaceException - 3D exception information.

getDataConfig

public byte[] getDataConfig(java.lang.String dataName,
                   CompressType compressType)
                     throws RealspaceException

Description copied from interface: RealspaceProvider

Gets the configuration file for the 3D cache data by name.

Specified by:

getDataConfig in interface RealspaceProvider

Parameters:

dataName - The name of the 3D data. Corresponds to the name of the 3D layer in the SuperMap 3D scene (LayerName).

Returns:

3D cache data configuration file.

Throws:

RealspaceException - 3D exception information.

getModelIndex

public byte[] getModelIndex(java.lang.String dataName)
                     throws RealspaceException

Description copied from interface: RealspaceProvider

Gets the model index file for the 3D cache data by name.

The file is indexed with "index" as the file extension name, and the configuration file for the model cache data (the file with the extension "scm") is located in the same parent directory.

Specified by:

getModelIndex in interface RealspaceProvider

Parameters:

dataName - The name of the 3D data. Corresponds to the name of the 3D layer in the SuperMap 3D scene (LayerName).

Returns:

Model index file.

Throws:

RealspaceException - 3D exception information.

getVectorIndex

public byte[] getVectorIndex(java.lang.String dataName)
                      throws RealspaceException

Description copied from interface: RealspaceProvider

Obtains the index file of the 3D vector cache data by name.

Specified by:

getVectorIndex in interface RealspaceProvider

Parameters:

dataName - The name of the 3D data. Corresponds to the name of the 3D layer in the SuperMap 3D scene (LayerName).

Returns:

Vector data index file.

Throws:

RealspaceException - 3D exception information.

getDataInfos

public java.util.List<RealspaceDataInfo> getDataInfos()
                                               throws RealspaceException

Description copied from interface: RealspaceProvider

Gets all the 3D data of the current Provider.

Specified by:

getDataInfos in interface RealspaceProvider

Returns:

3D data information.

Throws:

RealspaceException - 3D exception information.

isDataAvailable

public boolean isDataAvailable(java.lang.String dataName)
                        throws RealspaceException

Description copied from interface: RealspaceProvider

Whether the three-dimensional data is available.

Specified by:

isDataAvailable in interface RealspaceProvider

Parameters:

dataName - The name of the 3D data. Corresponds to the name of the 3D layer in the SuperMap 3D scene (LayerName).

Returns:

3D data is available to return true; otherwise it returns false.

Throws:

RealspaceException - 3D exception information.

isSceneAvailable

public boolean isSceneAvailable(java.lang.String sceneName)
                         throws RealspaceException

Description copied from interface: RealspaceProvider

Whether the 3D scene is available.

Specified by:

isSceneAvailable in interface RealspaceProvider

Parameters:

sceneName - the name of the 3D scene.

Returns:

3D scene is available to return true; otherwise it returns false.

Throws:

RealspaceException - 3D exception information.

isSecurityEnabled

public boolean isSecurityEnabled()

Description copied from interface: RealspaceProvider

Whether the security mechanism is enabled.

Specified by:

isSecurityEnabled in interface RealspaceProvider

Returns:

Returns true if the security mechanism is enabled; false otherwise.

getCacheAccessKey

public java.lang.String getCacheAccessKey()

Description copied from interface: RealspaceProvider

Returns the password used to encrypt the cached data.

Specified by:

getCacheAccessKey in interface RealspaceProvider

Returns:

Returns the password used to encrypt the cached data.

cleanCacheData

public boolean cleanCacheData(java.lang.String dataName)
                       throws RealspaceException

Description copied from interface: RealspaceProvider

Clears the cache of dynamic publishing data.

Specified by:

cleanCacheData in interface RealspaceProvider

Returns:

Throws:

RealspaceException

getOfflineDataPaths

public java.util.List<OfflineDataInfo> getOfflineDataPaths(java.lang.String sceneName,
                                                  java.lang.String layerName)

Description copied from interface: RealspaceProvider

Gets all offline data paths for a particular 3D layer under a particular 3D scene

Specified by:

getOfflineDataPaths in interface RealspaceProvider

Parameters:

sceneName - Name of 3D scene.

Returns:

Returns the offline package location

getRestProviderSetting

protected RestProviderSetting getRestProviderSetting()

Description copied from class: RestProviderBase

Return the rest service provider configuration information.

Specified by:

getRestProviderSetting in class RestProviderBase

Returns:

getData

public RealspaceDataResult getData(RealspaceDataParam dataParam)
                            throws RealspaceException

Description copied from interface: RealspaceProvider

Gets 3D tile data results.

Specified by:

getData in interface RealspaceProvider

Parameters:

dataParam - Tile parameters.

Throws:

RealspaceException

getData

public RealspaceDataResult getData(java.lang.String sceneName,
                          java.lang.String layerName,
                          RealspaceDataParam dataParam)
                            throws RealspaceException

Description copied from interface: RealspaceProvider

According to the scene name and layer name and tile parameters three-dimensional tile data results.

Specified by:

getData in interface RealspaceProvider

Parameters:

sceneName - Scene name.

layerName - Layer name.

dataParam - Tile parameters.

Throws:

RealspaceException

outputDataToMemory

public RealspaceDataResult[] outputDataToMemory(java.lang.String sceneName,
                                       java.lang.String layerName,
                                       Output3DDataToMemoryParam outputParam)
                                         throws RealspaceException

Description copied from interface: RealspaceProvider

Generates 3D tiles into memory based on scene name and layer name

Specified by:

outputDataToMemory in interface RealspaceProvider

Parameters:

sceneName - Scene name.

layerName - Layer name

Returns:

The generated three-dimensional tiles

Throws:

RealspaceException

getTilesRevisionInfo

public RealspaceTilesRevisionInfo getTilesRevisionInfo(java.lang.String dataName,
                                              long revisionNumber)
                                                throws RealspaceException

Description copied from interface: RealspaceProvider

Gets the tile change information for the specified version number.

Specified by:

getTilesRevisionInfo in interface RealspaceProvider

revisionNumber - version number.

Returns:

Change information.

Throws:

RealspaceException

getDataVersion

public java.lang.String getDataVersion(java.lang.String dataName,
                              int xIndex,
                              int yIndex,
                              int level,
                              java.lang.String fileExtension)
                                throws RealspaceException

Description copied from interface: RealspaceProvider

Obtain the latest version number of the tile data according to the index.

Specified by:

getDataVersion in interface RealspaceProvider

Parameters:

dataName - corresponds to the name of the 3D layer in the SuperMap 3D scene (LayerName).

xIndex - the index of the tile data in the X direction.

yIndex - the index of the tile data in the Y direction.

level - The layer number of the tile data, only the 3D cache data of the model needs to be set.

fileExtension - Tile data extension name. Including * .png, *. Jpg, *. bil and so on.

Returns:

tile version of the data.

Throws:

RealspaceException - 3D exception information.

getDataVersion

public java.lang.String getDataVersion(java.lang.String dataName,
                              java.lang.String relativePath)
                                throws RealspaceException

Description copied from interface: RealspaceProvider

Obtains the latest version number of the tile data according to the relative path.

The setting of the relative data of the tile data is as follows:

For terrain and image 3D cache data, the relative path starts with the directory where the cache configuration file (SCT and SCI3D) resides, that is, from the cache layer number, the hierarchical cache data is stored in the cache configuration file. Such as the cache layer number is 12, then the relative path is "12 /.../.../ cache file". For the model three-dimensional cache data, the relative path start from the cache configuration file parent-level directory, that is, from the cache layer number directory, the model data and terrain and image data is different, cached data is not stored in the hierarchical directory, but the model cache file index file (index), the version number refers to the index file version number. KML data has no version number.

Specified by:

getDataVersion in interface RealspaceProvider

Parameters:

dataName - The name of the 3D data. Corresponds to the name of the 3D layer in the SuperMap 3D scene (LayerName).

relativePath - the relative path of tile data.

Returns:

The latest version of the tile data.

Throws:

RealspaceException - 3D exception information.

getLayerPrj

public PrjCoordSys getLayerPrj(java.lang.String sceneName,
                      java.lang.String layerName)

Description copied from interface: RealspaceProvider

Gets the projection information for the specified layer

Specified by:

getLayerPrj in interface RealspaceProvider

Parameters:

sceneName - Scene name.

layerName - Layer name

Returns:

Layer projection information

getLayerExtendXML

public java.lang.String getLayerExtendXML(java.lang.String sceneName,
                                 java.lang.String layerName)
                                   throws RealspaceException

Description copied from interface: RealspaceProvider

Gets the layer extension information for the specified layer

Specified by:

getLayerExtendXML in interface RealspaceProvider

Parameters:

sceneName - Scene name.

layerName - Layer name

Returns:

Layer extension information xml

Throws:

RealspaceException