com.esri.arcgis.location
Class RouteMeasureGeoprocessor

java.lang.Object
  extended by com.esri.arcgis.location.RouteMeasureGeoprocessor
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IRouteMeasureEventGeoprocessor, IRouteMeasureEventGeoprocessor2, ISupportErrorInfo, Serializable

public class RouteMeasureGeoprocessor
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRouteMeasureEventGeoprocessor, IRouteMeasureEventGeoprocessor2, ISupportErrorInfo

Basic route measure geoprocessing object.

Remarks

A route measure event geoprocessor provides access to geoprocessing operations on route measure events. These operations include dissolving events, concatenating events and event overlay (e.g. line-on-line and point-on-line)

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
RouteMeasureGeoprocessor()
          Constructs a RouteMeasureGeoprocessor using ArcGIS Engine.
RouteMeasureGeoprocessor(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RouteMeasureGeoprocessor theRouteMeasureGeoprocessor = (RouteMeasureGeoprocessor) obj;
 
Method Summary
 ITable concatenate(Object concatenateFields, IDatasetName outputName, ITrackCancel trackCancel, String configKeyword)
          Concatenate events.
 ITable concatenate2(IRouteEventProperties outputProperties, Object concatenateFields, IDatasetName outputName, ITrackCancel trackCancel, String configKeyword)
          Concatenate events.
 ITable dissolve(Object dissolveFields, IDatasetName outputName, ITrackCancel trackCancel, String configKeyword)
          Dissolve events.
 ITable dissolve2(IRouteEventProperties outputProperties, Object dissolveFields, IDatasetName outputName, ITrackCancel trackCancel, String configKeyword)
          Dissolve events.
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 IRouteEventProperties getInputEventProperties()
          The input table's route event properties.
 ISelectionSet getInputSelection()
          The input table's selection set.
 ITable getInputTable()
          The input table.
 IRouteEventProperties getOverlayEventProperties()
          The overlay table's route event properties.
 ISelectionSet getOverlaySelection()
          The overlay table's selection set.
 ITable getOverlayTable()
          The table to overlay with the input table.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 ITable intersect(IRouteEventProperties outputProperties, IDatasetName outputName, ITrackCancel trackCancel, String configKeyword)
          Intersect events.
 ITable intersect2(IRouteEventProperties outputProperties, boolean keepAllFields, IDatasetName outputName, ITrackCancel trackCancel, String configKeyword)
          Intersect events.
 boolean isBuildOutputIndex()
          Indicates whether an index is going to be built on the route id field on the output result.
 boolean isKeepZeroLengthLineEvents()
          Indicates whether zero length events should be included in the overlay result (line on line overlays only).
 void setBuildOutputIndex(boolean status)
          Indicates whether an index is going to be built on the route id field on the output result.
 void setInputEventPropertiesByRef(IRouteEventProperties inputProperties)
          The input table's route event properties.
 void setInputSelectionByRef(ISelectionSet selection)
          The input table's selection set.
 void setInputTableByRef(ITable table)
          The input table.
 void setKeepZeroLengthLineEvents(boolean status)
          Indicates whether zero length events should be included in the overlay result (line on line overlays only).
 void setOverlayEventPropertiesByRef(IRouteEventProperties overlayProperties)
          The overlay table's route event properties.
 void setOverlaySelectionByRef(ISelectionSet selection)
          The overlay table's selection set.
 void setOverlayTableByRef(ITable table)
          The table to overlay with the input table.
 ITable union(IRouteEventProperties outputProperties, IDatasetName outputName, ITrackCancel trackCancel, String configKeyword)
          Union events.
 ITable union2(IRouteEventProperties outputProperties, boolean keepAllFields, IDatasetName outputName, ITrackCancel trackCancel, String configKeyword)
          Union events.
 
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

RouteMeasureGeoprocessor

public RouteMeasureGeoprocessor()
                         throws IOException,
                                UnknownHostException
Constructs a RouteMeasureGeoprocessor using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

RouteMeasureGeoprocessor

public RouteMeasureGeoprocessor(Object obj)
                         throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RouteMeasureGeoprocessor theRouteMeasureGeoprocessor = (RouteMeasureGeoprocessor) obj;

Construct a RouteMeasureGeoprocessor using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RouteMeasureGeoprocessor.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


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

setInputTableByRef

public void setInputTableByRef(ITable table)
                        throws IOException,
                               AutomationException
The input table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setInputTableByRef in interface IRouteMeasureEventGeoprocessor
Parameters:
table - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInputTable

public ITable getInputTable()
                     throws IOException,
                            AutomationException
The input table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getInputTable in interface IRouteMeasureEventGeoprocessor
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInputSelectionByRef

public void setInputSelectionByRef(ISelectionSet selection)
                            throws IOException,
                                   AutomationException
The input table's selection set.

Product Availability

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

Specified by:
setInputSelectionByRef in interface IRouteMeasureEventGeoprocessor
Parameters:
selection - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInputSelection

public ISelectionSet getInputSelection()
                                throws IOException,
                                       AutomationException
The input table's selection set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getInputSelection in interface IRouteMeasureEventGeoprocessor
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverlayTableByRef

public void setOverlayTableByRef(ITable table)
                          throws IOException,
                                 AutomationException
The table to overlay with the input table.

Product Availability

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

Specified by:
setOverlayTableByRef in interface IRouteMeasureEventGeoprocessor
Parameters:
table - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOverlayTable

public ITable getOverlayTable()
                       throws IOException,
                              AutomationException
The table to overlay with the input table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOverlayTable in interface IRouteMeasureEventGeoprocessor
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverlaySelectionByRef

public void setOverlaySelectionByRef(ISelectionSet selection)
                              throws IOException,
                                     AutomationException
The overlay table's selection set.

Product Availability

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

Specified by:
setOverlaySelectionByRef in interface IRouteMeasureEventGeoprocessor
Parameters:
selection - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOverlaySelection

public ISelectionSet getOverlaySelection()
                                  throws IOException,
                                         AutomationException
The overlay table's selection set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOverlaySelection in interface IRouteMeasureEventGeoprocessor
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInputEventPropertiesByRef

public void setInputEventPropertiesByRef(IRouteEventProperties inputProperties)
                                  throws IOException,
                                         AutomationException
The input table's route event properties.

Product Availability

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

Specified by:
setInputEventPropertiesByRef in interface IRouteMeasureEventGeoprocessor
Parameters:
inputProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInputEventProperties

public IRouteEventProperties getInputEventProperties()
                                              throws IOException,
                                                     AutomationException
The input table's route event properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getInputEventProperties in interface IRouteMeasureEventGeoprocessor
Returns:
A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverlayEventPropertiesByRef

public void setOverlayEventPropertiesByRef(IRouteEventProperties overlayProperties)
                                    throws IOException,
                                           AutomationException
The overlay table's route event properties.

Product Availability

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

Specified by:
setOverlayEventPropertiesByRef in interface IRouteMeasureEventGeoprocessor
Parameters:
overlayProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOverlayEventProperties

public IRouteEventProperties getOverlayEventProperties()
                                                throws IOException,
                                                       AutomationException
The overlay table's route event properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOverlayEventProperties in interface IRouteMeasureEventGeoprocessor
Returns:
A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKeepZeroLengthLineEvents

public void setKeepZeroLengthLineEvents(boolean status)
                                 throws IOException,
                                        AutomationException
Indicates whether zero length events should be included in the overlay result (line on line overlays only).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isKeepZeroLengthLineEvents

public boolean isKeepZeroLengthLineEvents()
                                   throws IOException,
                                          AutomationException
Indicates whether zero length events should be included in the overlay result (line on line overlays only).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isKeepZeroLengthLineEvents in interface IRouteMeasureEventGeoprocessor
Returns:
The status
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBuildOutputIndex

public void setBuildOutputIndex(boolean status)
                         throws IOException,
                                AutomationException
Indicates whether an index is going to be built on the route id field on the output result.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isBuildOutputIndex

public boolean isBuildOutputIndex()
                           throws IOException,
                                  AutomationException
Indicates whether an index is going to be built on the route id field on the output result.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isBuildOutputIndex in interface IRouteMeasureEventGeoprocessor
Returns:
The status
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

dissolve

public ITable dissolve(Object dissolveFields,
                       IDatasetName outputName,
                       ITrackCancel trackCancel,
                       String configKeyword)
                throws IOException,
                       AutomationException
Dissolve events.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
dissolve in interface IRouteMeasureEventGeoprocessor
Parameters:
dissolveFields - A Variant (in)
outputName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
configKeyword - The configKeyword (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

concatenate

public ITable concatenate(Object concatenateFields,
                          IDatasetName outputName,
                          ITrackCancel trackCancel,
                          String configKeyword)
                   throws IOException,
                          AutomationException
Concatenate events.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
concatenate in interface IRouteMeasureEventGeoprocessor
Parameters:
concatenateFields - A Variant (in)
outputName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
configKeyword - The configKeyword (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

intersect

public ITable intersect(IRouteEventProperties outputProperties,
                        IDatasetName outputName,
                        ITrackCancel trackCancel,
                        String configKeyword)
                 throws IOException,
                        AutomationException
Intersect events.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
intersect in interface IRouteMeasureEventGeoprocessor
Parameters:
outputProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)
outputName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
configKeyword - The configKeyword (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

union

public ITable union(IRouteEventProperties outputProperties,
                    IDatasetName outputName,
                    ITrackCancel trackCancel,
                    String configKeyword)
             throws IOException,
                    AutomationException
Union events.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
union in interface IRouteMeasureEventGeoprocessor
Parameters:
outputProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)
outputName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
configKeyword - The configKeyword (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

dissolve2

public ITable dissolve2(IRouteEventProperties outputProperties,
                        Object dissolveFields,
                        IDatasetName outputName,
                        ITrackCancel trackCancel,
                        String configKeyword)
                 throws IOException,
                        AutomationException
Dissolve events.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
dissolve2 in interface IRouteMeasureEventGeoprocessor2
Parameters:
outputProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)
dissolveFields - A Variant (in)
outputName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
configKeyword - The configKeyword (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

concatenate2

public ITable concatenate2(IRouteEventProperties outputProperties,
                           Object concatenateFields,
                           IDatasetName outputName,
                           ITrackCancel trackCancel,
                           String configKeyword)
                    throws IOException,
                           AutomationException
Concatenate events.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
concatenate2 in interface IRouteMeasureEventGeoprocessor2
Parameters:
outputProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)
concatenateFields - A Variant (in)
outputName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
configKeyword - The configKeyword (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

intersect2

public ITable intersect2(IRouteEventProperties outputProperties,
                         boolean keepAllFields,
                         IDatasetName outputName,
                         ITrackCancel trackCancel,
                         String configKeyword)
                  throws IOException,
                         AutomationException
Intersect events.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
intersect2 in interface IRouteMeasureEventGeoprocessor2
Parameters:
outputProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)
keepAllFields - The keepAllFields (in)
outputName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
configKeyword - The configKeyword (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

union2

public ITable union2(IRouteEventProperties outputProperties,
                     boolean keepAllFields,
                     IDatasetName outputName,
                     ITrackCancel trackCancel,
                     String configKeyword)
              throws IOException,
                     AutomationException
Union events.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
union2 in interface IRouteMeasureEventGeoprocessor2
Parameters:
outputProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)
keepAllFields - The keepAllFields (in)
outputName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
configKeyword - The configKeyword (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.