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

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

All Implemented Interfaces:

Serializable

public class AddressMatchResults
extends Object
implements Serializable

Contains a collection of geocoded Result objects. Result objects can be returned or cleared from the collection.

See Also:

Serialized Form

Constructor Summary

AddressMatchResults()
Constructs an instance of an AddressMatchResults object.

Method Summary

boolean	addResult(Result object) Adds a Result object to the AddressMatchResults collection.
void	clear() Clears all Result objects from the AddressMatchResults collection.
int	getCount() Returns the count of all Result objects in the AddressMatchResults collection.
Result	getResult(int index) Returns the Result object at given index from the AddressMatchResults collection.
Vector	getResultsCollection() Returns the Result object associated with this AddressMatchResults collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

AddressMatchResults

public AddressMatchResults()

Constructs an instance of an AddressMatchResults object. Example:

AddressMatchResults addressMatchResults = new AddressMatchResults();

Method Detail

getCount

public int getCount()

Returns the count of all Result objects in the AddressMatchResults collection. Example:

int resultsCount = addressMatchResults.getCount();

Returns:

the count of Results objects as integer.

getResult

public Result getResult(int index)

Returns the Result object at given index from the AddressMatchResults collection. Example:

Result result = addressMatchResults.getResult(0);

Parameters:

index - the item to return.

Returns:

the Result object at given index.

See Also:

addResult(com.esri.aims.mtier.model.map.layer.geocode.Result)

addResult

public boolean addResult(Result object)

Adds a Result object to the AddressMatchResults collection. Example:

 Result result = new Result();
 addressMatchResults.addResult(result);
 

Parameters:

object - the Result object.

Returns:

a boolean value.

See Also:

getResult(int)

getResultsCollection

public Vector getResultsCollection()

Returns the Result object associated with this AddressMatchResults collection. Example:

 java.util.Vector mResultsCollection = addressMatchResults.getResultsCollection();
 

Returns:

a Result object as Vector.

clear

public void clear()

Clears all Result objects from the AddressMatchResults collection. Example:

addressMatchResults.clear();