com.mapquest
Class GeocodeOptions

java.lang.Object
  com.mapquest.MQObject
      com.mapquest.GeocodeOptions

All Implemented Interfaces:

java.lang.Cloneable

public class GeocodeOptions

extends MQObject

Class for specifying geocode parameters.

See Also:

MatchType, QualityType

Field Summary

static int	CLASS_ID
static java.lang.String	CLASS_NAME

Fields inherited from class com.mapquest.MQObject

DEFAULT_ID, DEFAULT_NAME, DEFAULT_VERSION, FORMAT_NUMERIC_ID, FORMAT_TEXT_NAME, INVALID_ID, INVALID_NAME, INVALID_VERSION

Constructor Summary

GeocodeOptions()
Default constructor.

GeocodeOptions(QualityType qt, long mm, MatchType mt)
Constructor used to initialize the members.

GeocodeOptions(QualityType qt, long mm, MatchType mt, java.lang.String cn)
Constructor used to initialize the members.

Method Summary

boolean	equals(java.lang.Object otherObject) Compares this object to the specified object.
int	getClassId() Returns the numeric id of this class.
java.lang.String	getClassName() Returns the text name of this class.
java.lang.String	getCoverageName() Gets the name of the coverage that this option applies to
MatchType	getMatchType() Gets the MatchType for this object.
long	getMaxMatches() Gets the maximum matches to be returned for this object.
QualityType	getQualityType() Gets the QualityType set for this object.
int	hashCode() Returns a hash code for this GeocodeOptions.
void	init() Initializes object.
void	setCoverageName(java.lang.String covName) Sets the name of the coverage that this option applies to
void	setMatchType(MatchType lMatchType) Sets the MatchType for this object.
void	setMaxMatches(long lMaxMatches) Sets the maximum matches to be returned for this object.
void	setQualityType(QualityType lQualityType) Sets the QualityType set for this object.

Methods inherited from class com.mapquest.MQObject

clone, getFormat, getIdWithVersion, getNameWithVersion, getObjectVersion, getTypeId, getTypeName, getVerboseConsoleOutput, setFormat, setObjectVersion, setVerboseConsoleOutput, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_ID

public static final int CLASS_ID

See Also:

Constant Field Values

CLASS_NAME

public static final java.lang.String CLASS_NAME

See Also:

Constant Field Values

Constructor Detail

GeocodeOptions

public GeocodeOptions()

Default constructor.

GeocodeOptions

public GeocodeOptions(QualityType qt,
                      long mm,
                      MatchType mt)

Constructor used to initialize the members.

GeocodeOptions

public GeocodeOptions(QualityType qt,
                      long mm,
                      MatchType mt,
                      java.lang.String cn)

Constructor used to initialize the members.

Method Detail

init

public void init()

Initializes object.

Overrides:

init in class MQObject

getClassId

public int getClassId()

Returns the numeric id of this class.

Overrides:

getClassId in class MQObject

Returns:

the numeric id of this class.

getClassName

public java.lang.String getClassName()

Returns the text name of this class.

Overrides:

getClassName in class MQObject

Returns:

the text name of this class.

getQualityType

public QualityType getQualityType()

Gets the QualityType set for this object.

Returns:

QualityType for this object

setQualityType

public void setQualityType(QualityType lQualityType)

Sets the QualityType set for this object. Default = QualityType.QT_APPROX;

Parameters:

lQualityType - QualityType for this object.

getMaxMatches

public long getMaxMatches()

Gets the maximum matches to be returned for this object.

Returns:

long max matches for this object

setMaxMatches

public void setMaxMatches(long lMaxMatches)

Sets the maximum matches to be returned for this object. Default = 1

Parameters:

lMaxMatches - max matches for this object

getMatchType

public MatchType getMatchType()

Gets the MatchType for this object.

Returns:

long MatchType for this object

setMatchType

public void setMatchType(MatchType lMatchType)

Sets the MatchType for this object. Default = 0;

Parameters:

lMatchType - MatchType for this object

getCoverageName

public java.lang.String getCoverageName()

Gets the name of the coverage that this option applies to

Returns:

The name of the coverage that these options apply to

setCoverageName

public void setCoverageName(java.lang.String covName)

Sets the name of the coverage that this option applies to

Parameters:

covName - The name of the coverage

equals

public boolean equals(java.lang.Object otherObject)

Compares this object to the specified object. The result is true if and only if the argument is not null and is a GeocodeOptions object that has same attributes as this object.

Overrides:

equals in class MQObject

Parameters:

otherObject - the object to compare this GeocodeOptions against.

Returns:

true if the GeocodeOptions objects are equal; false otherwise.

hashCode

public int hashCode()

Returns a hash code for this GeocodeOptions.

Overrides:

hashCode in class MQObject

Returns:

a hash code value for this GeocodeOptions.