com.esri.arcgis.location
Class IRouteLocatorProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.location.IRouteLocatorProxy
All Implemented Interfaces:
IRouteLocator, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
IRouteLocator2Proxy

public class IRouteLocatorProxy
extends com.esri.arcgis.interop.Dispatch
implements IRouteLocator, java.io.Serializable

Internal use class Proxy for COM Interface 'IRouteLocator'. Generated 3/19/2015 1:20:58 PM from 'C:\ArcGIS\COM\esriLocation.olb'

Description: 'Provides access to properties and methods of a route locator.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 boolean noncastable
           
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Fields inherited from interface com.esri.arcgis.location.IRouteLocator
IID, IIDa1e3811c_2055_11d4_9fc1_00c04f6bdf06
 
Constructor Summary
  IRouteLocatorProxy()
          For internal use only
  IRouteLocatorProxy(java.lang.Object obj)
           
protected IRouteLocatorProxy(java.lang.Object obj, java.lang.String iid)
           
  IRouteLocatorProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
protected IRouteLocatorProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
           
 IEnvelope getExtent()
          The route locator's extent (same a route feature class' extent).
 int getMeasureUnit()
          The units of the route measures.
 IFeatureClass getRouteFeatureClass()
          The route feature class (Polyline with M feature class).
 void getRouteGeometry(IRouteLocation routeLocation, IGeometry[] routeGeometry, int[] locatingError)
          The route(s) corresponding to the route location.
 int getRouteIDFieldIndex()
          The field index of the route identifier.
 java.lang.String getRouteIDFieldName()
          The route identifier field from the route feature class.
 java.lang.String getRouteIDFieldNameDelimited()
          The delimited route identifier field of the route feature class.
 java.lang.String getRouteWhereClause()
          The where clause that limits the routes events can be located on.
 ISpatialReference getSpatialReference()
          The route locator's spatial reference (same as route feature class' spatial reference).
 boolean isHasSpatialIndex()
          Indicates if the route feature class has a spatial index.
 boolean isRouteIDIsString()
          Indicates if the route identifier field type is string.
 boolean isRouteIDIsUnique()
          Indicates whether the route ID is unique (Obsolete).
 void locate(IRouteLocation routeLocation, IGeometry[] result, int[] locatingError)
          Locates a point or line route location.
 void locateRow(IRouteEventProperties eventProperties, IRow row, IGeometry[] result, int[] locatingError)
          Locates an event table row containing a point or line route location.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
           
 void setRouteWhereClause(java.lang.String whereClause)
          The where clause that limits the routes events can be located on.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable
Constructor Detail

IRouteLocatorProxy

public IRouteLocatorProxy(java.lang.String CLSID,
                          java.lang.String host,
                          com.esri.arcgis.interop.AuthInfo authInfo)
                   throws java.net.UnknownHostException,
                          java.io.IOException
Throws:
java.net.UnknownHostException
java.io.IOException

IRouteLocatorProxy

public IRouteLocatorProxy()
For internal use only


IRouteLocatorProxy

public IRouteLocatorProxy(java.lang.Object obj)
                   throws java.io.IOException
Throws:
java.io.IOException

IRouteLocatorProxy

protected IRouteLocatorProxy(java.lang.Object obj,
                             java.lang.String iid)
                      throws java.io.IOException
Throws:
java.io.IOException

IRouteLocatorProxy

protected IRouteLocatorProxy(java.lang.String CLSID,
                             java.lang.String iid,
                             java.lang.String host,
                             com.esri.arcgis.interop.AuthInfo authInfo)
                      throws java.io.IOException
Throws:
java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

getRouteFeatureClass

public IFeatureClass getRouteFeatureClass()
                                   throws java.io.IOException,
                                          AutomationException
The route feature class (Polyline with M feature class).

Specified by:
getRouteFeatureClass in interface IRouteLocator
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldName

public java.lang.String getRouteIDFieldName()
                                     throws java.io.IOException,
                                            AutomationException
The route identifier field from the route feature class.

Specified by:
getRouteIDFieldName in interface IRouteLocator
Returns:
The rid
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldIndex

public int getRouteIDFieldIndex()
                         throws java.io.IOException,
                                AutomationException
The field index of the route identifier.

Specified by:
getRouteIDFieldIndex in interface IRouteLocator
Returns:
The routeIDIndex
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldNameDelimited

public java.lang.String getRouteIDFieldNameDelimited()
                                              throws java.io.IOException,
                                                     AutomationException
The delimited route identifier field of the route feature class.

Specified by:
getRouteIDFieldNameDelimited in interface IRouteLocator
Returns:
The rid
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRouteIDIsUnique

public boolean isRouteIDIsUnique()
                          throws java.io.IOException,
                                 AutomationException
Indicates whether the route ID is unique (Obsolete).

Specified by:
isRouteIDIsUnique in interface IRouteLocator
Returns:
The routeIDIsUnique
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRouteIDIsString

public boolean isRouteIDIsString()
                          throws java.io.IOException,
                                 AutomationException
Indicates if the route identifier field type is string.

Specified by:
isRouteIDIsString in interface IRouteLocator
Returns:
The routeIDIsString
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRouteWhereClause

public void setRouteWhereClause(java.lang.String whereClause)
                         throws java.io.IOException,
                                AutomationException
The where clause that limits the routes events can be located on.

Specified by:
setRouteWhereClause in interface IRouteLocator
Parameters:
whereClause - The whereClause (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRouteWhereClause

public java.lang.String getRouteWhereClause()
                                     throws java.io.IOException,
                                            AutomationException
The where clause that limits the routes events can be located on.

Specified by:
getRouteWhereClause in interface IRouteLocator
Returns:
The whereClause
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMeasureUnit

public int getMeasureUnit()
                   throws java.io.IOException,
                          AutomationException
The units of the route measures.

Specified by:
getMeasureUnit in interface IRouteLocator
Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException
The route locator's extent (same a route feature class' extent).

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

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException
The route locator's spatial reference (same as route feature class' spatial reference).

Specified by:
getSpatialReference in interface IRouteLocator
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasSpatialIndex

public boolean isHasSpatialIndex()
                          throws java.io.IOException,
                                 AutomationException
Indicates if the route feature class has a spatial index.

Specified by:
isHasSpatialIndex in interface IRouteLocator
Returns:
The hasSpatialIndex
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

locate

public void locate(IRouteLocation routeLocation,
                   IGeometry[] result,
                   int[] locatingError)
            throws java.io.IOException,
                   AutomationException
Locates a point or line route location.

Specified by:
locate in interface IRouteLocator
Parameters:
routeLocation - A reference to a com.esri.arcgis.location.IRouteLocation (in)
result - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)
locatingError - A com.esri.arcgis.geodatabase.esriLocatingError constant (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

locateRow

public void locateRow(IRouteEventProperties eventProperties,
                      IRow row,
                      IGeometry[] result,
                      int[] locatingError)
               throws java.io.IOException,
                      AutomationException
Locates an event table row containing a point or line route location.

Specified by:
locateRow in interface IRouteLocator
Parameters:
eventProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)
row - A reference to a com.esri.arcgis.geodatabase.IRow (in)
result - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)
locatingError - A com.esri.arcgis.geodatabase.esriLocatingError constant (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRouteGeometry

public void getRouteGeometry(IRouteLocation routeLocation,
                             IGeometry[] routeGeometry,
                             int[] locatingError)
                      throws java.io.IOException,
                             AutomationException
The route(s) corresponding to the route location.

Specified by:
getRouteGeometry in interface IRouteLocator
Parameters:
routeLocation - A reference to a com.esri.arcgis.location.IRouteLocation (in)
routeGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)
locatingError - A com.esri.arcgis.geodatabase.esriLocatingError constant (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.