ImportSetting (iObjects Java Help)

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

所有已实现的接口:

IDisposable

直接已知子类:

ImportSettingAiBinGrid, ImportSettingBIL, ImportSettingBIP, ImportSettingBMP, ImportSettingBSQ, ImportSettingCoverage, ImportSettingCSV, ImportSettingDBF, ImportSettingDGN, ImportSettingDWG, ImportSettingDXF, ImportSettingE00, ImportSettingECW, ImportSettingEGC, ImportSettingFileGDBVector, ImportSettingGBDEM, ImportSettingGeo3DML, ImportSettingGeoJson, ImportSettingGIF, ImportSettingGJB, ImportSettingGJB9121, ImportSettingGML, ImportSettingGPKG, ImportSettingGRD, ImportSettingGRIB, ImportSettingHDF5, ImportSettingIMG, ImportSettingJP2, ImportSettingJPG, ImportSettingKML, ImportSettingKMZ, ImportSettingLIDAR, ImportSettingMAPGIS, ImportSettingMIF, ImportSettingModel3DS, ImportSettingModelDXF, ImportSettingModelFBX, ImportSettingModelFLT, ImportSettingModelOSG, ImportSettingModelX, ImportSettingMrSID, ImportSettingNetCDF, ImportSettingOrangeTab, ImportSettingOSM, ImportSettingPersonalGDBVector, ImportSettingPNG, ImportSettingRAW, ImportSettingSCV, ImportSettingSDEVector, ImportSettingSHP, ImportSettingSimpleJson, ImportSettingSIT, ImportSettingSKP, ImportSettingTAB, ImportSettingTEMSBuildingVector, ImportSettingTEMSClutter, ImportSettingTEMSTextLabels, ImportSettingTEMSVector, ImportSettingTIF, ImportSettingUSGSDEM, ImportSettingVCT, ImportSettingVRT, ImportSettingWOR
```
public abstract class ImportSetting
extends com.supermap.data.InternalHandleDisposable
```
导入设置信息类。该类是各类型导入设置的基类，提供导入设置的公共方法。

构造器概要

构造器
构造器和说明

ImportSetting()

构造器
构造器和说明
`ImportSetting()`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`boolean`	`fromXML(String xml)` 已过时。该方法已经过时。不再提供该功能。
`EncodeType`	`getEncodeType()` 已过时。该方法已经过时。使用 `ImportSetting.getTargetEncodeType()`替代。返回要生成的数据集的编码类型。
`ImportMode`	`getImportMode()` 返回当同名数据集存在时导入的模式。
`Charset`	`getSourceFileCharset()` 返回导入文件的原始字符集类型。
`String`	`getSourceFilePath()` 返回需要导入的数据路径信息。
`FileType`	`getSourceFileType()` 返回需要导入数据的类型。
`PrjCoordSys`	`getSourcePrjCoordSys()` 返回源数据的坐标系。
`ImportDataInfos`	`getTargetDataInfos(String targetNamePrefix)` 获取导入数据信息集合。
`ImportDataInfos`	`getTargetDataInfos(String targetNamePrefix, EncodeType targetEncodeType, PrjCoordSys targetPrjCoordSy)` 获取导入数据信息集合。
`String`	`getTargetDatasetName()` 返回目标数据集的文件名称。
`Datasource`	`getTargetDatasource()` 返回需要导入的数据源对象。
`DatasourceConnectionInfo`	`getTargetDatasourceConnectionInfo()` 返回需要导入的数据源连接信息。
`EncodeType`	`getTargetEncodeType()` 返回要生成的数据集的编码类型，默认值为源数据中的编码类型。
`PrjCoordSys`	`getTargetPrjCoordSys()` 返回导入后目标数据的坐标系。
`boolean`	`isUseFME()` 已过时。返回是否使用 FME 导入方式。
`void`	`setEnableMultiThread(boolean value)` 设置是否启用多线程。
`void`	`setEncodeType(EncodeType type)` 已过时。该方法已经过时。使用`setTargetEncodeType()`替代。设置要生成的数据集的编码类型。
`void`	`setFieldValue(String fieldName, Object value)` 设置指定字段名称的字段值
`void`	`setImportMode(ImportMode importMode)` 设置当同名数据集存在时导入的模式。
`void`	`setScalingFactor(double ratioX, double ratioY, double ratioZ)` 设置缩放因子。
`void`	`setSourceFileCharset(Charset charset)` 设置导入文件的原始字符集类型。
`void`	`setSourceFilePath(String path)` 设置需要导入的数据路径信息。
`void`	`setTargetDataInfos(ImportDataInfos targetDataInfos)` 设置导入目标数据集信息。
`void`	`setTargetDatasetName(String targetDatasetName)` 设置目标数据集的文件名称。
`void`	`setTargetDatasource(Datasource datasource)` 设置需要导入的数据源对象。
`void`	`setTargetDatasourceConnectionInfo(DatasourceConnectionInfo connectionInfo)` 设置需要导入的数据源连接信息。
`void`	`setTargetEncodeType(EncodeType type)` 设置要生成的数据集的编码类型。
`void`	`setTargetPrjCoordSys(PrjCoordSys prjCoordSys)` 设置导入后目标数据的坐标系。
`void`	`setUseFME(boolean value)` 已过时。设置是否使用 FME 导入方式。设置为 true，表示使用 FME 导入方式，此时需要 FME 许可，并且只支持 FME 所支持的文件类型的导入。设置为 false 时，表示以非 FME 方式导入，无需 FME 许可，只支持非 FME 方式所支持的文件类型的导入。
`String`	`toXML()` 已过时。该方法已经过时。不再提供该功能。

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

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

从接口继承的方法 com.supermap.data.IDisposable
dispose

- 构造器详细资料
  - ImportSetting
```
public ImportSetting()
```
- 方法详细资料
  - getSourceFilePath
```
public String getSourceFilePath()
```
    返回需要导入的数据路径信息。
    
    返回:
    
    需要导入的数据路径信息。
  - setSourceFilePath
```
public void setSourceFilePath(String path)
```
    设置需要导入的数据路径信息。
    
    参数:
    
    path - 需要导入的数据路径信息。
  - getTargetDatasetName
```
public String getTargetDatasetName()
```
    返回目标数据集的文件名称。
    注意：对于可导入为 CAD 数据集的数据格式
    
    若 setImportingAsCAD 设置为 false，即导入为数据对应类型的简单数据集，则仅返回数据集的文件名称前缀，而不包括图层名称。
    
    例如：导入后目标数据集的文件名称为 DatasetName_p，则返回结果为 DatasetName。
    
    返回:
    
    目标数据集的文件名称。
  - setTargetDatasetName
```
public void setTargetDatasetName(String targetDatasetName)
```
    设置目标数据集的文件名称。
    注意：
    
    1.导入MapInfo 工作空间文件的数据格式时，调用该方法设置目标数据集的文件名称无效，即通过 ImportSettingWOR.setTargetDatasetName() 方法设置目标数据集文件名称不起作用。
    2.对于可导入为 CAD 数据集的数据格式，若 setImportingAsCAD 设置为 false，即导入为数据对应类型的简单数据集，则仅设置数据集的文件名称前缀，而不包括图层名称。例如：导入后目标数据集的文件名称为 oldName_p，设置新名称为 newName，则设置后结果为 newName_p。
    
    参数:
    
    targetDatasetName - 目标数据集的文件名称。
  - getSourceFileType
```
public FileType getSourceFileType()
```
    返回需要导入数据的类型。
    该返回值与实例所属的类型相对应。比如实例化的是 ImportSettingBMP，则该返回值为 FileType.BMP。
    
    返回:
    
    需要导入数据的类型。
    
    默认值:
    
    FileType.NONE。
  - getTargetDatasourceConnectionInfo
```
public DatasourceConnectionInfo getTargetDatasourceConnectionInfo()
```
    返回需要导入的数据源连接信息。
    如果没有对应的数据源，则根据连接信息新建。这样可以支持内存数据源和数据库型数据源。
    
    返回:
    
    回需要导入的数据源连接信息。
  - setTargetDatasourceConnectionInfo
```
public void setTargetDatasourceConnectionInfo(DatasourceConnectionInfo connectionInfo)
```
    设置需要导入的数据源连接信息。
    如果没有对应的数据源，则根据连接信息新建。这样可以支持内存数据源和数据库型数据源。
    
    参数:
    
    connectionInfo - 需要导入的数据源连接信息。
  - getTargetDatasource
```
public Datasource getTargetDatasource()
```
    返回需要导入的数据源对象。
    
    返回:
    
    需要导入的数据源对象。
  - setTargetDatasource
```
public void setTargetDatasource(Datasource datasource)
```
    设置需要导入的数据源对象。
    setTargetDatasource() 与 setTargetDatasourceConnectionInfo() 两个方法相互冲突，即对其中一个方法进行设置后，之前另一方法的设置值将被修改为 null。
    
    参数:
    
    datasource - 需要导入的数据源对象。
  - getTargetEncodeType
```
public EncodeType getTargetEncodeType()
```
    返回要生成的数据集的编码类型，默认值为源数据中的编码类型。
    
    返回:
    
    要生成的数据集的编码类型。
    
    默认值:
    
    默认值为源数据中的编码类型。
  - getEncodeType
```
@Deprecated
public EncodeType getEncodeType()
```
    已过时。该方法已经过时。使用 ImportSetting.getTargetEncodeType()替代。返回要生成的数据集的编码类型。
    
    返回:
    
    数据集的编码类型。
  - setEncodeType
```
@Deprecated
public void setEncodeType(EncodeType type)
```
    已过时。该方法已经过时。使用setTargetEncodeType()替代。设置要生成的数据集的编码类型。
    
    参数:
    
    type - 数据集的编码类型。
  - getSourceFileCharset
```
public Charset getSourceFileCharset()
```
    返回导入文件的原始字符集类型。SuperMap Objects Java 6R(2012) SP2 版本不支持该方法，预留后续版本使用。
    
    返回:
    
    返回导入文件的原始字符集类型。
  - setSourceFileCharset
```
public void setSourceFileCharset(Charset charset)
```
    设置导入文件的原始字符集类型。SuperMap Objects Java 6R(2012) SP2 版本不支持该方法，预留后续版本使用。
    如，一份中文的 MapInfo MIF 数据，需要在英文系统上导入时，需要把通过该方法将导入文件的字符集类型设置为 GB18030，目标结果可以根据你的需要，把将导入结果数据集的字符集设置成 UTF8 或者 GB18030。
    
    参数:
    
    charset - 导入文件的原始字符集类型。
  - setTargetEncodeType
```
public void setTargetEncodeType(EncodeType type)
```
    设置要生成的数据集的编码类型。
    
    参数:
    
    type - 要生成的数据集的编码类型。
  - getTargetPrjCoordSys
```
public PrjCoordSys getTargetPrjCoordSys()
```
    返回导入后目标数据的坐标系。
    
    返回:
    
    导入后目标数据的坐标系。
  - setTargetPrjCoordSys
```
public void setTargetPrjCoordSys(PrjCoordSys prjCoordSys)
```
    设置导入后目标数据的坐标系。
    
    参数:
    
    prjCoordSys - 导入后目标数据的坐标系。
  - getImportMode
```
public ImportMode getImportMode()
```
    返回当同名数据集存在时导入的模式。
    
    返回:
    
    当同名数据集存在时导入的模式。
    
    默认值:
    
    ImportMode.NONE。
  - setImportMode
```
public void setImportMode(ImportMode importMode)
```
    设置当同名数据集存在时导入的模式。
    
    参数:
    
    importMode - 当同名数据集存在时导入的模式。
  - setEnableMultiThread
```
public void setEnableMultiThread(boolean value)
```
    设置是否启用多线程。
    如果启用多线程，需要保证: 1、文件型数据库不能为同一个数据源； 2、用户使用的DataImport不能是同一个（每个线程对应一个DataImport） 3、目前仅支持CSV和SHP。
    
    参数:
    
    value - 是否启用多线程
  - toXML
```
@Deprecated
public String toXML()
```
    已过时。该方法已经过时。不再提供该功能。
    
    导出当前的设置为 XML 文件，用于保存导入的参数设置,方便用户持久化。
    
    返回:
    
    XML 文件。
  - fromXML
```
@Deprecated
public boolean fromXML(String xml)
```
    已过时。该方法已经过时。不再提供该功能。
    
    从外部的 XML 流中读取相应的设置，方便多次转换。
    
    参数:
    
    xml - 需要导入的 XML 内容。
    
    返回:
    
    一个布尔值，成功返回 true，否则返回 false。
  - getTargetDataInfos
```
public ImportDataInfos getTargetDataInfos(String targetNamePrefix)
```
    获取导入数据信息集合。
    如果导入参数中设置导入为单个数据集(如导入为 CAD 数据集)，则此数组长度为 1；如果导入参数中设置导入为简单数据集或多个多波段数据集等，则此数组长度不为 1。
    
    参数:
    
    targetNamePrefix - 导入数据集名称的前缀，如果是 null 和空字符串将不加前缀。
    
    返回:
    
    导入数据信息集合。
  - getTargetDataInfos
```
public ImportDataInfos getTargetDataInfos(String targetNamePrefix,
                                          EncodeType targetEncodeType,
                                          PrjCoordSys targetPrjCoordSy)
```
    获取导入数据信息集合。
    集合中的各目标数据集的名称前缀、编码类型、坐标系由传入的参数统一赋值。
    
    参数:
    
    targetNamePrefix - 导入数据集名称的前缀，如果是 null 和空字符串将不加前缀。
    
    targetEncodeType - 导入数据集的编码类型。
    
    targetPrjCoordSy - 导入数据集的坐标系。
    
    返回:
    
    导入数据信息集合。
  - setTargetDataInfos
```
public void setTargetDataInfos(ImportDataInfos targetDataInfos)
```
    设置导入目标数据集信息。
    使用该方法前，需先调用 getTargetDataInfos(String) 或者 getTargetDataInfos(String, EncodeType, PrjCoordSys) 方法，获取导入目标数据集信息。
    
    若不调用此 ImportSetting.setTargetDataInfos(ImportDataInfos) 方法，则使用默认信息导入。
    
    此外，如果 targetDataInfos 中子项都被设置为排除（不导入），则这些子项也按默认信息导入。
    
    参数:
    
    targetDataInfos - 导入目标数据集信息。
  - setScalingFactor
```
public void setScalingFactor(double ratioX,
                             double ratioY,
                             double ratioZ)
```
    设置缩放因子。
    设置缩放因子后，导入结果中的所有对象都会乘以相应的缩放比，一般适用于单位转换，比如毫米转为米，缩放比为0.001。
    
    参数:
    
    ratioX - X缩放比因子。
    
    ratioY - Y缩放比因子。
    
    ratioZ - Z缩放比因子。
  - setFieldValue
```
public void setFieldValue(String fieldName,
                          Object value)
```
    设置指定字段名称的字段值
    
    参数:
    
    fieldName - 指定的字段名称。
    
    value - 字段值。
  - getSourcePrjCoordSys
```
public PrjCoordSys getSourcePrjCoordSys()
```
    返回源数据的坐标系。
    目前只有 TIF、SIT、IMG、SHP、MIF、TAB 格式支持坐标,其他的返回 null。
    
    返回:
    
    源数据的坐标系。
  - isUseFME
```
public boolean isUseFME()
```
    已过时。返回是否使用 FME 导入方式。
    
    返回:
    
    一个布尔值，是否使用 FME 导入方式。
    
    默认值:
    
    默认值为 false，不使用 FME 导入方式。
  - setUseFME
```
@Deprecated
public void setUseFME(boolean value)
```
    已过时。设置是否使用 FME 导入方式。
    设置为 true，表示使用 FME 导入方式，此时需要 FME 许可，并且只支持 FME 所支持的文件类型的导入。
    
    设置为 false 时，表示以非 FME 方式导入，无需 FME 许可，只支持非 FME 方式所支持的文件类型的导入。
    
    参数:
    
    value - 一个布尔值，是否使用 FME 导入方式。

类 ImportSetting

构造器概要

方法概要

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

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

从接口继承的方法 com.supermap.data.IDisposable

构造器详细资料

ImportSetting

方法详细资料

getSourceFilePath

setSourceFilePath

getTargetDatasetName

setTargetDatasetName

getSourceFileType

getTargetDatasourceConnectionInfo

setTargetDatasourceConnectionInfo

getTargetDatasource

setTargetDatasource

getTargetEncodeType

getEncodeType

setEncodeType

getSourceFileCharset

setSourceFileCharset

setTargetEncodeType

getTargetPrjCoordSys

setTargetPrjCoordSys

getImportMode

setImportMode

setEnableMultiThread

toXML

fromXML

getTargetDataInfos

getTargetDataInfos

setTargetDataInfos

setScalingFactor

setFieldValue

getSourcePrjCoordSys

isUseFME

setUseFME