ExportSetting (iObjects Java Help)

java.lang.Object
- com.supermap.data.conversion.ExportSetting

直接已知子类:

ExportSettingBMP, ExportSettingCSV, ExportSettingDWG, ExportSettingDXF, ExportSettingE00, ExportSettingEGC, ExportSettingFileGDBVector, ExportSettingGeoJson, ExportSettingGIF, ExportSettingGJB, ExportSettingGJB9121, ExportSettingJPG, ExportSettingKML, ExportSettingKMZ, ExportSettingModelX, ExportSettingNetCDF, ExportSettingPersonalGDBVector, ExportSettingPNG, ExportSettingSHP, ExportSettingSimpleJson, ExportSettingSIT, ExportSettingTAB, ExportSettingTEMSBuildingVector, ExportSettingTEMSClutter, ExportSettingTEMSTextLabels, ExportSettingTEMSVector, ExportSettingTIF, ExportSettingVCT
```
public class ExportSetting
extends Object
```
导出设置信息类。
该类是导出设置信息类集合（ExportSettings）对象的子项。通过该类提供的方法可以得到导出数据的设置信息。

忽略字段说明（相关接口 getIgnoreFieldNames、setIgnoreFieldNames）
- DBF格式
  1. 全部用户字段都忽略的时候导出失败。
- SHP格式
  1. 全部用户字段都忽略的时候，由于shp格式中的dbf必须有一个用户字段，和arcgis保持一致，导出时系统自动添加默认字段“Id”，值都为默认值0，SuperMap内部代码处理的，确保导出数据可以打开。
- CAD(DWG/DXF)格式
  1. 设置导出XRecordset标志为true时，导出忽略字段以外的XRecordset字段，若忽略后剩下的导出字段包含XData字段，按照第2条XData规则导出；导出XRecordset标志为为false时，无论是否忽略字段XRecordset字段全不导出；
  2. 设置导出XData标志为true时，导出忽略字段以外的XData字段，但需要注意以下几个方面:
    - a.若忽略后剩余XData字段中不包含后四个字符为1001的字段，则所有XData字段不导出；
    - b.若忽略后剩余XData字段中包含后四个字符为1001的字段但字段值为空，则当前记录的字段名相同前缀的所有XData字段不导出；
    - c.若忽略后剩余XData字段中包含后四个字符为1001的字段，且字段值不为空，但是不包含其他任意一个相同前缀的XData字段，则字段名相同前缀的所有XData字段不导出；
    - d.若忽略后剩余XData字段中包含后四个字符为1001的字段，且字段值不为空，并且包含其他相同前缀的XData字段，但是这些字段值都是空，则字段名相同的所有XData字段不导出；
    - e.若忽略后剩余XData字段包含后四个字符为1010、1011、1012、1013的字段,则自动补全成组出现的其他字段导出,成组出现的字段有（1010 1020 1030）（1011 1021 1031）（1012 1022 1032）（1013 1023 1033）；
    - f.若剩余字段中不包含成组出现的第一个字段，则无论其他字段是否包含都不导出此组任何字段；
    - g.若忽略后剩余字段包含XRecordset字段，则按照第一条XRecordset规则导出；
    - h.导出XData标志为false时，无论是否忽略字段XData字段都不导出。
  3. 全部忽略可以正常导出；
  4. 导入cad生成的默认字段（EntityHandle EntityType Layer LayerFroze LayerLocked LayerOn Thickness Elevation LineStyle ColorIndex BlockName BlockRotation LineWidth ）导出时系统自动忽略；
  5. 导出CAD格式时SuperMap中定义字段名后四个字符为以下字符的为XData字段：
    - 1000
    - 1001
    - 1003
    - 1004
    - 1005
    - 1010
    - 1020
    - 1030
    - 1011
    - 1021
    - 1031
    - 1012
    - 1022
    - 1032
    - 1013
    - 1023
    - 1033
    - 1040
    - 1041
    - 1042
    - 1070
    - 1071
  6. 导出CAD格式时SuperMap中定义除去系统字段、XData字段以外的其他字段为XRecordset字段；
  7. 后缀是1004的Xdata字段值是0-254的16进制字符串，例如“E5B3”并且是偶数长度，每两位代表一个16进制数，若为奇数，最后一位忽略。若值不合法，如“GF”则导出16进制格式为00。
- E00格式
  1. 全部忽略可以正常导出；
  2. 导入E00生成的默认字段（ UserID FNODE_ TNODE_ LPOLY_ RPOLY_ LENGTH CoverageID）导出时系统自动忽略。
- TAB/MIF格式
  1. 当所有的用户字段都忽略时，可以正常导出，Tab格式会自动添加一个字段FID，字段值都是-1，MIF格式添加一个字段NDX，值都是0，第三方库处理的；
  2. 导入MIF和Tab是生成的默认字段（LineSymbolID LineWidth LineColor FillSymbolID FillBackColor FillForeColor MarkerSymbolID MarkerSize MarkerAngle）导出时系统自动忽略。
- KML/KMZ/电信Vector/电信Building Vector /ModelX 不处理用户字段
- 注意：
  1. DBF/SHP/DWG/DXF/TAB/MIF格式，不忽略“SmUserID”时，若忽略后剩余字段中包含"UserID"，则“SmUserID”不导出，否则将“SmUserID”改成“UserID”导出；
  2. E00格式，SmUserID是否忽略都不导出。

构造器概要

构造器
构造器和说明
`ExportSetting()` 构造一个新的 ExportSetting 对象。
`ExportSetting(ExportSetting exportSetting)` 根据给定的 ExportSetting 对象构造一个与其完全相同的新对象。
`ExportSetting(Object sourceData, String targetFilePath, FileType targetFileType)` 根据指定的参数构造 ExportSetting 类的新实例。

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`boolean`	`fromXML(String xml)` 已过时。从外部的 XML 流中读取相应的设置，方便多次转换。
`String`	`getFilter()` 获取导出目标文件的过滤信息。
`String[]`	`getIgnoreFieldNames()` 获取需要忽略的字段，详见说明忽略字段的说明。
`Object`	`getSourceData()` 返回需要导出的源数据集。
`FileType[]`	`getSupportedFileType()` 返回设置的数据集能够导出的数据类型。
`Charset`	`getTargetFileCharset()` 返回需要导出的文件的字符集类型。
`String`	`getTargetFilePath()` 返回导出目标文件的路径信息。
`FileType`	`getTargetFileType()` 返回导出的目标文件的类型。
`boolean`	`isOverwrite()` 返回导出目录中存在同名文件时，是否强制覆盖。
`void`	`setFilter(String strfilter)` 设置导出目标文件的过滤信息。
`void`	`setIgnoreFieldNames(String[] ignoreFields)` 设置需要忽略的字段，详见说明忽略字段的说明。
`void`	`setOverwrite(boolean value)` 设置导出目录中存在同名文件时，是否强制覆盖。
`void`	`setSourceData(Object value)` 设置需要导出的源数据集。
`void`	`setTargetFileCharset(Charset charset)` 设置需要导出的文件的字符集类型。
`void`	`setTargetFilePath(String filePath)` 设置导出目标文件的路径信息。
`void`	`setTargetFileType(FileType type)` 设置导出的目标文件的类型。
`String`	`toXML()` 已过时。输出当前的设置为 XML 文件，用于保存导出的参数设置，方便用户持久化。XML 的实现由组件层完成，具体的格式待定。

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

- 构造器详细资料
  - ExportSetting
```
public ExportSetting()
```
    构造一个新的 ExportSetting 对象。
  - ExportSetting
```
public ExportSetting(ExportSetting exportSetting)
```
    根据给定的 ExportSetting 对象构造一个与其完全相同的新对象。
    
    参数:
    
    exportSetting - 用于初始化 ExportSetting 新实例的对象。
  - ExportSetting
```
public ExportSetting(Object sourceData,
                     String targetFilePath,
                     FileType targetFileType)
```
    根据指定的参数构造 ExportSetting 类的新实例。
    
    参数:
    
    sourceData - 指定的源数据。
    
    targetFilePath - 目标文件的路径。
    
    targetFileType - 需要导出的数据类型。
- 方法详细资料
  - getTargetFilePath
```
public String getTargetFilePath()
```
    返回导出目标文件的路径信息。
    
    返回:
    
    导出目标文件的路径信息。
    
    默认值:
    
    默认值为空字符串。
  - setTargetFilePath
```
public void setTargetFilePath(String filePath)
```
    设置导出目标文件的路径信息。
    用户需要根据导出目标文件的类型来决定此输出路径信息是否包含导出目标文件的后缀名。例如：对于电信行业数据，其数据按目录方式组织，其路径信息就不需要包含后缀名。
    
    参数:
    
    string - 导出目标文件的路径信息。
  - isOverwrite
```
public boolean isOverwrite()
```
    返回导出目录中存在同名文件时，是否强制覆盖。
    
    返回:
    
    导出目录中存在同名文件时，是否强制覆盖。
    
    默认值:
    
    默认为 false，即不执行导出操作，否则强制复制。
  - setOverwrite
```
public void setOverwrite(boolean value)
```
    设置导出目录中存在同名文件时，是否强制覆盖。默认为 false，即不执行导出操作，否则强制复制。
    
    参数:
    
    value - 导出目录中存在同名文件时，是否强制覆盖。
  - getTargetFileType
```
public FileType getTargetFileType()
```
    返回导出的目标文件的类型。
    不支持 WOR（MapInfo 工作空间文件）和 RAW (raw文件) 两种类型文件的导出。
    
    返回:
    
    导出的目标文件的类型。
    
    默认值:
    
    默认值为 FileType.NONE。
  - setTargetFileType
```
public void setTargetFileType(FileType type)
```
    设置导出的目标文件的类型。
    不支持 WOR（MapInfo 工作空间文件）和 RAW (raw文件) 两种类型文件的导出。
    
    参数:
    
    type - 导出的目标文件的类型。
  - getTargetFileCharset
```
public Charset getTargetFileCharset()
```
    返回需要导出的文件的字符集类型。SuperMap Objects Java 6R(2012) SP2 版本不支持该方法，预留后续版本使用。
    
    返回:
    
    需要导出的文件的字符集类型。
  - setTargetFileCharset
```
public void setTargetFileCharset(Charset charset)
```
    设置需要导出的文件的字符集类型。SuperMap Objects Java 6R(2012) SP2 版本不支持该方法，预留后续版本使用。
    
    参数:
    
    charset - 需要导出的文件的字符集类型。
  - getSourceData
```
public Object getSourceData()
```
    返回需要导出的源数据集。
    
    返回:
    
    需要导出的数据集。
    
    默认值:
    
    默认值为 null。
  - setSourceData
```
public void setSourceData(Object value)
```
    设置需要导出的源数据集。
    该方法支持的数据集类型为矢量数据集（DatasetVector），栅格数据集（DatasetGrid），影像数据集（DatsetImage）。
    
    参数:
    
    value - 需要导出的源数据集。
  - toXML
```
@Deprecated
public String toXML()
```
    已过时。输出当前的设置为 XML 文件，用于保存导出的参数设置，方便用户持久化。XML 的实现由组件层完成，具体的格式待定。
    
    返回:
    
    导出的 XML 字符串。
  - fromXML
```
@Deprecated
public boolean fromXML(String xml)
```
    已过时。从外部的 XML 流中读取相应的设置，方便多次转换。
    
    参数:
    
    xml - 需要导入的 XML 内容。
    
    返回:
    
    转换成功返回 true,否则返回 false。
  - getSupportedFileType
```
public FileType[] getSupportedFileType()
```
    返回设置的数据集能够导出的数据类型。
    
    返回:
    
    设置的数据集能够导出的数据类型。
  - getIgnoreFieldNames
```
public String[] getIgnoreFieldNames()
```
    获取需要忽略的字段，详见说明忽略字段的说明。
    
    返回:
    
    忽略的字段名称。
  - setIgnoreFieldNames
```
public void setIgnoreFieldNames(String[] ignoreFields)
```
    设置需要忽略的字段，详见说明忽略字段的说明。
    
    参数:
    
    fieldNames - 忽略的字段名称。
  - getFilter
```
public String getFilter()
```
    获取导出目标文件的过滤信息。
    
    返回:
    
    过滤信息，类似于SQL条件。
  - setFilter
```
public void setFilter(String strfilter)
```
    设置导出目标文件的过滤信息。
    
    参数:
    
    strfilter - 过滤信息，类似于SQL条件。

类 ExportSetting

构造器概要

方法概要

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

构造器详细资料

ExportSetting

ExportSetting

ExportSetting

方法详细资料

getTargetFilePath

setTargetFilePath

isOverwrite

setOverwrite

getTargetFileType

setTargetFileType

getTargetFileCharset

setTargetFileCharset

getSourceData

setSourceData

toXML

fromXML

getSupportedFileType

getIgnoreFieldNames

setIgnoreFieldNames

getFilter

setFilter