com.mapquest
Class SearchCriteria

java.lang.Object
  com.mapquest.MQObject
      com.mapquest.SearchCriteria

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

CorridorSearchCriteria, PolySearchCriteria, RadiusSearchCriteria, RectSearchCriteria

public abstract class SearchCriteria

extends MQObject

Base class to define the criteria for a search. This class is not directly instantiateable. Use one of its child classes instead.

Field Summary

Fields inherited from class com.mapquest.MQObject

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

Method Summary

boolean	equals(java.lang.Object otherObject) Compares this object to the specified object.
int	getMaxMatches() Gets the data member of this object which indicates the maximum number of matches that are to be returned by the search.
int	hashCode() Returns a hash code for this SearchCriteria.
void	init() Initializes object.
void	setMaxMatches(int nMax) Sets the data member of this object which indicates the maximum number of matches that are to be returned by the search.

Methods inherited from class com.mapquest.MQObject

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

init

public void init()

Initializes object.

Overrides:

init in class MQObject

setMaxMatches

public void setMaxMatches(int nMax)

Sets the data member of this object which indicates the maximum number of matches that are to be returned by the search.

Parameters:

nMax - The maximum number of matches that are to be returned by the search.

getMaxMatches

public int getMaxMatches()

Gets the data member of this object which indicates the maximum number of matches that are to be returned by the search.

Returns:

int The maximum number of matches that are to be returned by the search.

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 SearchCriteria object that has same attributes as this object.

Overrides:

equals in class MQObject

Parameters:

otherObject - the object to compare this SearchCriteria against.

Returns:

true if the SearchCriteria objects are equal; false otherwise.

hashCode

public int hashCode()

Returns a hash code for this SearchCriteria.

Overrides:

hashCode in class MQObject

Returns:

a hash code value for this SearchCriteria.