com.supermap.services.components.spi
Interface RealspaceProvider
-
- All Known Implementing Classes:
- MongoDBRealspaceProvider, RealspaceProviderBase, RestRealspaceProvider, TilesetRealspaceProvider, UGCRealspaceProvider
public interface RealspaceProvider3D service providers.
-
-
Method Summary
Methods Modifier and Type Method and Description booleancleanCacheData(java.lang.String dataName)Clears the cache of dynamic publishing data.java.lang.StringgetCacheAccessKey()Returns the password used to encrypt the cached data.RealspaceDataResultgetData(RealspaceDataParam dataParam)Gets 3D tile data results.RealspaceDataResultgetData(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.StringgetDataVersion(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.StringgetDataVersion(java.lang.String dataName, java.lang.String relativePath)Obtains the latest version number of the tile data according to the relative path.java.lang.StringgetLayerExtendXML(java.lang.String sceneName, java.lang.String layerName)Gets the layer extension information for the specified layerPrjCoordSysgetLayerPrj(java.lang.String sceneName, java.lang.String layerName)Gets the projection information for the specified layerbyte[]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 sceneSceneInfogetSceneInfo(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.RealspaceTilesRevisionInfogetTilesRevisionInfo(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.booleanisDataAvailable(java.lang.String dataName)Whether the three-dimensional data is available.booleanisSceneAvailable(java.lang.String sceneName)Whether the 3D scene is available.booleanisSecurityEnabled()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
-
-
-
Method Detail
-
getSceneNames
java.util.List<java.lang.String> getSceneNames() throws RealspaceExceptionGets the names of all available 3D scenes in the current service provider.- Returns:
- List of available scene names.
- Throws:
RealspaceException- 3D exception information.
-
getSceneInfo
SceneInfo getSceneInfo(java.lang.String sceneName) throws RealspaceException
According to the name of the 3D scene, gets the information of the 3D scene.- Parameters:
sceneName- the name of the 3D scene.- Returns:
- 3D scene information.
- Throws:
RealspaceException- 3D exception information.
-
getDataVersion
java.lang.String getDataVersion(java.lang.String dataName, int xIndex, int yIndex, int level, java.lang.String fileExtension) throws RealspaceExceptionObtain the latest version number of the tile data according to the index.- 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
java.lang.String getDataVersion(java.lang.String dataName, java.lang.String relativePath) throws RealspaceExceptionObtains 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.
- 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.
-
getData
RealspaceDataResult getData(RealspaceDataParam dataParam) throws RealspaceException
Gets 3D tile data results.- Parameters:
dataParam- Tile parameters.- Throws:
RealspaceException
-
getData
RealspaceDataResult getData(java.lang.String sceneName, java.lang.String layerName, RealspaceDataParam dataParam) throws RealspaceException
According to the scene name and layer name and tile parameters three-dimensional tile data results.- Parameters:
sceneName- Scene name.layerName- Layer name.dataParam- Tile parameters.- Throws:
RealspaceException
-
outputDataToMemory
RealspaceDataResult[] outputDataToMemory(java.lang.String sceneName, java.lang.String layerName, Output3DDataToMemoryParam outputParam) throws RealspaceException
Generates 3D tiles into memory based on scene name and layer name- Parameters:
sceneName- Scene name.layerName- Layer namedataParam-- Returns:
- The generated three-dimensional tiles
- Throws:
RealspaceException- Since:
- 7.1.2
-
getDataConfig
byte[] getDataConfig(java.lang.String dataName) throws RealspaceExceptionGets the configuration file for the 3D cache data by name.- 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
byte[] getDataConfig(java.lang.String dataName, CompressType compressType) throws RealspaceExceptionGets the configuration file for the 3D cache data by name.- 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
byte[] getModelIndex(java.lang.String dataName) throws RealspaceExceptionGets 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.
- 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
byte[] getVectorIndex(java.lang.String dataName) throws RealspaceExceptionObtains the index file of the 3D vector cache data by name.- 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
java.util.List<RealspaceDataInfo> getDataInfos() throws RealspaceException
Gets all the 3D data of the current Provider.- Returns:
- 3D data information.
- Throws:
RealspaceException- 3D exception information.
-
isDataAvailable
boolean isDataAvailable(java.lang.String dataName) throws RealspaceExceptionWhether the three-dimensional data is available.- 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
boolean isSceneAvailable(java.lang.String sceneName) throws RealspaceExceptionWhether the 3D scene is available.- 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
boolean isSecurityEnabled()
Whether the security mechanism is enabled.- Returns:
- Returns true if the security mechanism is enabled; false otherwise.
-
getCacheAccessKey
java.lang.String getCacheAccessKey()
Returns the password used to encrypt the cached data.- Returns:
- Returns the password used to encrypt the cached data.
-
cleanCacheData
boolean cleanCacheData(java.lang.String dataName) throws RealspaceExceptionClears the cache of dynamic publishing data.- Parameters:
dataName-- Returns:
- Throws:
RealspaceException
-
getOfflineDataPaths
java.util.List<OfflineDataInfo> getOfflineDataPaths(java.lang.String sceneName, java.lang.String layerName) throws RealspaceException
Gets all offline data paths for a particular 3D layer under a particular 3D scene- Parameters:
sceneName- Name of 3D scene.- Returns:
- Returns the offline package location
- Throws:
RealspaceException- Since:
- 6.1.3
-
getTilesRevisionInfo
RealspaceTilesRevisionInfo getTilesRevisionInfo(java.lang.String dataName, long revisionNumber) throws RealspaceException
Gets the tile change information for the specified version number.- Parameters:
revisionNumber- version number.- Returns:
- Change information.
- Throws:
RealspaceException
-
getLayerPrj
PrjCoordSys getLayerPrj(java.lang.String sceneName, java.lang.String layerName) throws RealspaceException
Gets the projection information for the specified layer- Parameters:
sceneName- Scene name.layerName- Layer name- Returns:
- Layer projection information
- Throws:
RealspaceException- Since:
- 7.1.2
-
getLayerExtendXML
java.lang.String getLayerExtendXML(java.lang.String sceneName, java.lang.String layerName) throws RealspaceExceptionGets the layer extension information for the specified layer- Parameters:
sceneName- Scene name.layerName- Layer name- Returns:
- Layer extension information xml
- Throws:
RealspaceException- Since:
- 8.0.2