ImportSettingBMP (iObjects Java Help)

java.lang.Object
- com.supermap.data.InternalHandle
- - com.supermap.data.InternalHandleDisposable
  - - com.supermap.data.conversion.ImportSetting
    - - com.supermap.data.conversion.ImportSettingBMP

所有已实现的接口:

IDisposable
```
public class ImportSettingBMP
extends ImportSetting
```
BMP 文件导入的参数类型。继承于 ImportSetting 类。
该类型仅在 Windows 平台版本中支持，在 Linux版本中不提供。

注意：
(1) 传入的文件型的数据源和工作空间连接信息，在传入之前不能被打开，否则会导入失败。

(2) 1位或4位的bmp影像，导入后会变成8位的bmp影像。

构造器概要

构造器
构造器和说明
`ImportSettingBMP()` 默认构造函数，构造一个新的 ImportSettingBMP 对象。
`ImportSettingBMP(ImportSettingBMP importSettingBMP)` 拷贝构造函数，根据给定的 ImportSettingBMP 对象构造一个与其完全相同的新对象。
`ImportSettingBMP(String sourceFilePath, Datasource targetDatasource)` 根据指定的参数构造 ImportSettingBMP 类的新实例。
`ImportSettingBMP(String sourceFilePath, DatasourceConnectionInfo targetConnectionInfo)` 根据指定的参数构造 ImportSettingBMP 类的新实例。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`dispose()` 释放该对象所占用的资源。
`IgnoreMode`	`getIgnoreMode()` 返回 BMP 文件的忽略颜色值的模式。
`double[]`	`getIgnoreValues()` 返回要忽略的颜色值。
`MultiBandImportMode`	`getMultiBandImportMode()` 返回多波段导入模式，可以导入为多个单波段数据集、单个多波段数据集或单个单波段数据集。
`String`	`getWorldFilePath()` 返回影像文件的坐标参考文件（WorldFile）的路径。
`boolean`	`isImportingAsGrid()` 返回是否导入为 `Grid` 数据集。
`boolean`	`isPyramidBuilt()` 返回是否自动建立影像金字塔。
`void`	`setIgnoreMode(IgnoreMode ignoreMode)` 设置 BMP 文件的忽略颜色值的模式。
`void`	`setIgnoreValues(double[] ignoreValues)` 设置要忽略的颜色值。
`void`	`setImportingAsGrid(boolean value)` 设置是否导入为 `Grid` 数据集。
`void`	`setMultiBandImportMode(MultiBandImportMode mode)` 设置多波段导入模式，可以导入为多个单波段数据集、单个多波段数据集或单个单波段数据集。
`void`	`setPyramidBuilt(boolean value)` 设置是否自动建立影像金字塔。
`void`	`setWorldFilePath(String value)` 设置影像文件的坐标参考文件（WorldFile）的路径。

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

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

- 构造器详细资料
  - ImportSettingBMP
```
public ImportSettingBMP()
```
    默认构造函数，构造一个新的 ImportSettingBMP 对象。
  - ImportSettingBMP
```
public ImportSettingBMP(ImportSettingBMP importSettingBMP)
```
    拷贝构造函数，根据给定的 ImportSettingBMP 对象构造一个与其完全相同的新对象。
    
    参数:
    
    importSettingBMP - 用于初始化 ImportSettingBMP 新实例的对象。
  - ImportSettingBMP
```
public ImportSettingBMP(String sourceFilePath,
                        DatasourceConnectionInfo targetConnectionInfo)
```
    根据指定的参数构造 ImportSettingBMP 类的新实例。
    
    参数:
    
    sourceFilePath - 指定的导入 BMP 格式数据的源文件路径。
    
    targetConnectionInfo - 指定的导入到目标数据源的连接信息对象。
  - ImportSettingBMP
```
public ImportSettingBMP(String sourceFilePath,
                        Datasource targetDatasource)
```
    根据指定的参数构造 ImportSettingBMP 类的新实例。
    
    参数:
    
    sourceFilePath - 指定的被导入的 BMP 格式数据的源文件的路径。
    
    targetDatasource - 指定的导入的目标数据源对象。
- 方法详细资料
  - isImportingAsGrid
```
public boolean isImportingAsGrid()
```
    返回是否导入为 Grid 数据集。
    
    返回:
    
    一个布尔值，表示是否导入为 Grid 数据集。导入为 Grid 数据集返回 true，否则返回 false。
    
    默认值:
    
    默认值为 false，即按源数据集类型导入数据集。
  - setImportingAsGrid
```
public void setImportingAsGrid(boolean value)
```
    设置是否导入为 Grid 数据集。
    注意：在具有 FME 许可时
    
    当设置为 true 时，由于栅格数据集不支持单个多波段数据集，若导入参数 setMultiBandImportMode 设置为 MULTIBAND ，则在数据导入时会将 MultiBandImportMode 自动修改为 SINGLEBAND。
    
    参数:
    
    value - 一个布尔值，表示是否导入为 Grid 数据集。true 表示导入为 Grid 数据集，false 表示按源数据集类型导入。
  - isPyramidBuilt
```
public boolean isPyramidBuilt()
```
    返回是否自动建立影像金字塔。默认为 false，表示默认情况下不对影像数据建立影像金字塔。
    
    返回:
    
    一个布尔值，自动建立影像金字塔返回 true，否则返回 false。
    
    默认值:
    
    默认值为 false。
  - setPyramidBuilt
```
public void setPyramidBuilt(boolean value)
```
    设置是否自动建立影像金字塔。默认为 false，表示默认情况下不对影像数据建立影像金字塔。
    
    参数:
    
    value - 是否自动建立影像金字塔。
  - getWorldFilePath
```
public String getWorldFilePath()
```
    返回影像文件的坐标参考文件（WorldFile）的路径。
    
    返回:
    
    影像文件的坐标参考文件（WorldFile）的路径。
  - getMultiBandImportMode
```
public MultiBandImportMode getMultiBandImportMode()
```
    返回多波段导入模式，可以导入为多个单波段数据集、单个多波段数据集或单个单波段数据集。
    注意：
    
    该接口仅在具有 FME 许可时有效，无 FME 许可时均默认以COMPOSITE模式导入。
    
    返回:
    
    多波段导入模式，可参见MultiBandImportMode。
    
    默认值:
    
    默认值为 COMPOSITE。
  - setMultiBandImportMode
```
public void setMultiBandImportMode(MultiBandImportMode mode)
```
    设置多波段导入模式，可以导入为多个单波段数据集、单个多波段数据集或单个单波段数据集。
    注意：
    
    该接口仅在具有 FME 许可时有效，无 FME 许可时均默认以COMPOSITE模式导入。
    
    参数:
    
    multiBandImportMode - 多波段导入模式，可参见MultiBandImportMode。
  - setWorldFilePath
```
public void setWorldFilePath(String value)
```
    设置影像文件的坐标参考文件（WorldFile）的路径。
    
    参数:
    
    string - 影像文件的坐标参考文件（WorldFile）的路径。
  - setIgnoreMode
```
public void setIgnoreMode(IgnoreMode ignoreMode)
```
    设置 BMP 文件的忽略颜色值的模式。
    
    参数:
    
    ignoreMode - 忽略颜色值的模式。
  - getIgnoreMode
```
public IgnoreMode getIgnoreMode()
```
    返回 BMP 文件的忽略颜色值的模式。
    
    返回:
    
    BMP 文件的忽略颜色值的模式。
  - getIgnoreValues
```
public double[] getIgnoreValues()
```
    返回要忽略的颜色值。
    
    返回:
    
    一个颜色值数组对象，数组中的值对应的颜色会被忽略。
  - setIgnoreValues
```
public void setIgnoreValues(double[] ignoreValues)
```
    设置要忽略的颜色值。
    
    参数:
    
    ignoreValues - 一个颜色值数组对象。
  - dispose
```
public void dispose()
```
    释放该对象所占用的资源。当调用该方法之后，此对象不再可用。

类 ImportSettingBMP

构造器概要

方法概要

从类继承的方法 com.supermap.data.conversion.ImportSetting

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

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

构造器详细资料

ImportSettingBMP

ImportSettingBMP

ImportSettingBMP

ImportSettingBMP

方法详细资料

isImportingAsGrid

setImportingAsGrid

isPyramidBuilt

setPyramidBuilt

getWorldFilePath

getMultiBandImportMode

setMultiBandImportMode

setWorldFilePath

setIgnoreMode

getIgnoreMode

getIgnoreValues

setIgnoreValues

dispose