com.esri.aims.mtier.model.map.layer.geocode
Class AddressMatchInputs

java.lang.Object
  com.esri.aims.mtier.model.map.layer.geocode.AddressMatchInputs

All Implemented Interfaces:

Serializable

public class AddressMatchInputs
extends Object
implements Serializable

This class is used to add address values that are in turn used to process geocoding against. After geocode is processed, the results can be accessed with the getAddressMatchResults method.

This class supports geocoding styles, types, and labels.

See Also:

Serialized Form

Field Summary

static String	DECIMAL_DEGREES
static String	FEET
static String	METERS

Constructor Summary

AddressMatchInputs()
Constructs an instance of an AddressMatchInputs object.

Method Summary

boolean	addDescription(String value) Adds this AddressMatchInputs description field to the description collection.
boolean	addID(String value) Sets the given ID for this AddressMatchInputs object.
boolean	addLabel(String value) Adds the given geocode label field to the labels collection.
boolean	addType(String value) Adds the given AddressMatchInputs type field to the type collection.
boolean	addValues(String value) Sets the given input values to this AddressMatchInputs object, which is based on the ArcXML geocoding inputs.
boolean	addWidth(String value) Adds the given AddressMatchInputs width field to the width collection.
void	clear() Clears the values collection associated with this AddressMatchInputs object.
AddressMatchResults	getAddressMatchResults() Returns the AddressMatchResults object associated with this AddressMatchInputs object.
String	getDescription() Returns the AddressMatchInputs description field by current location.
double	getEndOffset() Returns the end offset geocoding style used for a layer.
FeatureCoordSys	getFeatureCoordSys() Returns the FeatureCoordSys object associated with this AddressMatchInputs object.
String	getID() Returns the object ID based on the current location in collection.
String	getLabel() Returns the geocoding label associated with this AddressMatchInputs object.
long	getMaxCandidates() Returns the maximum number of result candidates value.
long	getMinScore() Returns the minimum geocode scoring value.
double	getSideOffset() Returns the side offset for geocoded features.
String	getSideOffsetUnits() Returns the side offset units.
int	getSpellingSensitivity() Returns the spelling sensitivity value.
String	getStyle() Returns the geocoding style associated with this AddressMatchInputs object.
String	getType() Returns the type field associated with this AddressMatchInputs object.
String	getValue() Returns the values associated with this AddressMatchInputs object from the values collection at the current index location.
int	getValuesCount() Returns the count of all values in the collection.
String	getWidth() Returns this AddressMatchInputs width field from the width collection.
boolean	moveFirst() Moves to the first input in the AddressMatchInputs object.
boolean	moveLast() Moves to the last input in the AddressMatchInputs object.
boolean	moveNext() Moves onto the next input to the AddressMatchInputs object.
boolean	movePrevious() Moves to the previous input in the AddressMatchInputs object.
void	setAddressMatchResults(AddressMatchResults object) Sets the given AddressMatchResults object to this AddressMatchInputs object.
void	setEndOffset(double value)
void	setFeatureCoordSys(FeatureCoordSys obj) Sets the given FeatureCoordSys object to this AddressMatchInputs object.
void	setMaxCandidates(long value) Sets the maximum number of result candidates to be returned.
void	setMinScore(long value) Sets the minimum geocode scoring value.
void	setSideOffset(double value)
void	setSideOffsetUnits(String value)
void	setSpellingSensitivity(int value) Controls how much variation the geocoding service allows when it searches for likely candidates in the reference data.
void	setStyle(String value) Sets the geocoding style to be used.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DECIMAL_DEGREES

public static final String DECIMAL_DEGREES

See Also:

Constant Field Values

FEET

public static final String FEET

See Also:

Constant Field Values

METERS

public static final String METERS

See Also:

Constant Field Values

Constructor Detail

AddressMatchInputs

public AddressMatchInputs()

Constructs an instance of an AddressMatchInputs object.

AddressMatchInputs addressMatchInputs = new AddressMatchInputs();

Method Detail

addID

public boolean addID(String value)

Sets the given ID for this AddressMatchInputs object. Returns True, if successful. Example:

addressMatchInputs.setID("AddMatchInputs-1");

Parameters:

value - the ID string.

Returns:

a boolean value - True if successful, False otherwise.

See Also:

getID()

getID

public String getID()

Returns the object ID based on the current location in collection. Example:

String id = addressMatchInputs.getID();

Returns:

the object ID as string

See Also:

addID(java.lang.String)

addValues

public boolean addValues(String value)

Sets the given input values to this AddressMatchInputs object, which is based on the ArcXML geocoding inputs. Example:

addressMatchInputs.addValues("195 South Center");

Parameters:

value - the input string.

Returns:

boolean

See Also:

getValue()

getValue

public String getValue()

Returns the values associated with this AddressMatchInputs object from the values collection at the current index location. Example:

String value = addressMatchInputs.getValue();

Returns:

the value string.

getValuesCount

public int getValuesCount()

Returns the count of all values in the collection. Example:

int count = addressMatchInputs.getValuesCount();

Returns:

integer

setStyle

public void setStyle(String value)

Sets the geocoding style to be used. The styles coincides with the ArcXML geocoding styles. Example:

Gets set by the response from the ArcIMS Application Server.

Parameters:

value - the style to be used.

See Also:

getStyle()

getStyle

public String getStyle()

Returns the geocoding style associated with this AddressMatchInputs object. ArcIMS supports 10 standard address styles. They are:

USAddressZ - U.S. streets with zone.

USAddress - U.S. streets.

USSingleRangeZ - U.S. single range with zone.

USSingleRange - U.S. single range.

USSingleHouseZ - U.S. single house with zone.

USSingleHouse - U.S. single house.

Zip4 - Used for geocoding Zip+4 using two components (Zip and Zip4).

Zip4Range - Used for geocoding Zip+4 using three components (Zip, Zip4Low and Zip4High).

Zip5 - This style is used for geocoding five-digit Zip code addresses.

SingleField - Used for geocoding based on the value of a single field in the reference layer's attribute table.

Refer to the ArcXML Programmer's Reference Guide for more information.

Returns:

the geocoding style as string

See Also:

setStyle(java.lang.String)

setAddressMatchResults

public void setAddressMatchResults(AddressMatchResults object)

Sets the given AddressMatchResults object to this AddressMatchInputs object. Example:

String style = addressMatchInputs.getStyle();

Parameters:

object - the AddressMatchResults object.

See Also:

getAddressMatchResults()

getAddressMatchResults

public AddressMatchResults getAddressMatchResults()

Returns the AddressMatchResults object associated with this AddressMatchInputs object. Example:

addressMatchInputs.getAddressMatchResults().getCount();

Returns:

AddressMatchResults

See Also:

setAddressMatchResults(com.esri.aims.mtier.model.map.layer.geocode.AddressMatchResults)

clear

public void clear()

Clears the values collection associated with this AddressMatchInputs object. Example:

addressMatchInputs.clear();

addLabel

public boolean addLabel(String value)

Adds the given geocode label field to the labels collection. Example:

Gets set by the response from the ArcIMS Application Server.

Parameters:

value - the geocode label field.

Returns:

a boolean value.

See Also:

getLabel()

getLabel

public String getLabel()

Returns the geocoding label associated with this AddressMatchInputs object. Example:

String label = addressMatchInputs.getLabel();

Returns:

String

See Also:

addLabel(java.lang.String)

addDescription

public boolean addDescription(String value)

Adds this AddressMatchInputs description field to the description collection. Example:

Descriptions are added by the response from the ArcIMS Application Server.

Parameters:

value - the geocode description field.

Returns:

boolean

See Also:

getDescription()

getDescription

public String getDescription()

Returns the AddressMatchInputs description field by current location. Example:

String description = addressMatchInputs.getDescription();

Returns:

the description field as string

See Also:

addDescription(java.lang.String)

addType

public boolean addType(String value)

Adds the given AddressMatchInputs type field to the type collection. Example:

Types added by the response from the ArcIMS Application Server.

Parameters:

value - the geocode type field.

Returns:

a boolean value.

See Also:

getType()

getType

public String getType()

Returns the type field associated with this AddressMatchInputs object. Example:

String type = addressMatchInputs.getType();

Returns:

the AddressMatchInputs type field as string

See Also:

addType(java.lang.String)

addWidth

public boolean addWidth(String value)

Adds the given AddressMatchInputs width field to the width collection. Widths are added by the response from the ArcIMS Application Server.

Parameters:

value - the geocode width field.

Returns:

a boolean value

See Also:

getWidth()

getWidth

public String getWidth()

Returns this AddressMatchInputs width field from the width collection. Example:

String width = addressMatchInputs.getWidth();

Returns:

the width value as string

See Also:

addWidth(java.lang.String)

moveNext

public boolean moveNext()

Moves onto the next input to the AddressMatchInputs object. Returns True, if successful. Example:

addressMatchInputs.moveNext();

Returns:

a boolean value.

See Also:

movePrevious(), moveLast(), moveFirst()

moveFirst

public boolean moveFirst()

Moves to the first input in the AddressMatchInputs object. Returns True, if successful. Example:

addressMatchInputs.moveFirst();

Returns:

a boolean value.

See Also:

moveLast(), moveNext(), movePrevious()

moveLast

public boolean moveLast()

Moves to the last input in the AddressMatchInputs object. Returns True, if successful. Example:

addressMatchInputs.moveLast();

Returns:

a boolean value.

See Also:

moveFirst(), movePrevious(), moveNext()

movePrevious

public boolean movePrevious()

Moves to the previous input in the AddressMatchInputs object. Returns True, if successful. Example:

addressMatchInputs.movePrevious();

Returns:

boolean

See Also:

moveLast(), moveFirst(), moveNext()

setMaxCandidates

public void setMaxCandidates(long value)

Sets the maximum number of result candidates to be returned.

addressMatchInputs.setMaxCandidates(6);

Parameters:

value - the maximum number of result candidates.

See Also:

getMaxCandidates()

getMaxCandidates

public long getMaxCandidates()

Returns the maximum number of result candidates value. Example:

long candidates = addressMatchInputs.getMaxCandidates();

Returns:

the maximum number of result candidates value as long.

See Also:

setMaxCandidates(long)

setMinScore

public void setMinScore(long value)

Sets the minimum geocode scoring value. Example:

addressMatchInputs.setMinScore(65);

Parameters:

value - the minimum score value.

See Also:

getMinScore()

getMinScore

public long getMinScore()

Returns the minimum geocode scoring value. Example:

long score = addressMatchInputs.getMinScore();

Returns:

the minimum geocode score value as long.

See Also:

setMinScore(long)

setFeatureCoordSys

public void setFeatureCoordSys(FeatureCoordSys obj)

Sets the given FeatureCoordSys object to this AddressMatchInputs object. Example:

 FeatureCoordSys featureCoordSys = new FeatureCoordSys();
 featureCoordSys.setID(4326);
 addressMatchInputs.setFeatureCoordSys(featureCoordSys);
 

Parameters:

obj - the FeatureCoordSys object to associate.

getFeatureCoordSys

public FeatureCoordSys getFeatureCoordSys()

Returns the FeatureCoordSys object associated with this AddressMatchInputs object. Example:

FeatureCoordSys featureCoordSys = addressMatchInputs.getFeatureCoordSys();

Returns:

FeatureCoordSys;

getSpellingSensitivity

public int getSpellingSensitivity()

Returns the spelling sensitivity value.

Returns:

int - the spelling sensitivity value

setSpellingSensitivity

public void setSpellingSensitivity(int value)

Controls how much variation the geocoding service allows when it searches for likely candidates in the reference data.

Parameters:

value - the spelling sensitivity value

getEndOffset

public double getEndOffset()

Returns the end offset geocoding style used for a layer.

Returns:

double - the end offset geocoding style used for a layer

getSideOffset

public double getSideOffset()

Returns the side offset for geocoded features.

Returns:

double - the side offset for geocoded features

getSideOffsetUnits

public String getSideOffsetUnits()

Returns the side offset units.

Returns:

String - the side offset units

setSideOffsetUnits

public void setSideOffsetUnits(String value)

setSideOffset

public void setSideOffset(double value)

setEndOffset

public void setEndOffset(double value)