GeocodeMatchFields (geocodingservices - geocoding-api 5.1.796 API)

java.lang.Object
- com.mapinfo.geocode.GeocodeMatchFields

All Implemented Interfaces:

FieldsMatching, GeoSerialize, Serializable
```
public class GeocodeMatchFields
extends Object
implements FieldsMatching, GeoSerialize
```
This class implements the FieldsMatching interface. It is used both to describe the must match fields in the geocoding preferences, as well as what fields matched input on a geocoding candidate.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GeocodeMatchFields()

GeocodeMatchFields(FieldsMatching orig)

Constructors
Constructor and Description
`GeocodeMatchFields()`
`GeocodeMatchFields(FieldsMatching orig)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,Object>`	`convertToMap()` Convert this object to a "map of maps" where each map is Map<String, Object>
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`boolean`	`isMatchOnAddressNumber()` In preferences, true indicates the candidate must match address number to be returned; on a candidate, true indicates a match to input field.
`boolean`	`isMatchOnAllStreetFields()` In preferences, true indicates the candidate must match any provided input street name, type, directional, prefix and suffix to be returned; on a candidate, true indicates a match to input street information.
`boolean`	`isMatchOnAreaName1()` In preferences, true indicates the candidate must match input area name 1 to be returned; on a candidate, true indicates a match to input field.
`boolean`	`isMatchOnAreaName2()` In preferences, true indicates the candidate must match input area name 2 to be returned; on a candidate, true indicates a match to input field.
`boolean`	`isMatchOnAreaName3()` In preferences, true indicates the candidate must match input area name 3 to be returned; on a candidate, true indicates a match to input field.
`boolean`	`isMatchOnAreaName4()` In preferences, true indicates the candidate must match input area name 4 to be returned; on a candidate, true indicates a match to input field.
`boolean`	`isMatchOnInputFields()` As input preference only, true indicates that any input supplied by user (house number, city name, postcode, etc) must match for a candidate to be returned; on a candidate, this is not applicable.
`boolean`	`isMatchOnPlaceName()` This only applies to a returned candidate, true indicates a match to input place name.
`boolean`	`isMatchOnPostCode1()` In preferences, true indicates the candidate must match input post code 1 to be returned; on a candidate, true indicates a match to input field.
`boolean`	`isMatchOnPostCode2()` This only applies to a returned candidate.
`boolean`	`isMatchOnStreetDirectional()` This only applies to a returned candidate, true indicates a match to input street directional.
`boolean`	`isMatchOnStreetName()` When applied to a returned candidate, true indicates a match to input street name.
`boolean`	`isMatchOnStreetType()` This only applies to a returned candidate, true indicates a match to input street type.
`boolean`	`isMatchOnUnitValue()`
`void`	`setMatchOnAddressNumber(boolean bMatch)` In preferences, true indicates the candidate must match input address number to be returned; on a candidate, true indicates a match to input field.
`void`	`setMatchOnAllStreetFields(boolean bMatch)` In preferences, true indicates the candidate must match any provided input street name, type, directional, prefix and suffix to be returned; on a candidate, true indicates a match to input street information.
`void`	`setMatchOnAreaName1(boolean bMatch)` In preferences, true indicates the candidate must match input area name 1 to be returned; on a candidate, true indicates a match to input field.
`void`	`setMatchOnAreaName2(boolean bMatch)` In preferences, true indicates the candidate must match input area name 2 to be returned; on a candidate, true indicates a match to input field.
`void`	`setMatchOnAreaName3(boolean bMatch)` In preferences, true indicates the candidate must match input area name 3 to be returned; on a candidate, true indicates a match to input field.
`void`	`setMatchOnAreaName4(boolean bMatch)` In preferences, true indicates the candidate must match input area name 4 to be returned; on a candidate, true indicates a match to input field.
`void`	`setMatchOnInputFields(boolean bMatch)` As input preference only, true indicates that any input supplied by user (house number, city name, postcode, etc) must match for a candidate to be returned; on a candidate, this is not applicable.
`void`	`setMatchOnPlaceName(boolean matchOnPlaceName)` This only applies to a returned candidate, true indicates a match to input place name.
`void`	`setMatchOnPostCode1(boolean bMatch)` In preferences, true indicates the candidate must match input post code 1 to be returned; on a candidate, true indicates a match to input field.
`void`	`setMatchOnPostCode2(boolean bMatch)` This only applies to a returned candidate.
`void`	`setMatchOnStreetDirectional(boolean bMatch)` This only applies to a returned candidate, true indicates a match to input street directional.
`void`	`setMatchOnStreetName(boolean bMatch)` This only applies to a returned candidate, true indicates a match to input street name.
`void`	`setMatchOnStreetType(boolean bMatch)` This only applies to a returned candidate, true indicates a match to input street type.
`void`	`setMatchOnUnitValue(boolean bMatch)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GeocodeMatchFields
```
public GeocodeMatchFields()
```
  - GeocodeMatchFields
```
public GeocodeMatchFields(FieldsMatching orig)
```
- Method Detail
  - isMatchOnAddressNumber
```
public boolean isMatchOnAddressNumber()
```
    Description copied from interface: FieldsMatching
    
    In preferences, true indicates the candidate must match address number to be returned; on a candidate, true indicates a match to input field.
    
    Specified by:
    
    isMatchOnAddressNumber in interface FieldsMatching
    
    Returns:
    
    true for matching on address number.
  - setMatchOnAddressNumber
```
public void setMatchOnAddressNumber(boolean bMatch)
```
    Description copied from interface: FieldsMatching
    
    In preferences, true indicates the candidate must match input address number to be returned; on a candidate, true indicates a match to input field.
    
    Specified by:
    
    setMatchOnAddressNumber in interface FieldsMatching
    
    Parameters:
    
    bMatch - true for matching
  - isMatchOnPostCode1
```
public boolean isMatchOnPostCode1()
```
    Description copied from interface: FieldsMatching
    
    In preferences, true indicates the candidate must match input post code 1 to be returned; on a candidate, true indicates a match to input field.
    
    Specified by:
    
    isMatchOnPostCode1 in interface FieldsMatching
    
    Returns:
    
    true for matching on post code 1.
  - setMatchOnPostCode1
```
public void setMatchOnPostCode1(boolean bMatch)
```
    Description copied from interface: FieldsMatching
    
    In preferences, true indicates the candidate must match input post code 1 to be returned; on a candidate, true indicates a match to input field.
    
    Specified by:
    
    setMatchOnPostCode1 in interface FieldsMatching
    
    Parameters:
    
    bMatch - true for matching
  - isMatchOnPostCode2
```
public boolean isMatchOnPostCode2()
```
    Description copied from interface: FieldsMatching
    
    This only applies to a returned candidate. True indicates a match to input field. In preferences, this has no effect.
    
    Specified by:
    
    isMatchOnPostCode2 in interface FieldsMatching
    
    Returns:
    
    true for a match on post code 2.
  - setMatchOnPostCode2
```
public void setMatchOnPostCode2(boolean bMatch)
```
    Description copied from interface: FieldsMatching
    
    This only applies to a returned candidate. True indicates a match to input field. In preferences, this has no effect.
    
    Specified by:
    
    setMatchOnPostCode2 in interface FieldsMatching
    
    Parameters:
    
    bMatch - true for a match on post code 2 input
  - isMatchOnAreaName1
```
public boolean isMatchOnAreaName1()
```
    Description copied from interface: FieldsMatching
    
    In preferences, true indicates the candidate must match input area name 1 to be returned; on a candidate, true indicates a match to input field.
    
    Specified by:
    
    isMatchOnAreaName1 in interface FieldsMatching
    
    Returns:
    
    true for matching on area name 1.
  - setMatchOnAreaName1
```
public void setMatchOnAreaName1(boolean bMatch)
```
    Description copied from interface: FieldsMatching
    
    In preferences, true indicates the candidate must match input area name 1 to be returned; on a candidate, true indicates a match to input field.
    
    Specified by:
    
    setMatchOnAreaName1 in interface FieldsMatching
    
    Parameters:
    
    bMatch - true for matching
  - isMatchOnAreaName2
```
public boolean isMatchOnAreaName2()
```
    Description copied from interface: FieldsMatching
    
    In preferences, true indicates the candidate must match input area name 2 to be returned; on a candidate, true indicates a match to input field.
    
    Specified by:
    
    isMatchOnAreaName2 in interface FieldsMatching
    
    Returns:
    
    true for matching on area name 2.
  - setMatchOnAreaName2
```
public void setMatchOnAreaName2(boolean bMatch)
```
    Description copied from interface: FieldsMatching
    
    In preferences, true indicates the candidate must match input area name 2 to be returned; on a candidate, true indicates a match to input field.
    
    Specified by:
    
    setMatchOnAreaName2 in interface FieldsMatching
    
    Parameters:
    
    bMatch - true for matching
  - isMatchOnAreaName3
```
public boolean isMatchOnAreaName3()
```
    Description copied from interface: FieldsMatching
    
    In preferences, true indicates the candidate must match input area name 3 to be returned; on a candidate, true indicates a match to input field.
    
    Specified by:
    
    isMatchOnAreaName3 in interface FieldsMatching
    
    Returns:
    
    true for matching on area name 3.
  - setMatchOnAreaName3
```
public void setMatchOnAreaName3(boolean bMatch)
```
    Description copied from interface: FieldsMatching
    
    In preferences, true indicates the candidate must match input area name 3 to be returned; on a candidate, true indicates a match to input field.
    
    Specified by:
    
    setMatchOnAreaName3 in interface FieldsMatching
    
    Parameters:
    
    bMatch - true for matching
  - isMatchOnAreaName4
```
public boolean isMatchOnAreaName4()
```
    Description copied from interface: FieldsMatching
    
    In preferences, true indicates the candidate must match input area name 4 to be returned; on a candidate, true indicates a match to input field.
    
    Specified by:
    
    isMatchOnAreaName4 in interface FieldsMatching
    
    Returns:
    
    true for matching on area name 4.
  - setMatchOnAreaName4
```
public void setMatchOnAreaName4(boolean bMatch)
```
    Description copied from interface: FieldsMatching
    
    In preferences, true indicates the candidate must match input area name 4 to be returned; on a candidate, true indicates a match to input field.
    
    Specified by:
    
    setMatchOnAreaName4 in interface FieldsMatching
    
    Parameters:
    
    bMatch - true for matching
  - isMatchOnAllStreetFields
```
public boolean isMatchOnAllStreetFields()
```
    Description copied from interface: FieldsMatching
    
    In preferences, true indicates the candidate must match any provided input street name, type, directional, prefix and suffix to be returned; on a candidate, true indicates a match to input street information.
    
    Specified by:
    
    isMatchOnAllStreetFields in interface FieldsMatching
    
    Returns:
    
    true for matching on street.
  - setMatchOnAllStreetFields
```
public void setMatchOnAllStreetFields(boolean bMatch)
```
    Description copied from interface: FieldsMatching
    
    In preferences, true indicates the candidate must match any provided input street name, type, directional, prefix and suffix to be returned; on a candidate, true indicates a match to input street information.
    
    Specified by:
    
    setMatchOnAllStreetFields in interface FieldsMatching
    
    Parameters:
    
    bMatch - true for matching
  - isMatchOnStreetName
```
public boolean isMatchOnStreetName()
```
    Description copied from interface: FieldsMatching
    
    When applied to a returned candidate, true indicates a match to input street name. Setting it in input preferences is the same as setting MatchOnAllStreetFields.
    
    Specified by:
    
    isMatchOnStreetName in interface FieldsMatching
    
    Returns:
    
    true for matching on street name.
  - setMatchOnStreetName
```
public void setMatchOnStreetName(boolean bMatch)
```
    Description copied from interface: FieldsMatching
    
    This only applies to a returned candidate, true indicates a match to input street name. Setting it in input preferences is the same as setting MatchOnAllStreetFields.
    
    Specified by:
    
    setMatchOnStreetName in interface FieldsMatching
    
    Parameters:
    
    bMatch - true for matching
  - isMatchOnStreetType
```
public boolean isMatchOnStreetType()
```
    Description copied from interface: FieldsMatching
    
    This only applies to a returned candidate, true indicates a match to input street type. Setting it in input preferences has no effect.
    
    Specified by:
    
    isMatchOnStreetType in interface FieldsMatching
    
    Returns:
    
    true for matching on street type.
  - setMatchOnStreetType
```
public void setMatchOnStreetType(boolean bMatch)
```
    Description copied from interface: FieldsMatching
    
    This only applies to a returned candidate, true indicates a match to input street type. Setting it in input preferences has no effect.
    
    Specified by:
    
    setMatchOnStreetType in interface FieldsMatching
    
    Parameters:
    
    bMatch - true for matching
  - isMatchOnStreetDirectional
```
public boolean isMatchOnStreetDirectional()
```
    Description copied from interface: FieldsMatching
    
    This only applies to a returned candidate, true indicates a match to input street directional. Setting it in input preferences has no effect.
    
    Specified by:
    
    isMatchOnStreetDirectional in interface FieldsMatching
    
    Returns:
    
    true for matching on street pre or post directional.
  - setMatchOnStreetDirectional
```
public void setMatchOnStreetDirectional(boolean bMatch)
```
    Description copied from interface: FieldsMatching
    
    This only applies to a returned candidate, true indicates a match to input street directional. Setting it in input preferences has no effect.
    
    Specified by:
    
    setMatchOnStreetDirectional in interface FieldsMatching
    
    Parameters:
    
    bMatch - true for matching
  - isMatchOnInputFields
```
public boolean isMatchOnInputFields()
```
    Description copied from interface: FieldsMatching
    
    As input preference only, true indicates that any input supplied by user (house number, city name, postcode, etc) must match for a candidate to be returned; on a candidate, this is not applicable.
    
    Specified by:
    
    isMatchOnInputFields in interface FieldsMatching
    
    Returns:
    
    true for requiring match on all input fields.
  - setMatchOnInputFields
```
public void setMatchOnInputFields(boolean bMatch)
```
    Description copied from interface: FieldsMatching
    
    As input preference only, true indicates that any input supplied by user (house number, city name, postcode, etc) must match for a candidate to be returned; on a candidate, this is not applicable.
    
    Specified by:
    
    setMatchOnInputFields in interface FieldsMatching
    
    Parameters:
    
    bMatch - set value to evaluate if input info matched returning candidate or not
  - isMatchOnPlaceName
```
public boolean isMatchOnPlaceName()
```
    Description copied from interface: FieldsMatching
    
    This only applies to a returned candidate, true indicates a match to input place name. Does not apply to input preference settings.
    
    Specified by:
    
    isMatchOnPlaceName in interface FieldsMatching
    
    Returns:
    
    true for matching on place name.
  - setMatchOnPlaceName
```
public void setMatchOnPlaceName(boolean matchOnPlaceName)
```
    Description copied from interface: FieldsMatching
    
    This only applies to a returned candidate, true indicates a match to input place name. Does not apply to input preference settings.
    
    Specified by:
    
    setMatchOnPlaceName in interface FieldsMatching
    
    Parameters:
    
    matchOnPlaceName - true for matching
  - isMatchOnUnitValue
```
public boolean isMatchOnUnitValue()
```
    Specified by:
    
    isMatchOnUnitValue in interface FieldsMatching
  - setMatchOnUnitValue
```
public void setMatchOnUnitValue(boolean bMatch)
```
    Specified by:
    
    setMatchOnUnitValue in interface FieldsMatching
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - convertToMap
```
public Map<String,Object> convertToMap()
```
    Convert this object to a "map of maps" where each map is Map<String, Object>
    
    Specified by:
    
    convertToMap in interface GeoSerialize
    
    Returns:
    
    a map of the properties in this class, one entry of which is a contained map containing a map of custom values
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class GeocodeMatchFields

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GeocodeMatchFields

GeocodeMatchFields

Method Detail

isMatchOnAddressNumber

setMatchOnAddressNumber

isMatchOnPostCode1

setMatchOnPostCode1

isMatchOnPostCode2

setMatchOnPostCode2

isMatchOnAreaName1

setMatchOnAreaName1

isMatchOnAreaName2

setMatchOnAreaName2

isMatchOnAreaName3

setMatchOnAreaName3

isMatchOnAreaName4

setMatchOnAreaName4

isMatchOnAllStreetFields

setMatchOnAllStreetFields

isMatchOnStreetName

setMatchOnStreetName

isMatchOnStreetType

setMatchOnStreetType

isMatchOnStreetDirectional

setMatchOnStreetDirectional

isMatchOnInputFields

setMatchOnInputFields

isMatchOnPlaceName

setMatchOnPlaceName

isMatchOnUnitValue

setMatchOnUnitValue

toString

convertToMap

equals

hashCode