DatasetGridInfo (iObjects Java Help)

java.lang.Object
- com.supermap.data.InternalHandle
- - com.supermap.data.InternalHandleDisposable
  - - com.supermap.data.DatasetGridInfo

所有已实现的接口:: IDisposable

public class DatasetGridInfo
extends com.supermap.data.InternalHandleDisposable

栅格数据集信息类。

该类包括了返回和设置栅格数据集的相应的设置信息等，例如栅格数据集的名称、宽度、高度、像素格式、编码方式、存储分块大小和空值等。

示范代码:

以下代码示范如何根据给定的栅格数据集信息，创建栅格数据集。

 public void datasetGridInfoTest() {
        // 假设打开一个工作空间 workspace 对象，工作空间中存在一个数据源 datasource 对象
        // 创建一个栅格数据集信息对象，对其进行必要的设置
        DatasetGridInfo datasetGridInfo = new DatasetGridInfo();
        datasetGridInfo.setName("栅格数据集信息");
        datasetGridInfo.setBlockSizeOption(BlockSizeOption.BS_128);
        datasetGridInfo.setHeight(200);
        datasetGridInfo.setWidth(200);
        datasetGridInfo.setNoValue(1.0);
        datasetGridInfo.setPixelFormat(PixelFormat.SINGLE);
        datasetGridInfo.setEncodeType(EncodeType.LZW);

        // 通过栅格数据集信息创建栅格数据集
        DatasetGrid datasetGrid = datasource.getDatasets().create(
                datasetGridInfo);
        if (datasetGrid != null) {
            System.out.println(datasetGrid.getName() + "创建成功！");
        }
    }

构造器概要

构造器
构造器和说明
`DatasetGridInfo()` 构造一个新的 DatasetGridInfo 对象。
`DatasetGridInfo(DatasetGridInfo datasetGridInfo)` 根据给定的 DatasetGridInfo 对象构造一个与其完全相同的新对象。
`DatasetGridInfo(String name, DatasetGrid templateDataset)` 鏍规嵁鎸囧畾鐨勫悕绉板強妯℃澘鏁版嵁闆嗘瀯寤轰竴涓柊鐨勫璞°�鍗抽櫎浜嗗悕绉板锛屽叾浠栧睘鎬т笌妯℃澘鏁版嵁闆嗙浉鍚� /** 根据指定的参数来构造一个 DatasetGridInfo 的新对象。
`DatasetGridInfo(String name, int width, int height, PixelFormat pixelFormat, EncodeType encodeType)` 根据指定的参数来构造一个 DatasetGridInfo 的新对象。
`DatasetGridInfo(String name, int width, int height, PixelFormat pixelFormat, EncodeType encodeType, BlockSizeOption option)` 根据指定的参数来构造一个 DatasetGridInfo 的新对象。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`dispose()` 释放该对象所占用的资源。
`BlockSizeOption`	`getBlockSizeOption()` 设置栅格数据集的像素分块。
`Rectangle2D`	`getBounds()` 返回栅格数据集的地理范围。
`double`	`getCommendNoValue()` 获取栅格的推荐无值。
`EncodeType`	`getEncodeType()` 返回栅格数据集数据存储时的编码方式。
`int`	`getHeight()` 返回栅格数据集的栅格数据的高度。
`double`	`getMaxValue()` 返回栅格数据集栅格行列中的最大值。
`double`	`getMinValue()` 返回栅格数据集栅格行列中的最小值。
`String`	`getName()` 返回栅格数据集信息类的名称。
`double`	`getNoValue()` 返回栅格数据集的空值，当此数据集为空值时，用户可采用-9999来表示。
`PixelFormat`	`getPixelFormat()` 返回栅格数据存储的像素格式。
`int`	`getWidth()` 返回栅格数据集的栅格数据的宽度。
`void`	`setBlockSizeOption(BlockSizeOption option)` 返回栅格数据集的像素分块。
`void`	`setBounds(Rectangle2D value)` 设置栅格数据集的地理范围。
`void`	`setEncodeType(EncodeType encodeType)` 设置格栅格数据集数据存储时的编码方式。
`void`	`setHeight(int value)` 设置栅格数据集的栅格数据的高度。
`void`	`setMaxValue(double value)` 设置栅格数据集栅格行列中的最大值。
`void`	`setMinValue(double value)` 设置栅格数据集栅格行列中的最小值。
`void`	`setName(String value)` 设置栅格数据集信息类的名称。
`void`	`setNoValue(double value)` 设置栅格数据集的空值，当此数据集为空值时，用户可采用-9999来表示。
`void`	`setPixelFormat(PixelFormat value)` 设置栅格数据存储的像素格式。
`void`	`setWidth(int value)` 设置栅格数据集的栅格数据的宽度。
`String`	`toString()` 返回一个表示此栅格数据集信息类的格式化字符串。

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

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

- 构造器详细资料
  - DatasetGridInfo
```
public DatasetGridInfo()
```
    构造一个新的 DatasetGridInfo 对象。
  - DatasetGridInfo
```
public DatasetGridInfo(DatasetGridInfo datasetGridInfo)
```
    根据给定的 DatasetGridInfo 对象构造一个与其完全相同的新对象。
    
    参数:
    
    datasetGridInfo - 用于构造栅格数据集信息新实例的对象。
  - DatasetGridInfo
```
public DatasetGridInfo(String name,
                       int width,
                       int height,
                       PixelFormat pixelFormat,
                       EncodeType encodeType)
```
    根据指定的参数来构造一个 DatasetGridInfo 的新对象。
    
    参数:
    
    name - 栅格数据集的名称。
    
    width - 栅格数据集的宽度。单位为像素。
    
    height - 栅格数据集的高度。单位为像素。
    
    pixelFormat - 栅格数据集的存储的像素格式。
    
    encodeType - 栅格数据集的存储时的编码方式。
  - DatasetGridInfo
```
public DatasetGridInfo(String name,
                       int width,
                       int height,
                       PixelFormat pixelFormat,
                       EncodeType encodeType,
                       BlockSizeOption option)
```
    根据指定的参数来构造一个 DatasetGridInfo 的新对象。
    
    参数:
    
    name - 栅格数据集的名称。
    
    width - 栅格数据集的宽度。单位为像素。
    
    height - 栅格数据集的高度。单位为像素。
    
    pixelFormat - 栅格数据集的存储的像素格式。
    
    encodeType - 栅格数据集的存储时的编码方式。
    
    option - 栅格数据集的像素分块。
  - DatasetGridInfo
```
public DatasetGridInfo(String name,
                       DatasetGrid templateDataset)
```
    鏍规嵁鎸囧畾鐨勫悕绉板強妯℃澘鏁版嵁闆嗘瀯寤轰竴涓柊鐨勫璞°�鍗抽櫎浜嗗悕绉板锛屽叾浠栧睘鎬т笌妯℃澘鏁版嵁闆嗙浉鍚� /** 根据指定的参数来构造一个 DatasetGridInfo 的新对象。
    
    参数:
    
    name - 指定的名称
    
    templateDataset - 指定的模板数据集。
- 方法详细资料
  - getName
```
public String getName()
```
    返回栅格数据集信息类的名称。
    
    返回:
    
    栅格数据集信息类的名称。
    
    默认值:
    
    默认值为 "UntitledDatasetGrid"。
  - setName
```
public void setName(String value)
```
    设置栅格数据集信息类的名称。
    
    参数:
    
    value - 栅格数据集信息类的名称。
  - getBounds
```
public Rectangle2D getBounds()
```
    返回栅格数据集的地理范围。
    
    返回:
    
    栅格数据集的地理范围。
    
    默认值:
    
    栅格数据集的地理范围即矩形的范围，默认值为(0,0,255,255)，分别为矩形的左边界 X 坐标值、下边界 Y 坐标值、右边界 X 坐标值和上边界 Y 坐标值。
  - setBounds
```
public void setBounds(Rectangle2D value)
```
    设置栅格数据集的地理范围。
    
    参数:
    
    value - 栅格数据集的地理范围。
  - getWidth
```
public int getWidth()
```
    返回栅格数据集的栅格数据的宽度。单位为像素。
    
    返回:
    
    栅格数据集的栅格数据的宽度。
    
    默认值:
    
    默认值为 256 像素。
  - setWidth
```
public void setWidth(int value)
```
    设置栅格数据集的栅格数据的宽度。单位为像素。
    
    参数:
    
    value - 栅格数据集的栅格数据的宽度。
  - getHeight
```
public int getHeight()
```
    返回栅格数据集的栅格数据的高度。单位为像素。
    
    返回:
    
    栅格数据集的栅格数据的高度。
    
    默认值:
    
    默认值为 256 像素。
  - setHeight
```
public void setHeight(int value)
```
    设置栅格数据集的栅格数据的高度。单位为像素。
    
    参数:
    
    value - 栅格数据集的栅格数据的高度。
  - getPixelFormat
```
public PixelFormat getPixelFormat()
```
    返回栅格数据存储的像素格式。每个象素采用不同的字节进行表示，单位是比特（bit）。详细信息请参考 PixelFormat 枚举类。
    DatasetGridInfo 目前不支持 BIT32,BIT64 三种像素格式。
    
    返回:
    
    栅格数据存储的像素格式。
    
    另请参阅:
    
    PixelFormat
    
    默认值:
    
    默认值为 DOUBLE 类型。
  - setPixelFormat
```
public void setPixelFormat(PixelFormat value)
```
    设置栅格数据存储的像素格式。每个象素采用不同的字节进行表示，单位是比特（bit）。详细信息请参考 PixelFormat 枚举类。
    DatasetGridInfo 目前不支持 BIT32,BIT64 三种像素格式。
    
    参数:
    
    value - 栅格数据存储的像素格式。
    
    另请参阅:
    
    PixelFormat
  - getBlockSizeOption
```
public BlockSizeOption getBlockSizeOption()
```
    设置栅格数据集的像素分块。以正方形方式进行分块存储，如下图所示按照4*4像素进行分块，将栅格数据分为3行*3列的矩阵。其中在进行分块过程中，如果栅格数据不足以进行完整地分块，那么采用空格补充完整进行存储。
    
    返回:
    
    栅格数据集的像素分块。
    
    默认值:
    
    默认值为 BlockSizeOption.BS_256。
  - setBlockSizeOption
```
public void setBlockSizeOption(BlockSizeOption option)
```
    返回栅格数据集的像素分块。
    
    参数:
    
    option - 栅格数据集的像素分块。
  - getEncodeType
```
public EncodeType getEncodeType()
```
    返回栅格数据集数据存储时的编码方式。对数据集采用压缩编码方式，可以减少数据存储所占用的空间，降低数据传输时的网络负载和服务器的负载。矢量数据集支持的编码方式有 Byte，Int16，Int24，Int32，SGL，LZW，DCT，也可以指定为不使用编码方式。光栅数据支持的编码方式有 DCT，SGL，LZW 或不使用编码方式。具体请参见 EncodeType 类型。
    注意：对于某些编码方式，系统有可能会将其改变为更适合该数据集存储时的编码方式。
    
    返回:
    
    栅格数据集数据存储时的编码方式。
    
    另请参阅:
    
    EncodeType
    
    默认值:
    
    默认值为 NONE 类型。
  - setEncodeType
```
public void setEncodeType(EncodeType encodeType)
```
    设置格栅格数据集数据存储时的编码方式。对数据集采用压缩编码方式，可以减少数据存储所占用的空间，降低数据传输时的网络负载和服务器的负载。矢量数据集支持的编码方式有 Byte，Int16，Int24，Int32，SGL，LZW，DCT，也可以指定为不使用编码方式。光栅数据支持的编码方式有 DCT，SGL，LZW 或不使用编码方式。具体请参见 EncodeType 类型。
    注意：对于某些编码方式，系统有可能会将其改变为更适合该数据集存储时的编码方式。
    
    参数:
    
    encodeType - 栅格数据集数据存储时的编码方式。
    
    另请参阅:
    
    EncodeType
  - getNoValue
```
public double getNoValue()
```
    返回栅格数据集的空值，当此数据集为空值时，用户可采用-9999来表示。
    
    返回:
    
    栅格数据集的空值。
    
    默认值:
    
    默认值为 -9999。
  - setNoValue
```
public void setNoValue(double value)
```
    设置栅格数据集的空值，当此数据集为空值时，用户可采用-9999来表示。
    
    参数:
    
    value - 栅格数据集的空值。
  - getMinValue
```
public double getMinValue()
```
    返回栅格数据集栅格行列中的最小值。
    
    返回:
    
    栅格数据集栅格行列中的最小值。
    
    默认值:
    
    默认值为 0。
  - setMinValue
```
public void setMinValue(double value)
```
    设置栅格数据集栅格行列中的最小值。
    
    参数:
    
    value - 栅格数据集栅格行列中的最小值。
  - getMaxValue
```
public double getMaxValue()
```
    返回栅格数据集栅格行列中的最大值。
    
    返回:
    
    栅格数据集栅格行列中的最大值。
    
    默认值:
    
    默认值为 0。
  - setMaxValue
```
public void setMaxValue(double value)
```
    设置栅格数据集栅格行列中的最大值。
    
    参数:
    
    value - 栅格数据集栅格行列中的最大值。
  - toString
```
public String toString()
```
    返回一个表示此栅格数据集信息类的格式化字符串。该字符串格式为{Name=””,Bounds={},Width=,Height=,PixelFormat=,BlockSize=,EncodeType=,NoValue=,MinValue=,MaxValue=}。
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    一个表示此栅格数据集信息类的格式化字符串。
  - dispose
```
public void dispose()
```
    释放该对象所占用的资源。当调用该方法之后，此对象不再可用。
  - getCommendNoValue
```
public double getCommendNoValue()
```
    获取栅格的推荐无值。
    
    返回:
    
    根据像素格式推荐一个无值。

类 DatasetGridInfo

构造器概要

方法概要

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

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

构造器详细资料

DatasetGridInfo

DatasetGridInfo

DatasetGridInfo

DatasetGridInfo

DatasetGridInfo

方法详细资料

getName

setName

getBounds

setBounds

getWidth

setWidth

getHeight

setHeight

getPixelFormat

setPixelFormat

getBlockSizeOption

setBlockSizeOption

getEncodeType

setEncodeType

getNoValue

setNoValue

getMinValue

setMinValue

getMaxValue

setMaxValue

toString

dispose

getCommendNoValue