RelationSetting (iObjects Java Help)

java.lang.Object
- com.supermap.analyst.trafficanalyst.RelationSetting

```
public class RelationSetting
extends Object
```
公交关系设置类。通过该类可以设置站点与线路关系数据集、站点与出入口关系数据集以及网络数据集的相关信息。
公交分析的基础数据中，除站点数据集和线路数据集外，还有两个重要的数据集：站点与线路关系数据集和站点与出入口数据集。
- 站点与线路关系数据集，是一个纯属性表（DatasetType.TABULAR）类型的数据集，用于确定站点与线路的关系。现实中的公共交通，尤其是公交车，存在大量经过某站点而不停车的情况。单纯依靠将站点数据（二维点）捕捉到线路数据（二维线）上，不仅可能与实际情况不符，甚至可能导致分析结果错误，给使用者和出行者带来不必要的损失。因此，通过一个准确的站点与线路关系表就可以避免这种问题出现。
- 站点与出入口数据集，是一个二维线数据集，每一个线对象连接一个站点和一个出入口，用于表示站点与出入口间的实际线路。该数据是可选数据，如果设置了该数据，则换乘方案中给出的站点与出入口间的行进线路与该数据对应，如果不设置，站点与出入口间以直线连接。该数据能够保障公交换乘线路与实际保持一致，从而为出行者提供更加准确的换乘信息，如路线、总长度、时间花费等。
注意：站点 ID 字段、出入口 ID 字段和线路 ID 字段的类型目前仅支持32位整型和64位整型。
示范代码:

请参见 TransferAnalyst 类的 load 方法的示例。

构造器概要

构造器
构造器和说明
`RelationSetting()` 构造一个新的 RelationSetting 对象。
`RelationSetting(RelationSetting relationSetting)` 根据给定的 RelationSetting 对象构造一个与其完全相同的的新对象。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`DatasetVector`	`getDataset()` 返回站点与线路关系数据集。
`DatasetVector`	`getDatasetNetwork()` 返回网络数据集。
`DatasetVector`	`getDatasetPath()` 返回站点与出入口关系数据集。
`String`	`getEdgeIDField()` 返回网络数据集中的弧段 ID 字段。
`String`	`getExitIDField()` 返回站点与出入口关系数据集中的出入口 ID 字段。
`String`	`getExitNameCField()` 返回站点与出入口关系数据集中的出入口中文名称字段。
`String`	`getExitNamePYField()` 返回站点与出入口关系数据集中的出入口名称拼音字段。
`String`	`getFNodeIDField()` 返回网络数据集中的弧段起始结点 ID 的字段。
`String`	`getLineIDField()` 返回设置站点与线路关系数据集中的线路 ID 字段。
`String`	`getNodeIDField()` 返回网络数据集中的结点 ID 字段。
`String`	`getSerialNumField()` 返回站点与线路关系数据集中存储了站点在线路中的顺序号（即该站点为线路中的第几站）的字段。
`String`	`getStationIDField()` 返回站点与出入口关系数据集中的站点 ID 字段。
`String`	`getStopIDField()` 返回站点与线路关系数据集中的站点 ID 字段。
`String`	`getTNodeIDField()` 返回网络数据集中的弧段终止结点 ID 的字段。
`void`	`setDataset(DatasetVector datasetVector)` 设置站点与线路关系数据集。
`void`	`setDatasetNetwork(DatasetVector value)` 设置网络数据集。
`void`	`setDatasetPath(DatasetVector datasetVector)` 设置站点与出入口关系数据集。
`void`	`setEdgeIDField(String value)` 设置网络数据集中的弧段 ID 字段。
`void`	`setExitIDField(String value)` 设置站点与出入口关系数据集中的出入口 ID 字段。
`void`	`setExitNameCField(String value)` 设置站点与出入口关系数据集中的出入口中文名称字段。
`void`	`setExitNamePYField(String value)` 设置站点与出入口关系数据集中的出入口名称拼音字段。
`void`	`setFNodeIDField(String value)` 设置网络数据集中的弧段起始结点 ID 的字段。
`void`	`setLineIDField(String value)` 设置站点与线路关系数据集中的线路 ID 字段。
`void`	`setNodeIDField(String value)` 设置网络数据集中的结点 ID 字段。
`void`	`setSerialNumField(String value)` 设置站点与线路关系数据集中存储了站点在线路中的顺序号（即该站点为线路中的第几站）的字段。
`void`	`setStationIDField(String value)` 设置站点与出入口关系数据集中的站点 ID 字段。
`void`	`setStopIDField(String value)` 设置站点与线路关系数据集中的站点 ID 字段。
`void`	`setTNodeIDField(String value)` 设置网络数据集中的弧段终止结点 ID 的字段。

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

- 构造器详细资料
  - RelationSetting
```
public RelationSetting()
```
    构造一个新的 RelationSetting 对象。
  - RelationSetting
```
public RelationSetting(RelationSetting relationSetting)
```
    根据给定的 RelationSetting 对象构造一个与其完全相同的的新对象。
    
    参数:
    
    relationSetting - 指定的 RelationSetting 对象。
- 方法详细资料
  - getDataset
```
public DatasetVector getDataset()
```
    返回站点与线路关系数据集。
    详细介绍请参见 setDataset 方法。
    
    返回:
    
    站点与线路关系数据集。
  - setDataset
```
public void setDataset(DatasetVector datasetVector)
```
    设置站点与线路关系数据集。要求数据集类型为纯属性表类型。如果未设置或指定的数据集类型为其他类型，将抛出异常。
    公交站点与线路关系数据集，是进行公交分析的基础数据，如果不存在该数据集，公交站点数据集和公交线路数据集中的站点数据与线路数据的所属关系不能准确确定。
    
    参数:
    
    datasetVector - 站点与线路关系数据集。
  - getLineIDField
```
public String getLineIDField()
```
    返回设置站点与线路关系数据集中的线路 ID 字段。
    详细介绍请参见 setLineIDField 方法。
    
    返回:
    
    站点与线路关系数据集中的线路 ID 字段。
    
    默认值:
    
    默认值为一个空的字符串。
  - setLineIDField
```
public void setLineIDField(String value)
```
    设置站点与线路关系数据集中的线路 ID 字段。该字段为必设字段，要求字段类型为32位整型或64位整型。如果站点与线路关系数据集中不存在该字段或字段类型不匹配，将抛出异常。
    线路 ID 字段是公交线路的唯一标识值。站点与线路关系数据集中该字段的值应与公交线路数据集中的线路 ID 字段的值范围一致。
    
    参数:
    
    value - 站点与线路关系数据集中的线路 ID 字段。
  - getStopIDField
```
public String getStopIDField()
```
    返回站点与线路关系数据集中的站点 ID 字段。
    详细介绍请参见 setStopIDField 方法。
    
    返回:
    
    站点与线路关系数据集中的站点 ID 字段。
    
    默认值:
    
    默认值为一个空的字符串。
  - setStopIDField
```
public void setStopIDField(String value)
```
    设置站点与线路关系数据集中的站点 ID 字段。该字段为必设字段，要求字段类型为32位整型或64位整型。如果站点与线路关系数据集中不存在该字段或字段类型不匹配，将抛出异常。
    站点 ID 字段是公交站点的唯一标识值。站点与线路关系数据集中该字段的值应与公交站点数据集中的站点 ID 字段的值范围一致。
    
    参数:
    
    value - 站点与线路关系数据集中的站点 ID 字段。
  - getSerialNumField
```
public String getSerialNumField()
```
    返回站点与线路关系数据集中存储了站点在线路中的顺序号（即该站点为线路中的第几站）的字段。
    详细介绍请参见 setSerialNumField 方法。
    
    返回:
    
    站点与线路关系数据集中存储了站点在线路中的顺序号的字段。
    
    默认值:
    
    默认值为一个空的字符串。
  - setSerialNumField
```
public void setSerialNumField(String value)
```
    设置站点与线路关系数据集中存储了站点在线路中的顺序号（即该站点为线路中的第几站）的字段。
    站点在线路中的顺序号，即为该站点在线路中是第几站，其中起始站点为第 1 站。当使用按站数计价方式（在设置公交线路环境时，可以设置线路的票价信息，参见 setFareFieldInfo）时，知道了某条换乘线路的上车和下车站点在线路中的顺序号后，再结合票价信息就可以计算出这段距离的公交票价，进一步可以获取整个换乘方案总的公交票价。
    
    参数:
    
    value - 站点与线路关系数据集中存储了站点在线路中的顺序号的字段。
  - getDatasetPath
```
public DatasetVector getDatasetPath()
```
    返回站点与出入口关系数据集。
    详细介绍请参见 setDatasetPath 方法。
    
    返回:
    
    站点与出入口线路数据集。
  - setDatasetPath
```
public void setDatasetPath(DatasetVector datasetVector)
```
    设置站点与出入口关系数据集。要求数据集类型为线数据集。如果指定的数据集类型为其他类型，将抛出异常。
    该数据集是一个二维线数据集，存储了从站点到出入口的实际行进路线，通过实际测量或数字化获得。线对象的两个端点分别连接一个站点和一个出入口站点。在公交换乘分析结果的换乘方案中，站点和出入口间的路线将根据该数据来给出。注意，该数据不是必须设置的数据，如果不指定该数据集，则公交换乘分析结果中，站点与出入口间以直线连接。
    
    参数:
    
    datasetVector - 站点与线路关系数据集。
  - getExitIDField
```
public String getExitIDField()
```
    返回站点与出入口关系数据集中的出入口 ID 字段。
    
    返回:
    
    出入口 ID 字段。
    
    默认值:
    
    默认值为一个空的字符串。
  - setExitIDField
```
public void setExitIDField(String value)
```
    设置站点与出入口关系数据集中的出入口 ID 字段。该字段为必设字段，要求字段类型为32位整型或64位整型。如果站点与线路关系数据集中不存在该字段或字段类型不匹配，将抛出异常。
    
    参数:
    
    value - 出入口 ID 字段。
  - getStationIDField
```
public String getStationIDField()
```
    返回站点与出入口关系数据集中的站点 ID 字段。
    
    返回:
    
    站点 ID 字段。
    
    默认值:
    
    默认值为一个空的字符串。
  - setStationIDField
```
public void setStationIDField(String value)
```
    设置站点与出入口关系数据集中的站点 ID 字段。该字段为必设字段，要求字段类型为32位整型或64位整型。如果站点与线路关系数据集中不存在该字段或字段类型不匹配，将抛出异常。
    
    参数:
    
    value - 站点 ID 字段。
  - getExitNameCField
```
public String getExitNameCField()
```
    返回站点与出入口关系数据集中的出入口中文名称字段。
    
    返回:
    
    出入口中文名称字段。
    
    默认值:
    
    默认值为一个空的字符串。
  - setExitNameCField
```
public void setExitNameCField(String value)
```
    设置站点与出入口关系数据集中的出入口中文名称字段。
    
    参数:
    
    value - 出入口中文名称字段。
  - getExitNamePYField
```
public String getExitNamePYField()
```
    返回站点与出入口关系数据集中的出入口名称拼音字段。
    
    返回:
    
    出入口名称拼音字段。
    
    默认值:
    
    默认值为一个空的字符串。
  - setExitNamePYField
```
public void setExitNamePYField(String value)
```
    设置站点与出入口关系数据集中的出入口名称拼音字段。
    
    参数:
    
    value - 出入口名称拼音字段。
  - setDatasetNetwork
```
public void setDatasetNetwork(DatasetVector value)
```
    设置网络数据集。根据网络数据集的弧段和结点信息来获取换乘时的实际步行路线。
    网络数据集不是必须设置的数据，如果不设置，换乘时的路线为连接换乘起点和终点的一条直线。
    
    参数:
    
    value - 网络数据集。
  - getDatasetNetwork
```
public DatasetVector getDatasetNetwork()
```
    返回网络数据集。根据网络数据集的弧段和结点信息来获取换乘时的实际步行路线。
    
    返回:
    
    网络数据集。
  - setNodeIDField
```
public void setNodeIDField(String value)
```
    设置网络数据集中的结点 ID 字段。
    
    参数:
    
    value - 网络数据集中的结点 ID 字段。
  - getNodeIDField
```
public String getNodeIDField()
```
    返回网络数据集中的结点 ID 字段。
    
    返回:
    
    网络数据集中的结点 ID 字段。
    
    默认值:
    
    默认值为一个空的字符串。
  - setEdgeIDField
```
public void setEdgeIDField(String value)
```
    设置网络数据集中的弧段 ID 字段。
    
    参数:
    
    value - 网络数据集中的弧段 ID 字段。
  - getEdgeIDField
```
public String getEdgeIDField()
```
    返回网络数据集中的弧段 ID 字段。
    
    返回:
    
    网络数据集中的弧段 ID 字段。
    
    默认值:
    
    默认值为一个空的字符串。
  - setFNodeIDField
```
public void setFNodeIDField(String value)
```
    设置网络数据集中的弧段起始结点 ID 的字段。
    
    参数:
    
    value - 网络数据集中的弧段起始结点 ID 的字段。
  - getFNodeIDField
```
public String getFNodeIDField()
```
    返回网络数据集中的弧段起始结点 ID 的字段。
    
    返回:
    
    网络数据集中的弧段起始结点 ID 的字段。
    
    默认值:
    
    默认值为一个空的字符串。
  - setTNodeIDField
```
public void setTNodeIDField(String value)
```
    设置网络数据集中的弧段终止结点 ID 的字段。
    
    参数:
    
    value - 网络数据集中的弧段终止结点 ID 的字段。
  - getTNodeIDField
```
public String getTNodeIDField()
```
    返回网络数据集中的弧段终止结点 ID 的字段。
    
    返回:
    
    网络数据集中的弧段终止结点 ID 的字段。
    
    默认值:
    
    默认值为一个空的字符串。

类 RelationSetting

构造器概要

方法概要

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

构造器详细资料

RelationSetting

RelationSetting

方法详细资料

getDataset

setDataset

getLineIDField

setLineIDField

getStopIDField

setStopIDField

getSerialNumField

setSerialNumField

getDatasetPath

setDatasetPath

getExitIDField

setExitIDField

getStationIDField

setStationIDField

getExitNameCField

setExitNameCField

getExitNamePYField

setExitNamePYField

setDatasetNetwork

getDatasetNetwork

setNodeIDField

getNodeIDField

setEdgeIDField

getEdgeIDField

setFNodeIDField

getFNodeIDField

setTNodeIDField

getTNodeIDField