CacheWriter (iObjects Java Help)

java.lang.Object
- com.supermap.data.processing.CacheWriter

```
public class CacheWriter
extends Object
```
地图缓存配置文件(sci)操作类，提供配置文件中所有要素的获取和设置。

构造器概要

构造器
构造器和说明

CacheWriter()
构造函数。

构造器
构造器和说明
`CacheWriter()` 构造函数。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addCacheWriterListener(CacheWriterListener listener)` 设置缓存写入时的监听对象。
`double`	`AdjustUnitsRatio()` 校正当前缓存投影的单位比率。
`Boolean`	`Build()` 生成缓存。
`Boolean`	`FromConfigFile(byte[] buffer)` 从流中导入缓存配置。
`Boolean`	`FromConfigFile(String fileName)` 从指定文件中导入缓存配置。
`Rectangle2D`	`getCacheBounds()` 获取缓存范围。
`String`	`getCacheName()` 获取缓存名称。
`HashMap<Double,String>`	`getCacheScaleCaptions()` 获取缓存所有比例尺和标题。
`double`	`getDPI()` 获取缓存DPI值。
`String[]`	`getGPKGConnectionInfo()` 获取缓存GPKG连接信息。
`String`	`getHashCode()` 获取当前缓存的哈希值。
`Rectangle2D`	`getIndexBounds()` 获取缓存索引范围。
`String`	`getMapName()` 获取缓存关联地图名称。
`String[]`	`getMongoConnectionInfo()` 获取缓存mongoDB连接信息。
`Boolean`	`getMvtStyleWithoutFont()` 获取矢量缓存生成风格时是否生成字体缓存。
`int`	`getMvtTileBuffer()` 获取矢量缓存瓦片的缓冲范围。
`int`	`getMvtTileExtent()` 获取矢量缓存瓦片内部坐标模大小。
`boolean`	`getMvtTriangleList()` 获取矢量缓存生成时是否生成三维索引值。
`Boolean`	`getMvtWithAllField()` 获取矢量缓存生成时是否包含所有字段信息。
`String`	`getOutputFolder()` 获取缓存输出目录。
`PrjCoordSys`	`getPrjCoordSys()` 获取缓存投影。
`String`	`getProvider()` 获取缓存服务提供值信息。
`double`	`getReolustion(double scale)` 获取指定比例尺对应的分辨率。
`Double`	`getScaleOriginalResolution()` 获取采用基本比例尺方式生成时的基础比例尺值。
`StorageType`	`getStorageType()` 获取缓存存储类型。
`TileFormat`	`getTileFormat()` 获取瓦片类型。
`String`	`getTilePath(Double scale, int row, int col)` 获取指定比例尺下行列号瓦片路径。
`double`	`getTileResolustion(double scale)` 获取指定比例尺对应的瓦片分辨率。
`TileSize`	`getTileSize()` 获取瓦片大小。
`Boolean`	`getTransparent()` 获取缓存是否背景透明。
`String`	`getVersionDescription()` 获取缓存版本描述信息。
`String`	`getVersionSetting()` 获取缓存版本信息。
`String`	`getWorkspacePath()` 获取缓存生成时使用的工作空间。
`Boolean`	`isbuildFromOriginalResolution()` 获取是否采用基本比例尺方式生成。
`Boolean`	`isMongoHighResolution()` 获取生成MongoDB缓存时是否使用高精度模式。
`boolean`	`isMosaicBuildSingle()` 获取是否单影像模式生成缓存。
`boolean`	`isSolidFileEnabled()` 获取地图原始缓存中是否用silid文件表达纯色瓦片，默认false，不用solid方式表达。
`String`	`parseTileFormat()` 根据当前瓦片类型返回缓存标记。
`void`	`removeCacheWriterListener(CacheWriterListener listener)` 删除缓存写入时的监听对象。
`void`	`setCacheBounds(Rectangle2D bounds)` 设置缓存范围。
`void`	`setCacheName(String name)` 设置缓存名称。
`void`	`setCacheScaleCaptions(Double[] scales)` 设置缓存生成的比例尺。
`void`	`setCacheScaleCaptions(HashMap<Double,String> newScaleCaptions)` 设置缓存所有比例尺和标题。
`void`	`setDPI(double dpi)` 设置缓存DPI值。
`void`	`setHashCode(String hashCode)` 设置当前缓存的哈希值。
`void`	`setIndexBounds(Rectangle2D bounds)` 设置缓存索引范围。
`void`	`setMosaicBuildSingle(boolean value)` 设置是否单影像模式生成缓存。
`void`	`setMosaicSinglePath(String value)` 设置单影像模式生成时的影像文件路径。
`void`	`setMvtStyleWithoutFont(Boolean value)` 设置矢量缓存生成风格时是否生成字体缓存。
`void`	`setMvtTileBuffer(int value)` 设置矢量缓存瓦片的缓冲范围。
`void`	`setMvtTileExtent(int value)` 设置矢量缓存瓦片内部坐标模大小。
`void`	`setMvtWithAllField(Boolean value)` 设置矢量缓存生成时是否包含所有字段信息。
`void`	`setOutputFolder(String folder)` 设置缓存输出目录。
`void`	`setPrjCoordSys(PrjCoordSys projCoordSys)` 设置缓存投影。
`void`	`setProvider(String provider)` 设置缓存服务提供值信息。
`void`	`setStorageType(StorageType storageType)` 设置缓存存储类型。
`void`	`setTileFormat(TileFormat tileFormat)` 设置瓦片类型。
`void`	`setTileSize(TileSize tileSize)` 设置瓦片大小。
`void`	`setTransparent(Boolean transparent)` 设置缓存是否背景透明。
`Boolean`	`ToConfigFile(String fileName)` 导出缓存配置到指定文件。
`void`	`writeTile(CacheTileParameter cacheTile, CompactTileParameter compactTile)` 写入瓦片

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - CacheWriter
```
public CacheWriter()
```
    构造函数。
- 方法详细资料
  - getCacheName
```
public String getCacheName()
```
    获取缓存名称。
    
    返回:
    
    缓存名称。
  - setCacheName
```
public void setCacheName(String name)
```
    设置缓存名称。
    
    参数:
    
    name - 新缓存名称。
  - getTileFormat
```
public TileFormat getTileFormat()
```
    获取瓦片类型。
    
    返回:
    
    瓦片类型枚举值。
  - setTileFormat
```
public void setTileFormat(TileFormat tileFormat)
```
    设置瓦片类型。
    
    参数:
    
    tileFormat - 瓦片类型值。
  - getTileSize
```
public TileSize getTileSize()
```
    获取瓦片大小。
    
    返回:
    
    瓦片大小值。
  - setTileSize
```
public void setTileSize(TileSize tileSize)
```
    设置瓦片大小。
    
    参数:
    
    tileSize - 瓦片大小值。
  - getHashCode
```
public String getHashCode()
```
    获取当前缓存的哈希值。
    
    返回:
    
    哈希字符串。
  - setHashCode
```
public void setHashCode(String hashCode)
```
    设置当前缓存的哈希值。
    
    参数:
    
    hashCode - 新哈希值。
  - getCacheScaleCaptions
```
public HashMap<Double,String> getCacheScaleCaptions()
```
    获取缓存所有比例尺和标题。
    
    返回:
    
    比例尺和标签表。
  - setCacheScaleCaptions
```
public void setCacheScaleCaptions(HashMap<Double,String> newScaleCaptions)
```
    设置缓存所有比例尺和标题。
    
    参数:
    
    newScaleCaptions - 比例尺和标签表对象。
  - setCacheScaleCaptions
```
public void setCacheScaleCaptions(Double[] scales)
```
    设置缓存生成的比例尺。
    
    参数:
    
    scales - 比例尺数组。
  - getPrjCoordSys
```
public PrjCoordSys getPrjCoordSys()
```
    获取缓存投影。
    
    返回:
    
    投影对象。
  - setPrjCoordSys
```
public void setPrjCoordSys(PrjCoordSys projCoordSys)
```
    设置缓存投影。
    
    参数:
    
    projCoordSys - 投影对象。
  - getDPI
```
public double getDPI()
```
    获取缓存DPI值。
    
    返回:
    
    DPI值。
  - setDPI
```
public void setDPI(double dpi)
```
    设置缓存DPI值。
    
    参数:
    
    dpi - DPI值。
  - getStorageType
```
public StorageType getStorageType()
```
    获取缓存存储类型。
    
    返回:
    
    存储类型枚举值。
  - setStorageType
```
public void setStorageType(StorageType storageType)
```
    设置缓存存储类型。
    
    参数:
    
    storageType - 存储类型枚举对象。
  - getCacheBounds
```
public Rectangle2D getCacheBounds()
```
    获取缓存范围。
    
    返回:
    
    缓存范围。
  - setCacheBounds
```
public void setCacheBounds(Rectangle2D bounds)
```
    设置缓存范围。
    
    参数:
    
    bounds - 缓存范围矩形对象。
  - getIndexBounds
```
public Rectangle2D getIndexBounds()
```
    获取缓存索引范围。
    
    返回:
    
    索引范围值。
  - setIndexBounds
```
public void setIndexBounds(Rectangle2D bounds)
```
    设置缓存索引范围。
    
    参数:
    
    bounds - 索引范围矩形对象。
  - getOutputFolder
```
public String getOutputFolder()
```
    获取缓存输出目录。
    
    返回:
    
    目录地址。
  - setOutputFolder
```
public void setOutputFolder(String folder)
```
    设置缓存输出目录。
    
    参数:
    
    folder - 目录地址。
  - getTransparent
```
public Boolean getTransparent()
```
    获取缓存是否背景透明。
    
    返回:
    
    是否背景透明。
  - setTransparent
```
public void setTransparent(Boolean transparent)
```
    设置缓存是否背景透明。
    
    参数:
    
    transparent - 背景是否透明。
  - getProvider
```
public String getProvider()
```
    获取缓存服务提供值信息。
    
    返回:
    
    服务提供链接地址。
  - setProvider
```
public void setProvider(String provider)
```
    设置缓存服务提供值信息。
    
    参数:
    
    provider - 服务提供链接地址。
  - getMongoConnectionInfo
```
public String[] getMongoConnectionInfo()
```
    获取缓存mongoDB连接信息。
    
    返回:
    
    连续信息数组。
  - getGPKGConnectionInfo
```
public String[] getGPKGConnectionInfo()
```
    获取缓存GPKG连接信息。
    
    返回:
    
    GPKG信息数组。
  - getVersionSetting
```
public String getVersionSetting()
```
    获取缓存版本信息。
    
    返回:
    
    版本字符串。
  - getVersionDescription
```
public String getVersionDescription()
```
    获取缓存版本描述信息。
    
    返回:
    
    版本描述信息。
  - getMvtStyleWithoutFont
```
public Boolean getMvtStyleWithoutFont()
```
    获取矢量缓存生成风格时是否生成字体缓存。
    
    返回:
    
    true代表不生成字体缓存，false反之。
  - setMvtStyleWithoutFont
```
public void setMvtStyleWithoutFont(Boolean value)
```
    设置矢量缓存生成风格时是否生成字体缓存。
    
    参数:
    
    value - true代表不生成字体缓存，false反之。
  - getMvtWithAllField
```
public Boolean getMvtWithAllField()
```
    获取矢量缓存生成时是否包含所有字段信息。
    
    返回:
    
    true代表包含所有字段内容，false反之。
  - setMvtWithAllField
```
public void setMvtWithAllField(Boolean value)
```
    设置矢量缓存生成时是否包含所有字段信息。
    
    参数:
    
    value - true代表包含所有字段内容，false反之。
  - getMvtTileBuffer
```
public int getMvtTileBuffer()
```
    获取矢量缓存瓦片的缓冲范围。
    
    返回:
    
    缓存范围值。
  - setMvtTileBuffer
```
public void setMvtTileBuffer(int value)
```
    设置矢量缓存瓦片的缓冲范围。
    
    参数:
    
    value - 缓存范围值。
  - getMvtTileExtent
```
public int getMvtTileExtent()
```
    获取矢量缓存瓦片内部坐标模大小。
    
    返回:
    
    内部坐标模大小值。
  - setMvtTileExtent
```
public void setMvtTileExtent(int value)
```
    设置矢量缓存瓦片内部坐标模大小。
    
    参数:
    
    value - 模大小值。
  - getMvtTriangleList
```
public boolean getMvtTriangleList()
```
    获取矢量缓存生成时是否生成三维索引值。
    
    返回:
    
    true代表生成三维索引，false反之。
  - isbuildFromOriginalResolution
```
public Boolean isbuildFromOriginalResolution()
```
    获取是否采用基本比例尺方式生成。
    
    返回:
    
    true代表采用基础比例尺生成，false反之。
  - getScaleOriginalResolution
```
public Double getScaleOriginalResolution()
```
    获取采用基本比例尺方式生成时的基础比例尺值。
    
    返回:
    
    基础比例尺值。
  - getMapName
```
public String getMapName()
```
    获取缓存关联地图名称。
    
    返回:
    
    地图名称。
  - getWorkspacePath
```
public String getWorkspacePath()
```
    获取缓存生成时使用的工作空间。
    
    返回:
    
    工作空间路径。
  - isMongoHighResolution
```
public Boolean isMongoHighResolution()
```
    获取生成MongoDB缓存时是否使用高精度模式。
    
    返回:
    
    true代码使用高精度，false反之。
  - isMosaicBuildSingle
```
public boolean isMosaicBuildSingle()
```
    获取是否单影像模式生成缓存。
    
    返回:
    
    返回是否为单影像模式生成缓存。
    
    从以下版本开始:
    
    11.2.0
  - setMosaicBuildSingle
```
public void setMosaicBuildSingle(boolean value)
```
    设置是否单影像模式生成缓存。
    
    参数:
    
    value - true为使用单影像模式生成，false反之。
    
    从以下版本开始:
    
    11.2.0
  - setMosaicSinglePath
```
public void setMosaicSinglePath(String value)
```
    设置单影像模式生成时的影像文件路径。
    
    参数:
    
    value - 影像文件绝对路径。
    
    从以下版本开始:
    
    11.2.0
  - isSolidFileEnabled
```
public boolean isSolidFileEnabled()
```
    获取地图原始缓存中是否用silid文件表达纯色瓦片，默认false，不用solid方式表达。
    
    返回:
    
    返回当前值，true为使用solid方式表达，false反之。
    
    从以下版本开始:
    
    11.2.0
  - addCacheWriterListener
```
public void addCacheWriterListener(CacheWriterListener listener)
```
    设置缓存写入时的监听对象。
    
    参数:
    
    listener - 监听实例对象。
  - removeCacheWriterListener
```
public void removeCacheWriterListener(CacheWriterListener listener)
```
    删除缓存写入时的监听对象。
    
    参数:
    
    listener - 监听实例对象。
  - writeTile
```
public void writeTile(CacheTileParameter cacheTile,
                      CompactTileParameter compactTile)
```
    写入瓦片
    
    参数:
    
    cacheTile - 瓦片参数。
    
    compactTile - 紧凑文件参数。
  - Build
```
public Boolean Build()
              throws Exception
```
    生成缓存。
    
    返回:
    
    是否生成成功。
    
    抛出:
    
    Exception - 可能引起文件操作异常。
  - getReolustion
```
public double getReolustion(double scale)
```
    获取指定比例尺对应的分辨率。
    
    参数:
    
    scale - 比例尺。
    
    返回:
    
    分辨率。
  - getTileResolustion
```
public double getTileResolustion(double scale)
```
    获取指定比例尺对应的瓦片分辨率。
    
    参数:
    
    scale - 比例尺。
    
    返回:
    
    瓦片分辨率。
  - AdjustUnitsRatio
```
public double AdjustUnitsRatio()
```
    校正当前缓存投影的单位比率。
    
    返回:
    
    单位比率。
  - getTilePath
```
public String getTilePath(Double scale,
                          int row,
                          int col)
```
    获取指定比例尺下行列号瓦片路径。
    
    参数:
    
    scale - 比例尺。
    
    row - 行号。
    
    col - 列号。
    
    返回:
    
    瓦片路径。
  - ToConfigFile
```
public Boolean ToConfigFile(String fileName)
                     throws Exception
```
    导出缓存配置到指定文件。
    
    参数:
    
    fileName - 文件路径。
    
    返回:
    
    是否导出成功。
    
    抛出:
    
    Exception - 可能引起文件操作异常。
  - FromConfigFile
```
public Boolean FromConfigFile(String fileName)
```
    从指定文件中导入缓存配置。
    
    参数:
    
    fileName - 文件路径。
    
    返回:
    
    是否导入成功。
  - FromConfigFile
```
public Boolean FromConfigFile(byte[] buffer)
```
    从流中导入缓存配置。
    
    参数:
    
    buffer - 内容流。
    
    返回:
    
    是否导入成功。
  - parseTileFormat
```
public String parseTileFormat()
```
    根据当前瓦片类型返回缓存标记。
    
    返回:
    
    瓦片类型对应标记。

类 CacheWriter

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

CacheWriter

方法详细资料

getCacheName

setCacheName

getTileFormat

setTileFormat

getTileSize

setTileSize

getHashCode

setHashCode

getCacheScaleCaptions

setCacheScaleCaptions

setCacheScaleCaptions

getPrjCoordSys

setPrjCoordSys

getDPI

setDPI

getStorageType

setStorageType

getCacheBounds

setCacheBounds

getIndexBounds

setIndexBounds

getOutputFolder

setOutputFolder

getTransparent

setTransparent

getProvider

setProvider

getMongoConnectionInfo

getGPKGConnectionInfo

getVersionSetting

getVersionDescription

getMvtStyleWithoutFont

setMvtStyleWithoutFont

getMvtWithAllField

setMvtWithAllField

getMvtTileBuffer

setMvtTileBuffer

getMvtTileExtent

setMvtTileExtent

getMvtTriangleList

isbuildFromOriginalResolution

getScaleOriginalResolution

getMapName

getWorkspacePath

isMongoHighResolution

isMosaicBuildSingle

setMosaicBuildSingle

setMosaicSinglePath

isSolidFileEnabled

addCacheWriterListener

removeCacheWriterListener

writeTile

Build

getReolustion

getTileResolustion

AdjustUnitsRatio

getTilePath

ToConfigFile

FromConfigFile

FromConfigFile

parseTileFormat