com.mapinfo.geocode.api

Interface ReturnFieldsDescriptor

All Superinterfaces:

Serializable

All Known Implementing Classes:

ReturnFields

public interface ReturnFieldsDescriptor
extends Serializable

This interface allows users to opt out of returning information on a geocoded candidate. Returning less information will improve performance by not requiring the server to pass back fields that are not needed

Method Summary

Modifier and Type	Method and Description
Set<String>	getKeysOfCustomFieldsToReturn() This set contains the keys of what fields in a candidate's custom values should be returned.
boolean	isReturnAllCustomFields() If this is true, all information in the candidates custom fields will be returned
boolean	isReturnMatchDescriptor() If this is true, the information on what candidates fields matched the input will be returned
boolean	isReturnStreetAddressFields() If this is true, the individual street address fields: address number, street name, thoroughfare type, pre and post directionals, and street prefix and suffix will be returned if available.
boolean	isReturnUnitInformation() If this is true, the unit information attached to a candidate will be returned when available.
void	setKeysOfCustomFieldsToReturn(Set<String> keys) Define the set containing the keys of what fields in a candidate's custom values should be returned.
void	setReturnAllCustomFields(boolean bReturn) Sets whether or not the information on what candidates fields matched the input will be returned
void	setReturnMatchDescriptor(boolean bReturn) Sets whether or not all information in the candidates custom fields will be returned
void	setReturnStreetAddressFields(boolean bReturn) Sets whether or not the individual street address fields: address number, street name, thoroughfare type, pre and post directionals, and street prefix and suffix will be returned if available.
void	setReturnUnitInformation(boolean bReturn) Sets whether or not the unit information attached to a candidate will be returned when available.

Method Detail

isReturnAllCustomFields

boolean isReturnAllCustomFields()

If this is true, all information in the candidates custom fields will be returned

Returns:

true if all custom field information should be returned

setReturnAllCustomFields

void setReturnAllCustomFields(boolean bReturn)

Sets whether or not the information on what candidates fields matched the input will be returned

Parameters:

bReturn - true if candidate match information should be returned

getKeysOfCustomFieldsToReturn

Set<String> getKeysOfCustomFieldsToReturn()

This set contains the keys of what fields in a candidate's custom values should be returned. If "isReturnAllCustomFields" is true, all custom values are returned, but if it is false, only those custom values with keys listed in this set will be returned. If set is empty no custom values are returned.

Returns:

the set of custom field keys

setKeysOfCustomFieldsToReturn

void setKeysOfCustomFieldsToReturn(Set<String> keys)

Define the set containing the keys of what fields in a candidate's custom values should be returned. If "isReturnAllCustomFields" is true, all custom values are returned, but if it is false, only those custom values with keys listed in this set will be returned. If set is empty no custom values will be returned.

Parameters:

keys - lists the keys for custom values to be returned with the candidate.

isReturnMatchDescriptor

boolean isReturnMatchDescriptor()

If this is true, the information on what candidates fields matched the input will be returned

Returns:

true if candidate match information should be returned

setReturnMatchDescriptor

void setReturnMatchDescriptor(boolean bReturn)

Sets whether or not all information in the candidates custom fields will be returned

Parameters:

bReturn - true if all custom field information should be returned

isReturnStreetAddressFields

boolean isReturnStreetAddressFields()

If this is true, the individual street address fields: address number, street name, thoroughfare type, pre and post directionals, and street prefix and suffix will be returned if available. If this information is not returned, the formatted street information will still be available as a single string in the candidates MainAddressLine field

Returns:

true if individual street fields should be returned

setReturnStreetAddressFields

void setReturnStreetAddressFields(boolean bReturn)

Sets whether or not the individual street address fields: address number, street name, thoroughfare type, pre and post directionals, and street prefix and suffix will be returned if available. If this information is not returned, the formatted street information will still be available as a single string in the candidates MainAddressLine field

Parameters:

bReturn - true if individual street fields should be returned

isReturnUnitInformation

boolean isReturnUnitInformation()

If this is true, the unit information attached to a candidate will be returned when available.

Returns:

true candidate unit type and value should be returned

setReturnUnitInformation

void setReturnUnitInformation(boolean bReturn)

Sets whether or not the unit information attached to a candidate will be returned when available.

Parameters:

bReturn - true if candidate unit type and value should be returned