GenerateSpatialDataParameter (iObjects Java Help)

java.lang.Object
- com.supermap.analyst.spatialanalyst.GenerateSpatialDataParameter

```
public class GenerateSpatialDataParameter
extends Object
```
线性参考中生成空间数据参数类。该类提供从事件表转换到空间数据时参数的设置。

构造器概要

构造器
构造器和说明
`GenerateSpatialDataParameter()` 构造一个新的 GenerateSpatialDataParameter 对象。
`GenerateSpatialDataParameter(DatasetVector eventTable, String routeIDField, String measureField, String outputDatasetName)` 已过时。此方法已废弃，请使用新方法 `GenerateSpatialDataParameter.setEventTable(DatasetVector)` 、`GenerateSpatialDataParameter.setRouteIDField(String)` 、`GenerateSpatialDataParameter.setMeasureField(String)` 、`GenerateSpatialDataParameter.setOutputDatasetName(String)` 替换。
`GenerateSpatialDataParameter(DatasetVector eventTable, String routeIDField, String measureStartField, String measureEndField, String outputDatasetName)` 已过时。此方法已废弃，请使用新方法 `GenerateSpatialDataParameter.setEventTable(DatasetVector)` 、`GenerateSpatialDataParameter.setRouteIDField(String)` 、`GenerateSpatialDataParameter.setMeasureField(String)` 、`GenerateSpatialDataParameter.setMeasureEndField(String)` 、`GenerateSpatialDataParameter.setOutputDatasetName(String)` 替换。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`String`	`getErrorInfoField()` 返回错误信息字段，直接写入原事件表，用于描述事件未能生成对应的点或线的错误信息。
`String`	`getEventRouteIDField()` 返回用于生成空间数据的事件表的路由标识字段。
`DatasetVector`	`getEventTable()` 返回用于生成空间数据的事件表。
`String`	`getMeasureEndField()` 返回用于生成空间数据的事件表的终止刻度字段，只当事件为点事件的时候该属性才有意义。
`String`	`getMeasureField()` 返回用于生成空间数据的事件表的刻度字段，只当事件为点事件的时候该属性才有意义。
`String`	`getMeasureOffsetField()` 返回偏移量字段。
`String`	`getMeasureStartField()` 返回用于生成空间数据的事件表的起始刻度字段，只当事件为点事件的时候该属性才有意义。
`String`	`getOutputDatasetName()` 返回结果数据集名称。
`DatasetVector`	`getReferenceLineM()` 返回用于生成空间数据的路由数据集。
`String[]`	`getRetainedFields()` 返回事件表中要保留到结果空间数据的字段集合（系统字段除外）。
`String`	`getRouteIDField()` 返回用于生成空间数据的路由数据集中的路由标识字段。
`void`	`setErrorInfoField(String value)` 设置错误信息字段，直接写入原事件表，用于描述事件未能生成对应的点或线的错误信息。
`void`	`setEventRouteIDField(String value)` 设置用于生成空间数据的事件表的路由标识字段。
`void`	`setEventTable(DatasetVector value)` 设置用于生成空间数据的事件表。
`void`	`setMeasureEndField(String value)` 设置用于生成空间数据的事件表的终止刻度字段，只当事件为点事件的时候该属性才有意义。
`void`	`setMeasureField(String value)` 设置用于生成空间数据的事件表的刻度字段，只当事件为点事件的时候该属性才有意义。
`void`	`setMeasureOffsetField(String value)` 设置偏移量字段。
`void`	`setMeasureStartField(String value)` 设置用于生成空间数据的事件表的起始刻度字段，只当事件为点事件的时候该属性才有意义。
`void`	`setOutputDatasetName(String value)` 设置结果数据集名称。
`void`	`setReferenceLineM(DatasetVector value)` 设置用于生成空间数据的路由数据集。
`void`	`setRetainedFields(String[] value)` 设置事件表中要保留到结果空间数据的字段集合（系统字段除外）。
`void`	`setRouteIDField(String value)` 设置用于生成空间数据的路由数据集中的路由标识字段。

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

- 构造器详细资料
  - GenerateSpatialDataParameter
```
public GenerateSpatialDataParameter()
```
    构造一个新的 GenerateSpatialDataParameter 对象。
  - GenerateSpatialDataParameter
```
@Deprecated
public GenerateSpatialDataParameter(DatasetVector eventTable,
                                                 String routeIDField,
                                                 String measureField,
                                                 String outputDatasetName)
```
    已过时。此方法已废弃，请使用新方法 GenerateSpatialDataParameter.setEventTable(DatasetVector) 、GenerateSpatialDataParameter.setRouteIDField(String) 、GenerateSpatialDataParameter.setMeasureField(String) 、GenerateSpatialDataParameter.setOutputDatasetName(String) 替换。
    
    根据指定的参数构造一个 GenerateSpatialDataParameter 的新对象。
    
    参数:
    
    eventTable - 指定的关联的点事件表。
    
    routeIDField - 指定的结果路由标识字段。
    
    measureField - 指定的刻度字段，用来标示路由节点的权重。
    
    outputDatasetName - 指定的结果数据集的名称。
  - GenerateSpatialDataParameter
```
@Deprecated
public GenerateSpatialDataParameter(DatasetVector eventTable,
                                                 String routeIDField,
                                                 String measureStartField,
                                                 String measureEndField,
                                                 String outputDatasetName)
```
    已过时。此方法已废弃，请使用新方法 GenerateSpatialDataParameter.setEventTable(DatasetVector) 、GenerateSpatialDataParameter.setRouteIDField(String) 、GenerateSpatialDataParameter.setMeasureField(String) 、GenerateSpatialDataParameter.setMeasureEndField(String) 、GenerateSpatialDataParameter.setOutputDatasetName(String) 替换。
    
    根据指定的参数构造一个 GenerateSpatialDataParameter 的新对象。
    
    参数:
    
    eventTable - 指定的关联的线事件表。
    
    routeIDField - 指定的结果路由标识字段。
    
    measureStartField - 指定的起始刻度字段，用来标示路由起始节点的权重。
    
    measureEndField - 指定的终止刻度字段，用来标示路由终止节点的权重。
    
    outputDatasetName - 指定的结果数据集名称。
- 方法详细资料
  - getReferenceLineM
```
public DatasetVector getReferenceLineM()
```
    返回用于生成空间数据的路由数据集。
    
    返回:
    
    用于生成空间数据的路由数据集。
  - setReferenceLineM
```
public void setReferenceLineM(DatasetVector value)
```
    设置用于生成空间数据的路由数据集。
    
    参数:
    
    value - 用于生成空间数据的路由数据集。
  - getEventTable
```
public DatasetVector getEventTable()
```
    返回用于生成空间数据的事件表。
    >事件表记录了点者线事件信息，包括发生的位置（刻度）和其他描述事件的属性信息。因此，事件表中必须有事件发生的路由标识字段和刻度字段，若为线事件表，必须有起始刻度和终止刻度字段。
    
    返回:
    
    事件表。
  - setEventTable
```
public void setEventTable(DatasetVector value)
```
    设置用于生成空间数据的事件表。
    >事件表记录了点者线事件信息，包括发生的位置（刻度）和其他描述事件的属性信息。因此，事件表中必须有事件发生的路由标识字段和刻度字段，若为线事件表，必须有起始刻度和终止刻度字段。
    
    参数:
    
    value - 事件表。
  - getRouteIDField
```
public String getRouteIDField()
```
    返回用于生成空间数据的路由数据集中的路由标识字段。
    
    返回:
    
    用于生成空间数据的路由数据集中的路由标识字段。
  - setRouteIDField
```
public void setRouteIDField(String value)
```
    设置用于生成空间数据的路由数据集中的路由标识字段。
    注意：对于路由标识字段，所支持的字段类型请参见 LinearReferencing 类的介绍。如果设置的字段类型不被支持，会导致生成空间数据失败。
    
    参数:
    
    value - 用于生成空间数据的路由数据集中的路由标识字段。
  - getMeasureOffsetField
```
public String getMeasureOffsetField()
```
    返回偏移量字段。
    有关偏移量字段的介绍，请参见 setMeasureOffsetField 方法。
    
    返回:
    
    偏移量字段。
  - setMeasureOffsetField
```
public void setMeasureOffsetField(String value)
```
    设置偏移量字段。
    通过该方法可以指定事件表中的一个字段作为偏移字段（字段类型需为值类型）。在生成空间数据时，系统会根据该字段的值（称为偏移量）对生成的空间数据（点或路由对象）进行位置上的偏移。
    
    偏移的方向与偏移量的正负和路由的方向有关。如果偏移量为正值，生成的空间数据会向路由的左方偏移；如果为负值，则向路由的右方偏移。偏移时，系统会将偏移量在 X、Y 方向上分别投影，按投影长度分别在 X、Y 方向上移动。有关几何对象的偏移请参见 offset 方法的介绍。下图展示了生成空间数据时不指定和指定偏移量的效果。
    
    注意：根据路由节点的顺序可以判断路由的方向。路由的方向指向节点编号从小到大的方向。路由的左方是指路由方向的左方，路由的右方即路由方向的右方。
    
    参数:
    
    value - 偏移量字段。
  - getMeasureField
```
public String getMeasureField()
```
    返回用于生成空间数据的事件表的刻度字段，只当事件为点事件的时候该属性才有意义。
    
    返回:
    
    事件表的刻度字段。
  - setMeasureField
```
public void setMeasureField(String value)
```
    设置用于生成空间数据的事件表的刻度字段，只当事件为点事件的时候该属性才有意义。
    注意：对于刻度值字段，所支持的字段类型请参见 LinearReferencing 类的备注部分。如果设置的字段类型不被支持，会导致生成空间数据失败。
    
    参数:
    
    value - 事件表的刻度字段。
  - getMeasureStartField
```
public String getMeasureStartField()
```
    返回用于生成空间数据的事件表的起始刻度字段，只当事件为点事件的时候该属性才有意义。
    
    返回:
    
    事件表的起始刻度字段。
  - setMeasureStartField
```
public void setMeasureStartField(String value)
```
    设置用于生成空间数据的事件表的起始刻度字段，只当事件为点事件的时候该属性才有意义。
    注意：对于刻度值字段，所支持的字段类型请参见 LinearReferencing 类的备注部分。如果设置的字段类型不被支持，会导致生成空间数据失败。
    
    参数:
    
    value - 事件表的起始刻度字段。
  - getMeasureEndField
```
public String getMeasureEndField()
```
    返回用于生成空间数据的事件表的终止刻度字段，只当事件为点事件的时候该属性才有意义。
    
    返回:
    
    事件表的终止刻度字段。
  - setMeasureEndField
```
public void setMeasureEndField(String value)
```
    设置用于生成空间数据的事件表的终止刻度字段，只当事件为点事件的时候该属性才有意义。
    注意：对于刻度值字段，所支持的字段类型请参见 LinearReferencing 类的备注部分。如果设置的字段类型不被支持，会导致生成空间数据失败。
    
    参数:
    
    value - 事件表的终止刻度字段。
  - getErrorInfoField
```
public String getErrorInfoField()
```
    返回错误信息字段，直接写入原事件表，用于描述事件未能生成对应的点或线的错误信息。
    并非所有的事件都可以成功生成空间数据，在生成空间数据时，通常有几种未能成功定位的错误。如果通过该属性设置了错误信息字段名称，在生成空间数据之后，系统会自动将该错误字段添加到事件表中并写入错误信息。可能出现的错误信息请参见 setErrorInfoField 方法的介绍。
    
    返回:
    
    错误信息字段。
  - setErrorInfoField
```
public void setErrorInfoField(String value)
```
    设置错误信息字段，直接写入原事件表，用于描述事件未能生成对应的点或线的错误信息。
    并非所有的事件都可以成功生成空间数据，在生成空间数据时，通常有几种未能成功定位的错误。如果通过该属性设置了错误信息字段名称，在生成空间数据之后，系统会自动将该错误字段添加到事件表中并写入错误信息。字段值为空表示没有错误。
    - 当生成的空间数据为点数据时出现的错误信息有以下几种：
    - 当生成的空间数据为线数据时出现的错误信息有以下几种：
    参数:
    
    value - 错误信息字段。
  - getOutputDatasetName
```
public String getOutputDatasetName()
```
    返回结果数据集名称。
    
    返回:
    
    结果数据集名称。
  - setOutputDatasetName
```
public void setOutputDatasetName(String value)
```
    设置结果数据集名称。
    
    参数:
    
    value - 结果数据集名称。
  - getEventRouteIDField
```
public String getEventRouteIDField()
```
    返回用于生成空间数据的事件表的路由标识字段。
    
    返回:
    
    事件表的路由标识字段。
  - setEventRouteIDField
```
public void setEventRouteIDField(String value)
```
    设置用于生成空间数据的事件表的路由标识字段。
    注意：对于路由标识字段，所支持的字段类型请参见 LinearReferencing 类的介绍。如果设置的字段类型不被支持，会导致生成空间数据失败。
    
    参数:
    
    value - 事件表的路由标识字段。
  - getRetainedFields
```
public String[] getRetainedFields()
```
    返回事件表中要保留到结果空间数据的字段集合（系统字段除外）。
    
    返回:
    
    事件表中保留到结果空间数据中的字段集合。
    
    从以下版本开始:
    
    SuperMap iObjects Java 7.0.0
  - setRetainedFields
```
public void setRetainedFields(String[] value)
```
    设置事件表中要保留到结果空间数据的字段集合（系统字段除外）。
    注意，生成空间数据时，无论是否指定保留字段，路由 ID 字段、刻度值字段、Event_SMID 字段以及偏移字段（如果指定了）都会保留到结果空间数据中，Event_SMID 字段用于存储事件表中对应事件的 SmID。详见 GenerateSpatialData 方法介绍中的”注意“部分。
    
    参数:
    
    value - 指定的要保留到结果空间数据中的字段集合。
    
    从以下版本开始:
    
    SuperMap iObjects Java 7.0.0

类 GenerateSpatialDataParameter

构造器概要

方法概要

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

构造器详细资料

GenerateSpatialDataParameter

GenerateSpatialDataParameter

GenerateSpatialDataParameter

方法详细资料

getReferenceLineM

setReferenceLineM

getEventTable

setEventTable

getRouteIDField

setRouteIDField

getMeasureOffsetField

setMeasureOffsetField

getMeasureField

setMeasureField

getMeasureStartField

setMeasureStartField

getMeasureEndField

setMeasureEndField

getErrorInfoField

setErrorInfoField

getOutputDatasetName

setOutputDatasetName

getEventRouteIDField

setEventRouteIDField

getRetainedFields

setRetainedFields