com.esri.arcgis.arcweb
Class ArcWebLocation

java.lang.Object
  extended by com.esri.arcgis.arcweb.ArcWebLocation
All Implemented Interfaces:
IArcWebLocation, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ArcWebLocation
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebLocation

A complete description of a place that matches the search criteria.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:
Serialized Form

Constructor Summary
ArcWebLocation(Object obj)
          Construct a ArcWebLocation using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 IArcWebAddress getAddress()
          The address or intersection of the place.
 String getDescription1()
          The scrubbed address (e.g., 380 New York St.
 String getDescription2()
          The short description of the place (e.g., Redlands).
 IEnvelope getEnvelope()
          The bounding extent of the place.
 String getPlaceType()
          A letter indicating the type of place.
 IPoint getPoint()
          The x,y coordinates and the coordinate system of the place.
 double getScore()
          A number from 1 to 20 indicating the likelihood of a match to the place, with 1 being the most likely and 20 being the least likely.
 int hashCode()
          the hashcode for this object
 void setAddress(IArcWebAddress address)
          The address or intersection of the place.
 void setDescription1(String pVal)
          The scrubbed address (e.g., 380 New York St.
 void setDescription2(String pVal)
          The short description of the place (e.g., Redlands).
 void setEnvelopeByRef(IEnvelope pVal)
          The bounding extent of the place.
 void setPlaceType(String pVal)
          A letter indicating the type of place.
 void setPointByRef(IPoint pVal)
          The x,y coordinates and the coordinate system of the place.
 void setScore(double pVal)
          A number from 1 to 20 indicating the likelihood of a match to the place, with 1 being the most likely and 20 being the least likely.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

ArcWebLocation

public ArcWebLocation(Object obj)
               throws IOException
Construct a ArcWebLocation using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArcWebLocation.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ArcWebLocation o = (ArcWebLocation)obj; // will not work

ArcWebLocation o = new ArcWebLocation(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
IOException - if there are interop problems ArcWebLocation theArcWebLocation = (ArcWebLocation) obj;
Method Detail

equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getAddress

public IArcWebAddress getAddress()
                          throws IOException,
                                 AutomationException
The address or intersection of the place.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getAddress in interface IArcWebLocation
Returns:
A reference to a com.esri.arcgis.arcweb.IArcWebAddress
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAddress

public void setAddress(IArcWebAddress address)
                throws IOException,
                       AutomationException
The address or intersection of the place.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setAddress in interface IArcWebLocation
Parameters:
address - A reference to a com.esri.arcgis.arcweb.IArcWebAddress (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription1

public String getDescription1()
                       throws IOException,
                              AutomationException
The scrubbed address (e.g., 380 New York St. Redlands, CA 92373) or long description of the place (e.g., Redlands, California, United States).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getDescription1 in interface IArcWebLocation
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDescription1

public void setDescription1(String pVal)
                     throws IOException,
                            AutomationException
The scrubbed address (e.g., 380 New York St. Redlands, CA 92373) or long description of the place (e.g., Redlands, California, United States).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setDescription1 in interface IArcWebLocation
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription2

public String getDescription2()
                       throws IOException,
                              AutomationException
The short description of the place (e.g., Redlands).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getDescription2 in interface IArcWebLocation
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDescription2

public void setDescription2(String pVal)
                     throws IOException,
                            AutomationException
The short description of the place (e.g., Redlands).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setDescription2 in interface IArcWebLocation
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEnvelope

public IEnvelope getEnvelope()
                      throws IOException,
                             AutomationException
The bounding extent of the place.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getEnvelope in interface IArcWebLocation
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnvelopeByRef

public void setEnvelopeByRef(IEnvelope pVal)
                      throws IOException,
                             AutomationException
The bounding extent of the place.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setEnvelopeByRef in interface IArcWebLocation
Parameters:
pVal - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPoint

public IPoint getPoint()
                throws IOException,
                       AutomationException
The x,y coordinates and the coordinate system of the place.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getPoint in interface IArcWebLocation
Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPointByRef

public void setPointByRef(IPoint pVal)
                   throws IOException,
                          AutomationException
The x,y coordinates and the coordinate system of the place.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setPointByRef in interface IArcWebLocation
Parameters:
pVal - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getScore

public double getScore()
                throws IOException,
                       AutomationException
A number from 1 to 20 indicating the likelihood of a match to the place, with 1 being the most likely and 20 being the least likely.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getScore in interface IArcWebLocation
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setScore

public void setScore(double pVal)
              throws IOException,
                     AutomationException
A number from 1 to 20 indicating the likelihood of a match to the place, with 1 being the most likely and 20 being the least likely.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setScore in interface IArcWebLocation
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPlaceType

public String getPlaceType()
                    throws IOException,
                           AutomationException
A letter indicating the type of place.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getPlaceType in interface IArcWebLocation
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPlaceType

public void setPlaceType(String pVal)
                  throws IOException,
                         AutomationException
A letter indicating the type of place.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setPlaceType in interface IArcWebLocation
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.