AddressMatchParameter (iObjects Java Help)

java.lang.Object
- com.supermap.analyst.addressmatching.AddressMatchParameter

```
public class AddressMatchParameter
extends Object
```
中文地址模糊匹配参数类。
该类提供了进行中文地址模糊匹配所需的参数，包括用于匹配的数据集、查询结果个数、待匹配的关键字以及搜索范围等。

示范代码:

请参见 AddressMatch 类的示例。

构造器概要

构造器
构造器和说明
`AddressMatchParameter()` 构造一个中文地址模糊匹配参数类的新对象。
`AddressMatchParameter(AddressMatchParameter addressMatchParameter)` 根据指定的中文地址模糊匹配参数类对象构造一个与其完全相同的新对象。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`int`	`addSearchDataset(DatasetVector dataset)` 添加用于中文地址模糊匹配的数据集，添加成功返回该数据集在用于中文地址模糊匹配的数据集集合中的索引值。
`void`	`clearSearchDataset()` 清除用于中文地址模糊匹配数据集集合中的所有数据集。
`int`	`getResultCount()` 返回查询结果的个数。
`String`	`getSearchAddress()` 返回待匹配的中文地址。
`DatasetVector[]`	`getSearchDatasets()` 返回用于中文地址模糊匹配的数据集集合，即待匹配的中文地址将在这些数据集中搜索与其匹配的内容。
`GeoRegion`	`getSearchRegion()` 返回查询的区域。
`boolean`	`isAddressSegmented()` 返回传入的中文地址是否已经被分割，即用“*”分隔符进行了分词。
`boolean`	`isLocationReturn()` 返回中文地址模糊匹配结果对象（即 `AddressMatchResult` 类）是否包含位置信息。
`boolean`	`removeSearchDataset(int index)` 移除用于中文地址模糊匹配数据集集合中指定索引处的数据集。
`void`	`setAddressSegmented(boolean value)` 设置传入的中文地址是否已经被分割，即用“*”分隔符进行了分词。
`void`	`setLocationReturn(boolean value)` 设置中文地址模糊匹配结果对象（即 `AddressMatchResult` 类）是否包含位置信息。
`void`	`setResultCount(int value)` 设置查询结果的个数。
`void`	`setSearchAddress(String value)` 设置待匹配的中文地址。
`boolean`	`setSearchDataset(int index, DatasetVector dataset)` 用指定的数据集替换用于中文地址模糊匹配的数据集集合中指定索引处的数据集。
`void`	`setSearchRegion(GeoRegion geoRegion)` 设置查询的区域。

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

- 构造器详细资料
  - AddressMatchParameter
```
public AddressMatchParameter()
```
    构造一个中文地址模糊匹配参数类的新对象。
  - AddressMatchParameter
```
public AddressMatchParameter(AddressMatchParameter addressMatchParameter)
```
    根据指定的中文地址模糊匹配参数类对象构造一个与其完全相同的新对象。
    
    参数:
    
    addressMatchParameter - 给定的中文地址模糊匹配参数类对象。
- 方法详细资料
  - getSearchDatasets
```
public DatasetVector[] getSearchDatasets()
```
    返回用于中文地址模糊匹配的数据集集合，即待匹配的中文地址将在这些数据集中搜索与其匹配的内容。
    
    返回:
    
    将要被查询的数据集集合。
    
    默认值:
    
    默认值为空的 DatasetVector[] 对象。
  - getResultCount
```
public int getResultCount()
```
    返回查询结果的个数。
    用户可以自己定义查询结果个数的最大值，超过这个数值的结果会被忽略掉，默认为0条，即返回所有匹配的结果。
    
    返回:
    
    查询结果的个数。
    
    默认值:
    
    默认值为0。
  - setResultCount
```
public void setResultCount(int value)
```
    设置查询结果的个数。
    用户可以自己定义查询结果个数的最大值，超过这个数值的结果会被忽略掉，默认为0条，即返回所有匹配的结果。
    
    参数:
    
    value - 查询结果的个数。
  - getSearchAddress
```
public String getSearchAddress()
```
    返回待匹配的中文地址。
    待匹配的中文地址将作为一个字符串传入到中文地址模糊匹配方法中，字符串可以包含任何汉字。另外，“*”是分词符，即用户可以使用“*”符号自己对输入的待匹配的中文地址进行分词，从而划分自定义的有意义的词，进而通过中文地址模糊匹配方法找到匹配的内容。
    1. 中文地址模糊匹配支持多个中文地址的表达式匹配：
      SuperMap 组件产品的“与”搜索需要在关键词中间输入“+”连接符，并且在连接符的左右加上空格，则可以自动实现关键词的“与”搜索，即搜索结果同时包含所有的关键词。例如：输入【北京 + 大学】进行搜索，则搜索结果为包含【北京】与【大学】的所有结果：“北京师范大学”、“北京科技大学”、“中国地质大学北京网络教育学院”等。
    2. 中文地址模糊匹配支持多个中文地址的“或”搜索：
      若在几个关键词之间加上“*”连接，并且在连接符的左右加上空格，则可以实现关键词的“或”搜索，即包含一个或几个关键词的内容都会被搜索出来，但在结果排序时，包含全部关键词的搜索结果排在前面。例如：如果你想搜索【酒店】也想搜索【饭店】，则不必搜索两次，直接输入【酒店 * 饭店】进行搜索，则搜索结果为包含【酒店】或【饭店】的所有信息：“希尔顿酒店”、“丽都饭店”等。
    3. 中文地址模糊匹配支持多个中文地址的“差”搜索：
      例如：如果你想搜索【大学】但不想带有【北京】，则直接输入【大学 - 北京】进行搜索，则搜索结果为包含【大学】但不含【北京】的所有信息。
    注：英文是以词为单位，词与词之间用空格隔开，例如【Thank you.】计算机很容易通过空格来识别 you 是一个单词。而中文是以字为单位，通过字组成的句子来表述意思。例如，【我爱北京天安门】，计算机很难知道【天安门】是一个不能拆分的词，这就需要我们进行分词。把中文的汉字序列切分成有意义的词的过程，就是中文分词。
    返回:
    
    待匹配的中文地址。
    
    默认值:
    
    默认值为空。
  - setSearchAddress
```
public void setSearchAddress(String value)
```
    设置待匹配的中文地址。
    待匹配的中文地址将作为一个字符串传入到中文地址模糊匹配方法中，字符串可以包含任何汉字。另外，“*”是分词符，即用户可以使用“*”符号自己对输入的待匹配的中文地址进行分词，从而划分自定义的有意义的词，进而通过中文地址模糊匹配方法找到匹配的内容。
    1. 中文地址模糊匹配支持多个中文地址的表达式匹配：
      SuperMap 组件产品的“与”搜索需要在关键词中间输入“+”连接符，并且在连接符的左右加上空格，则可以自动实现关键词的“与”搜索，即搜索结果同时包含所有的关键词。例如：输入【北京 + 大学】进行搜索，则搜索结果为包含【北京】与【大学】的所有结果：“北京师范大学”、“北京科技大学”、“中国地质大学北京网络教育学院”等。
    2. 中文地址模糊匹配支持多个中文地址的“或”搜索：
      若在几个关键词之间加上“*”连接，并且在连接符的左右加上空格，则可以实现关键词的“或”搜索，即包含一个或几个关键词的内容都会被搜索出来，但在结果排序时，包含全部关键词的搜索结果排在前面。例如：如果你想搜索【酒店】也想搜索【饭店】，则不必搜索两次，直接输入【酒店 * 饭店】进行搜索，则搜索结果为包含【酒店】或【饭店】的所有信息：“希尔顿酒店”、“丽都饭店”等。
    3. 中文地址模糊匹配支持多个中文地址的“差”搜索：
      例如：如果你想搜索【大学】但不想带有【北京】，则直接输入【大学 - 北京】进行搜索，则搜索结果为包含【大学】但不含【北京】的所有信息。
    注：英文是以词为单位，词与词之间用空格隔开，例如【Thank you.】计算机很容易通过空格来识别 you 是一个单词。而中文是以字为单位，通过字组成的句子来表述意思。例如，【我爱北京天安门】，计算机很难知道【天安门】是一个不能拆分的词，这就需要我们进行分词。把中文的汉字序列切分成有意义的词的过程，就是中文分词。
    参数:
    
    value - 待匹配的中文地址。
  - getSearchRegion
```
public GeoRegion getSearchRegion()
```
    返回查询的区域。
    
    返回:
    
    查询的区域。
    
    默认值:
    
    默认值为空。
  - setSearchRegion
```
public void setSearchRegion(GeoRegion geoRegion)
```
    设置查询的区域。
    
    参数:
    
    geoRegion - 返查询的区域。
  - isLocationReturn
```
public boolean isLocationReturn()
```
    返回中文地址模糊匹配结果对象（即 AddressMatchResult 类）是否包含位置信息。true 表示中文地址模糊匹配结果对象包含位置信息，false 表示不包含位置信息。
    位置信息是指查询出来的地址所在的地理位置。
    - 如果查询出来的对象是点，则返回点的坐标；
    - 如果查询出来的对象是面或者其他对象，则返回对象的中心点。
    返回:
    
    中文地址模糊匹配结果对象包含位置信息返回 true；否则返回 false。
    
    默认值:
    
    默认值为 false。
  - setLocationReturn
```
public void setLocationReturn(boolean value)
```
    设置中文地址模糊匹配结果对象（即 AddressMatchResult 类）是否包含位置信息。
    位置信息是指查询出来的地址所在的地理位置。
    - 如果查询出来的对象是点，则返回点的坐标；
    - 如果查询出来的对象是面或者其他对象，则返回对象的中心点。
    参数:
    
    value - 一个布尔值指定是否包含位置信息。
  - isAddressSegmented
```
public boolean isAddressSegmented()
```
    返回传入的中文地址是否已经被分割，即用“*”分隔符进行了分词。“*”是分词符，即用户可以使用“*”符号自己对输入的待匹配的中文地址进行分词，从而划分自定义的有意义的词，进而通过中文地址模糊匹配方法找到匹配的内容。
    注：英文是以词为单位，词与词之间用空格隔开，例如【Thank you.】计算机很容易通过空格来识别 you 是一个单词。而中文是以字为单位，通过字组成的句子来表述意思。例如，【我爱北京天安门】，计算机很难知道【天安门】是一个不能拆分的词，这就需要我们进行分词。把中文的汉字序列切分成有意义的词的过程，就是中文分词。
    
    返回:
    
    如果传入的地址被分割过，返回 true；否则返回 false。
    
    默认值:
    
    默认值为 false。
  - setAddressSegmented
```
public void setAddressSegmented(boolean value)
```
    设置传入的中文地址是否已经被分割，即用“*”分隔符进行了分词。“*”是分词符，即用户可以使用“*”符号自己对输入的待匹配的中文地址进行分词，从而划分自定义的有意义的词，进而通过中文地址模糊匹配方法找到匹配的内容。
    注：英文是以词为单位，词与词之间用空格隔开，例如【Thank you.】计算机很容易通过空格来识别 you 是一个单词。而中文是以字为单位，通过字组成的句子来表述意思。例如，【我爱北京天安门】，计算机很难知道【天安门】是一个不能拆分的词，这就需要我们进行分词。把中文的汉字序列切分成有意义的词的过程，就是中文分词。
    
    参数:
    
    value - 一个布尔值指定是否分割传入的地址。
  - addSearchDataset
```
public int addSearchDataset(DatasetVector dataset)
```
    添加用于中文地址模糊匹配的数据集，添加成功返回该数据集在用于中文地址模糊匹配的数据集集合中的索引值。
    
    参数:
    
    dataset - 将被查询的数据集。用于中文地址模糊匹配的数据集。
    
    返回:
    
    添加成功返回数据集在数据集集合中的索引值，否则返回-1。
  - setSearchDataset
```
public boolean setSearchDataset(int index,
                                DatasetVector dataset)
```
    用指定的数据集替换用于中文地址模糊匹配的数据集集合中指定索引处的数据集。
    
    参数:
    
    index - 指定的索引值，即在用于中文地址模糊匹配的数据集集合中的索引值。
    
    dataset - 指定的数据集。
    
    返回:
    
    设置成功返回 true；否则返回 false。
  - removeSearchDataset
```
public boolean removeSearchDataset(int index)
```
    移除用于中文地址模糊匹配数据集集合中指定索引处的数据集。
    
    参数:
    
    index - 指定的将被移除的数据集的索引。
    
    返回:
    
    如果移除成功，返回值为 true；否则，false。
  - clearSearchDataset
```
public void clearSearchDataset()
```
    清除用于中文地址模糊匹配数据集集合中的所有数据集。

类 AddressMatchParameter

构造器概要

方法概要

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

构造器详细资料

AddressMatchParameter

AddressMatchParameter

方法详细资料

getSearchDatasets

getResultCount

setResultCount

getSearchAddress

setSearchAddress

getSearchRegion

setSearchRegion

isLocationReturn

setLocationReturn

isAddressSegmented

setAddressSegmented

addSearchDataset

setSearchDataset

removeSearchDataset

clearSearchDataset