com.mapquest
Class IdentifyCriteria

java.lang.Object
  extended bycom.mapquest.MQObject
      extended bycom.mapquest.IdentifyCriteria
All Implemented Interfaces:
java.lang.Cloneable

public class IdentifyCriteria
extends MQObject

Finds a list of features which are near a specified location.

See Also:
Point

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
IdentifyCriteria()
          Default constructor.
 
Method Summary
 boolean equals(java.lang.Object otherObject)
          Compares this object to the specified object.
 Point getCenter()
          Returns the X and Y coordinates of the point at which the mouse was clicked (as stored in this object).
 int getClassId()
          Returns the numeric id of this class.
 java.lang.String getClassName()
          Returns the text name of this class.
 int getMaxMatches()
          Returns the current value of this object which indicates the maximum number of features to return.
 int getRadius()
          Returns the current value of this object which indicates the radius within which to search (in pixels).
 int hashCode()
          Returns a hash code for this IdentifyCriteria.
 void init()
          Initializes object.
 void setCenter(Point pnt)
          Sets the point at which the mouse was clicked.
 void setMaxMatches(int nMatches)
          Sets the data member of this object which indicates the maximum number of features to return.
 void setRadius(int nRad)
          Sets the search radius (in pixels).
 
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

IdentifyCriteria

public IdentifyCriteria()
Default constructor.

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.

setCenter

public void setCenter(Point pnt)
Sets the point at which the mouse was clicked.

Parameters:
pnt - The point at which the mouse was clicked (as stored in this object).

setRadius

public void setRadius(int nRad)
Sets the search radius (in pixels).

Parameters:
nRad - The radius within which to search (in pixels).

setMaxMatches

public void setMaxMatches(int nMatches)
Sets the data member of this object which indicates the maximum number of features to return.

Parameters:
nMatches - The maximum number of features which are to be returned.

getCenter

public Point getCenter()
Returns the X and Y coordinates of the point at which the mouse was clicked (as stored in this object).

Returns:
The point at which the mouse was clicked (as stored in this object).

getRadius

public int getRadius()
Returns the current value of this object which indicates the radius within which to search (in pixels).

Returns:
The current value of this object which indicates the radius within which to search (in pixels).

getMaxMatches

public int getMaxMatches()
Returns the current value of this object which indicates the maximum number of features to return.

Returns:
The current value of this object which indicates the maximum number of features to return.

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

Overrides:
equals in class MQObject
Parameters:
otherObject - the object to compare this IdentifyCriteria against.
Returns:
true if the IdentifyCriteria objects are equal; false otherwise.

hashCode

public int hashCode()
Returns a hash code for this IdentifyCriteria.

Overrides:
hashCode in class MQObject
Returns:
a hash code value for this IdentifyCriteria.