ReturnFields (geocodingservices - geocoding-api 5.1.796 API)

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

All Implemented Interfaces:

ReturnFieldsDescriptor, Serializable
```
public class ReturnFields
extends Object
implements ReturnFieldsDescriptor
```
This class implements ReturnFieldsDescriptor. Its purpose is to allow users to opt of of returning information they do not need

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ReturnFields()
Creates a new, empty ReturnFields object

ReturnFields(ReturnFieldsDescriptor descriptor)
Copy constructor

Constructors
Constructor and Description
`ReturnFields()` Creates a new, empty ReturnFields object
`ReturnFields(ReturnFieldsDescriptor descriptor)` Copy constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Set<String>`	`getKeysOfCustomFieldsToReturn()` This set contains the keys of what fields in a candidate's custom values should be returned.
`int`	`hashCode()`
`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.
`String`	`toString()`

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

- Constructor Detail
  - ReturnFields
```
public ReturnFields()
```
    Creates a new, empty ReturnFields object
  - ReturnFields
```
public ReturnFields(ReturnFieldsDescriptor descriptor)
```
    Copy constructor
    
    Parameters:
    
    descriptor - object to copy values from
- Method Detail
  - isReturnAllCustomFields
```
public boolean isReturnAllCustomFields()
```
    Description copied from interface: ReturnFieldsDescriptor
    
    If this is true, all information in the candidates custom fields will be returned
    
    Specified by:
    
    isReturnAllCustomFields in interface ReturnFieldsDescriptor
    
    Returns:
    
    true if all custom field information should be returned
  - setReturnAllCustomFields
```
public void setReturnAllCustomFields(boolean bReturn)
```
    Description copied from interface: ReturnFieldsDescriptor
    
    Sets whether or not the information on what candidates fields matched the input will be returned
    
    Specified by:
    
    setReturnAllCustomFields in interface ReturnFieldsDescriptor
    
    Parameters:
    
    bReturn - true if candidate match information should be returned
  - getKeysOfCustomFieldsToReturn
```
public Set<String> getKeysOfCustomFieldsToReturn()
```
    Description copied from interface: ReturnFieldsDescriptor
    
    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.
    
    Specified by:
    
    getKeysOfCustomFieldsToReturn in interface ReturnFieldsDescriptor
    
    Returns:
    
    the set of custom field keys
  - setKeysOfCustomFieldsToReturn
```
public void setKeysOfCustomFieldsToReturn(Set<String> keys)
```
    Description copied from interface: ReturnFieldsDescriptor
    
    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.
    
    Specified by:
    
    setKeysOfCustomFieldsToReturn in interface ReturnFieldsDescriptor
    
    Parameters:
    
    keys - lists the keys for custom values to be returned with the candidate.
  - isReturnMatchDescriptor
```
public boolean isReturnMatchDescriptor()
```
    Description copied from interface: ReturnFieldsDescriptor
    
    If this is true, the information on what candidates fields matched the input will be returned
    
    Specified by:
    
    isReturnMatchDescriptor in interface ReturnFieldsDescriptor
    
    Returns:
    
    true if candidate match information should be returned
  - setReturnMatchDescriptor
```
public void setReturnMatchDescriptor(boolean bReturn)
```
    Description copied from interface: ReturnFieldsDescriptor
    
    Sets whether or not all information in the candidates custom fields will be returned
    
    Specified by:
    
    setReturnMatchDescriptor in interface ReturnFieldsDescriptor
    
    Parameters:
    
    bReturn - true if all custom field information should be returned
  - isReturnStreetAddressFields
```
public boolean isReturnStreetAddressFields()
```
    Description copied from interface: ReturnFieldsDescriptor
    
    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
    
    Specified by:
    
    isReturnStreetAddressFields in interface ReturnFieldsDescriptor
    
    Returns:
    
    true if individual street fields should be returned
  - setReturnStreetAddressFields
```
public void setReturnStreetAddressFields(boolean bReturn)
```
    Description copied from interface: ReturnFieldsDescriptor
    
    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
    
    Specified by:
    
    setReturnStreetAddressFields in interface ReturnFieldsDescriptor
    
    Parameters:
    
    bReturn - true if individual street fields should be returned
  - isReturnUnitInformation
```
public boolean isReturnUnitInformation()
```
    Description copied from interface: ReturnFieldsDescriptor
    
    If this is true, the unit information attached to a candidate will be returned when available.
    
    Specified by:
    
    isReturnUnitInformation in interface ReturnFieldsDescriptor
    
    Returns:
    
    true candidate unit type and value should be returned
  - setReturnUnitInformation
```
public void setReturnUnitInformation(boolean bReturn)
```
    Description copied from interface: ReturnFieldsDescriptor
    
    Sets whether or not the unit information attached to a candidate will be returned when available.
    
    Specified by:
    
    setReturnUnitInformation in interface ReturnFieldsDescriptor
    
    Parameters:
    
    bReturn - true if candidate unit type and value should be returned
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ReturnFields

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReturnFields

ReturnFields

Method Detail

isReturnAllCustomFields

setReturnAllCustomFields

getKeysOfCustomFieldsToReturn

setKeysOfCustomFieldsToReturn

isReturnMatchDescriptor

setReturnMatchDescriptor

isReturnStreetAddressFields

setReturnStreetAddressFields

isReturnUnitInformation

setReturnUnitInformation

toString

equals

hashCode