com.mapinfo.geocode.api

Interface FieldsMatching

All Superinterfaces:

Serializable

All Known Implementing Classes:

GeocodeMatchFields

public interface FieldsMatching
extends Serializable

This class describes 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.

For use on input, the MatchMode must be set to "CUSTOM" for this object to define the must match values for the geocode. If a must match field has been defined (for example, addressNumber) that if that field on a candidate does not match the input field (where present) the candidate will not be returned.

Method Summary

Modifier and Type	Method and Description
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 bMatch) 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)

Method Detail

isMatchOnAddressNumber

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.

Returns:

true for matching on address number.

setMatchOnAddressNumber

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.

Parameters:

bMatch - true for matching

isMatchOnPostCode1

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.

Returns:

true for matching on post code 1.

setMatchOnPostCode1

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.

Parameters:

bMatch - true for matching

isMatchOnPostCode2

boolean isMatchOnPostCode2()

This only applies to a returned candidate. True indicates a match to input field. In preferences, this has no effect.

Returns:

true for a match on post code 2.

setMatchOnPostCode2

void setMatchOnPostCode2(boolean bMatch)

This only applies to a returned candidate. True indicates a match to input field. In preferences, this has no effect.

Parameters:

bMatch - true for a match on post code 2 input

isMatchOnAreaName1

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.

Returns:

true for matching on area name 1.

setMatchOnAreaName1

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.

Parameters:

bMatch - true for matching

isMatchOnAreaName2

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.

Returns:

true for matching on area name 2.

setMatchOnAreaName2

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.

Parameters:

bMatch - true for matching

isMatchOnAreaName3

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.

Returns:

true for matching on area name 3.

setMatchOnAreaName3

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.

Parameters:

bMatch - true for matching

isMatchOnAreaName4

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.

Returns:

true for matching on area name 4.

setMatchOnAreaName4

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.

Parameters:

bMatch - true for matching

isMatchOnAllStreetFields

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.

Returns:

true for matching on street.

setMatchOnAllStreetFields

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.

Parameters:

bMatch - true for matching

isMatchOnStreetName

boolean isMatchOnStreetName()

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.

Returns:

true for matching on street name.

setMatchOnStreetName

void setMatchOnStreetName(boolean bMatch)

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.

Parameters:

bMatch - true for matching

isMatchOnStreetType

boolean isMatchOnStreetType()

This only applies to a returned candidate, true indicates a match to input street type. Setting it in input preferences has no effect.

Returns:

true for matching on street type.

setMatchOnStreetType

void setMatchOnStreetType(boolean bMatch)

This only applies to a returned candidate, true indicates a match to input street type. Setting it in input preferences has no effect.

Parameters:

bMatch - true for matching

isMatchOnStreetDirectional

boolean isMatchOnStreetDirectional()

This only applies to a returned candidate, true indicates a match to input street directional. Setting it in input preferences has no effect.

Returns:

true for matching on street pre or post directional.

setMatchOnStreetDirectional

void setMatchOnStreetDirectional(boolean bMatch)

This only applies to a returned candidate, true indicates a match to input street directional. Setting it in input preferences has no effect.

Parameters:

bMatch - true for matching

isMatchOnPlaceName

boolean isMatchOnPlaceName()

This only applies to a returned candidate, true indicates a match to input place name. Does not apply to input preference settings.

Returns:

true for matching on place name.

setMatchOnPlaceName

void setMatchOnPlaceName(boolean bMatch)

This only applies to a returned candidate, true indicates a match to input place name. Does not apply to input preference settings.

Parameters:

bMatch - true for matching

isMatchOnInputFields

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.

Returns:

true for requiring match on all input fields.

setMatchOnInputFields

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.

Parameters:

bMatch - set value to evaluate if input info matched returning candidate or not

isMatchOnUnitValue

boolean isMatchOnUnitValue()

setMatchOnUnitValue

void setMatchOnUnitValue(boolean bMatch)