CacheBuilderGridTerrain (iObjects Java Help)

java.lang.Object
- com.supermap.data.InternalHandle
- - com.supermap.data.InternalHandleDisposable
  - - com.supermap.data.processing.CacheBuilderGridTerrain

所有已实现的接口:

IDisposable
```
public class CacheBuilderGridTerrain
extends com.supermap.data.InternalHandleDisposable
```
地形瓦片生成类，实现生成全球剖分方式的地形瓦片。

构造器概要

构造器
构造器和说明

CacheBuilderGridTerrain()
构造函数，构造一个新的CacheBuilderGridTerrain对象。

构造器
构造器和说明
`CacheBuilderGridTerrain()` 构造函数，构造一个新的CacheBuilderGridTerrain对象。

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addSteppedListener(SteppedListener l)` 添加一个进度条事件（`SteppedEvent`）的监听器。
`boolean`	`build()` 执行生成地形缓存。
`boolean`	`combineTerrainConfigFile(String strOutConfigPathName, String[] arrInPathNames, boolean HasCacheFile)` 生成发布地形合并服务的配置文件，支持栅格地形发布配置文件时是否生成相交区域的预瓦片。
`byte[]`	`combineTerrainTiles(GridTerrainCacheInfo info, int level, int row, int col)` 请求合并两个地形文件.
`boolean`	`computeLevel()` 计算设置数据集所正确的缓存级数，在非默认构造函数中会自动调用该方法，不过通过设置Dataset不会执行该方法。
`void`	`dispose()` 释放占用资源。
`boolean`	`fromConfigFile(String configPath)` 导入地形瓦片配置文件，即根据配置文件中的内容来设置该地形瓦片对象。
`boolean`	`generateConfigFile(String strFileName)` 生成缓存配置文件（目前仅支持镶嵌数据集生成栅格地形缓存）
`int`	`getBeginLevel()` 获取开始生成缓存的层数。
`int`	`getBlockScale()` 获取直接生成Block存储的缓存。
`Rectangle2D`	`getBounds()` 获取生成地形缓存的范围，
`String`	`getCacheName()` 获取生成缓存的名称。
`DatasetGrid`	`getDataset()` 获取数据集
`DatasetMosaic`	`getDatasetMosaic()` 获取镶嵌数据集
`EncodeType`	`getEncodeType()` 获取地形缓存文件的编码类型。
`int`	`getEndLevel()` 获取或设置结束生成缓存的层数。
`GridDataType`	`getGridDataType()` 获取缓存栅格数据类型。
`String`	`getOutputFolder()` 获取输出的缓存文件的全路径。
`String`	`getPassword()` 获取大文件缓存密码
`int`	`getProcessThreadsCount()` 获取生成栅格地形缓存的线程数。
`int`	`getSampleSize()` 获取缓存预处理后生成的每个缓存分块文件的采样尺寸，单位为像素。
`StorageType`	`getStorageType()` 获取缓存的存储方式，
`boolean`	`openFile(String tifPath)` 打开TIF地形文件，支持TIF文件直接生成栅格地形缓存
`void`	`removeSteppedListener(SteppedListener l)` 移除一个进度条事件（`SteppedEvent`）的监听器。
`void`	`setBeginLevel(int level)` 设置生成地形瓦片的开始层数。
`void`	`setBlockScale(int blockScale)` 设置直接生成Block存储的缓存。
`void`	`setBounds(Rectangle2D bounds)` 设置生成地形瓦片的范围。
`void`	`setCacheName(String name)` 设置生成地形瓦片的瓦片名称。
`void`	`setDataset(DatasetGrid dataset)` 设置生成地形瓦片的栅格数据集。
`void`	`setDatasetMosaic(DatasetMosaic mosaicDataset)` 设置镶嵌数据集
`void`	`setEncodeType(EncodeType type)` 获取或设置地形缓存文件的编码类型。
`void`	`setEndLevel(int level)` 设置生成地形瓦片的结束层数。
`void`	`setGridDataType(GridDataType dataType)` 设置缓存栅格数据类型。
`static void`	`setIsDisposable(com.supermap.data.InternalHandleDisposable obj, boolean disposable)`
`void`	`setOutputFolder(String path)` 设置生成地形瓦片的输出全路径。
`void`	`setPassword(String password)` 设置大文件缓存密码
`void`	`setProcessThreadsCount(int threadCount)` 获取或设置生成栅格地形缓存的线程数。
`void`	`setSampleSize(int size)` 设置地形瓦片预处理后生成的每个地形瓦片分块文件的采样尺寸，单位为像素。
`void`	`setStorageType(StorageType type)` 设置生成地形瓦片的存储类型，默认为紧凑模式。

从类继承的方法 com.supermap.data.InternalHandleDisposable
makeSureNativeObjectLive

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

- 构造器详细资料
  - CacheBuilderGridTerrain
```
public CacheBuilderGridTerrain()
```
    构造函数，构造一个新的CacheBuilderGridTerrain对象。
    
    从以下版本开始:
    
    10.1.0。
- 方法详细资料
  - addSteppedListener
```
public void addSteppedListener(SteppedListener l)
```
    添加一个进度条事件（SteppedEvent）的监听器。
    
    参数:
    
    l - 一个用于接收进度条事件的监听器。
    
    从以下版本开始:
    
    10.1.0。
  - removeSteppedListener
```
public void removeSteppedListener(SteppedListener l)
```
    移除一个进度条事件（SteppedEvent）的监听器。
    
    参数:
    
    l - 一个用于接收进度条事件的监听器。
    
    从以下版本开始:
    
    10.1.0。
  - dispose
```
public void dispose()
```
    释放占用资源。调用该方法之后，此对象不再可用。
    
    抛出:
    
    UnsupportedOperationException - 对象不能被释放，不能调用Dispose方法。
    
    从以下版本开始:
    
    10.1.0。
  - fromConfigFile
```
public boolean fromConfigFile(String configPath)
```
    导入地形瓦片配置文件，即根据配置文件中的内容来设置该地形瓦片对象。
    
    参数:
    
    configPath - 地形瓦片配置文件全路径。
    
    返回:
    
    一个布尔值，返回 true表示导入地形瓦片配置文件成功，返回 false则表示导入地形瓦片配置文件失败。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    10.1.0。
  - setBounds
```
public void setBounds(Rectangle2D bounds)
```
    设置生成地形瓦片的范围。
    
    参数:
    
    bounds - 生成地形瓦片的范围。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    10.1.0。
  - setDataset
```
public void setDataset(DatasetGrid dataset)
```
    设置生成地形瓦片的栅格数据集。
    
    参数:
    
    dataset - 生成地形瓦片的栅格数据集。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    10.1.0。
  - setOutputFolder
```
public void setOutputFolder(String path)
```
    设置生成地形瓦片的输出全路径。
    
    参数:
    
    path - 生成地形瓦片的输出全路径。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    10.1.0。
  - setCacheName
```
public void setCacheName(String name)
```
    设置生成地形瓦片的瓦片名称。
    
    参数:
    
    name - 生成地形瓦片的瓦片名称。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    10.1.0。
  - setBeginLevel
```
public void setBeginLevel(int level)
```
    设置生成地形瓦片的开始层数。
    
    参数:
    
    level - 生成地形瓦片的开始层数。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    10.1.0。
  - setEndLevel
```
public void setEndLevel(int level)
```
    设置生成地形瓦片的结束层数。
    
    参数:
    
    level - 生成地形瓦片的结束层数。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    10.1.0。
  - setSampleSize
```
public void setSampleSize(int size)
```
    设置地形瓦片预处理后生成的每个地形瓦片分块文件的采样尺寸，单位为像素。
    对于栅格数据来说，该属性值即为地形瓦片预处理后每个分块的图幅尺寸。
    
    参数:
    
    size - 每个地形瓦片分块文件的采样尺寸。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    10.1.0。
  - setStorageType
```
public void setStorageType(StorageType type)
```
    设置生成地形瓦片的存储类型，默认为紧凑模式。
    
    参数:
    
    type - 生成地形瓦片的存储类型。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    10.1.0。
  - combineTerrainConfigFile
```
public boolean combineTerrainConfigFile(String strOutConfigPathName,
                                        String[] arrInPathNames,
                                        boolean HasCacheFile)
```
    生成发布地形合并服务的配置文件，支持栅格地形发布配置文件时是否生成相交区域的预瓦片。
    合并栅格配置文件成功后。如果“HasCacheFile”为true，则在目标文件下生成相交区域的瓦片；如果“HasCacheFile”为false，则只生成合并后的配置文件。
    
    参数:
    
    strOutConfigPathName - 动态合并生成的配置文件全路径,包含配置文件。
    
    arrInPathNames - 进行动态合并的栅格地形瓦片集合，指定配置文件的全路径。根据栅格地形的精细程度，添加到列表时，更精细的先Add。
    
    HasCacheFile - 是否生成相交区域的瓦片。
    
    返回:
    
    合并栅格配置文件是否成功。返回true表示合并栅格配置文件成功；返回false表示合并栅格配置文件失败。
    
    抛出:
    
    IllegalStateException - 当前对象已被释放。
    
    从以下版本开始:
    
    10.1.0。
  - combineTerrainTiles
```
public byte[] combineTerrainTiles(GridTerrainCacheInfo info,
                                  int level,
                                  int row,
                                  int col)
```
    请求合并两个地形文件.
    
    参数:
    
    info - 栅格地形缓存信息，参数info中提供合并之后产生的sct文件路径，方法功能是合并sct中对应的多个sct文件所对应的tile文件。
    
    level - 指定层号
    
    row - 指定行号
    
    col - 指定列号
    
    返回:
    
    tile合并之后的数据。
  - setGridDataType
```
public void setGridDataType(GridDataType dataType)
```
    设置缓存栅格数据类型。包含全球剖分的地形、属性、坡度或坡向缓存。
    
    参数:
    
    dataType - 缓存栅格数据类型
  - getGridDataType
```
public GridDataType getGridDataType()
```
    获取缓存栅格数据类型。包含全球剖分的地形、属性、坡度或坡向缓存。
  - build
```
public boolean build()
```
    执行生成地形缓存。
  - getBounds
```
public Rectangle2D getBounds()
```
    获取生成地形缓存的范围，
  - getDataset
```
public DatasetGrid getDataset()
```
    获取数据集
  - getOutputFolder
```
public String getOutputFolder()
```
    获取输出的缓存文件的全路径。
  - getCacheName
```
public String getCacheName()
```
    获取生成缓存的名称。该名称对应SCT缓存配置文件的名称，不含后缀名以及路径信息。
  - getBeginLevel
```
public int getBeginLevel()
```
    获取开始生成缓存的层数。层是存放数据的根节点，每层存放了不同比例尺下的数据，开始的层数用来指定显示数据的最小分辨率。
  - getEndLevel
```
public int getEndLevel()
```
    获取或设置结束生成缓存的层数。层是存放数据的根节点，每层存放了不同比例尺下的数据，结束的层数用来指定显示数据的最高分辨率。
  - getSampleSize
```
public int getSampleSize()
```
    获取缓存预处理后生成的每个缓存分块文件的采样尺寸，单位为像素。对于栅格数据来说，该属性值即为缓存预处理后每个分块的图幅尺寸。
  - getStorageType
```
public StorageType getStorageType()
```
    获取缓存的存储方式，
    
    返回:
    
    默认为紧凑模式，即：StorageType.Compact。
  - getEncodeType
```
public EncodeType getEncodeType()
```
    获取地形缓存文件的编码类型。地形缓存文件支持的编码格式仅支持 EncodeType.LZW，EncodeType.None 两种，即对该属性设置其他类型的编码类型无效，采用默认的编码方式。
    
    返回:
    
    默认值为 EncodeType.None，即不使用编码方式。
  - setEncodeType
```
public void setEncodeType(EncodeType type)
```
    获取或设置地形缓存文件的编码类型。地形缓存文件支持的编码格式仅支持 EncodeType.LZW，EncodeType.None 两种，即对该属性设置其他类型的编码类型无效，采用默认的编码方式。
    
    参数:
    
    type - 数据集存储时的压缩编码方式类型。
  - computeLevel
```
public boolean computeLevel()
```
    计算设置数据集所正确的缓存级数，在非默认构造函数中会自动调用该方法，不过通过设置Dataset不会执行该方法。
  - getProcessThreadsCount
```
public int getProcessThreadsCount()
```
    获取生成栅格地形缓存的线程数。
  - setProcessThreadsCount
```
public void setProcessThreadsCount(int threadCount)
```
    获取或设置生成栅格地形缓存的线程数。
  - getBlockScale
```
public int getBlockScale()
```
    获取直接生成Block存储的缓存。
  - setBlockScale
```
public void setBlockScale(int blockScale)
```
    设置直接生成Block存储的缓存。
  - getDatasetMosaic
```
public DatasetMosaic getDatasetMosaic()
```
    获取镶嵌数据集
  - setDatasetMosaic
```
public void setDatasetMosaic(DatasetMosaic mosaicDataset)
```
    设置镶嵌数据集
  - openFile
```
public boolean openFile(String tifPath)
```
    打开TIF地形文件，支持TIF文件直接生成栅格地形缓存
  - generateConfigFile
```
public boolean generateConfigFile(String strFileName)
```
    生成缓存配置文件（目前仅支持镶嵌数据集生成栅格地形缓存）
  - getPassword
```
public String getPassword()
```
    获取大文件缓存密码
  - setPassword
```
public void setPassword(String password)
```
    设置大文件缓存密码
  - setIsDisposable
```
public static void setIsDisposable(com.supermap.data.InternalHandleDisposable obj,
                                   boolean disposable)
```

类 CacheBuilderGridTerrain

构造器概要

方法概要

从类继承的方法 com.supermap.data.InternalHandleDisposable

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

构造器详细资料

CacheBuilderGridTerrain

方法详细资料

addSteppedListener

removeSteppedListener

dispose

fromConfigFile

setBounds

setDataset

setOutputFolder

setCacheName

setBeginLevel

setEndLevel

setSampleSize

setStorageType

combineTerrainConfigFile

combineTerrainTiles

setGridDataType

getGridDataType

build

getBounds

getDataset

getOutputFolder

getCacheName

getBeginLevel

getEndLevel

getSampleSize

getStorageType

getEncodeType

setEncodeType

computeLevel

getProcessThreadsCount

setProcessThreadsCount

getBlockScale

setBlockScale

getDatasetMosaic

setDatasetMosaic

openFile

generateConfigFile

getPassword

setPassword

setIsDisposable