com.esri.arcgis.location
Class RouteMeasureCreator

java.lang.Object
  com.esri.arcgis.location.RouteMeasureCreator

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IRouteMeasureCreator, IRouteMeasureCreator2, ISupportErrorInfo, Serializable

public class RouteMeasureCreator
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRouteMeasureCreator, IRouteMeasureCreator2, ISupportErrorInfo

Basic route creation object.

Remarks

The RouteMeasureCreator CoClass lets you create a PolylineM (route) feature class from a Polyline feature class by aggregating features together based on a field name (route identifier).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RouteMeasureCreator()
Constructs a RouteMeasureCreator using ArcGIS Engine.

RouteMeasureCreator(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RouteMeasureCreator theRouteMeasureCreator = (RouteMeasureCreator) obj;

Method Summary

IEnumBSTR	createUsing2Fields(String fmFieldName, String tmFieldName, IFeatureClassName outputFClassName, IGeometryDef outputGeometryDef, String configKeyword, ITrackCancel trackCancel) Create routes from polylines using two fields.
IEnumBSTR	createUsing2Fields2(String fmFieldName, String tmFieldName, double factor, double offset, IFeatureClassName outputFClassName, IGeometryDef outputGeometryDef, String configKeyword, ITrackCancel trackCancel) Create routes from polylines using two fields.
IEnumBSTR	createUsingCoordinatePriority(String lengthFieldName, int seedingCorner, boolean ignoreGaps, IFeatureClassName outputFClassName, IGeometryDef outputGeometryDef, String configKeyword, ITrackCancel trackCancel) Create routes from using topology.
IEnumBSTR	createUsingCoordinatePriority2(String lengthFieldName, double factor, double offset, int seedingCorner, boolean ignoreGaps, IFeatureClassName outputFClassName, IGeometryDef outputGeometryDef, String configKeyword, ITrackCancel trackCancel) Create routes from using topology.
IEnumBSTR	createUsingPoints(ISelectionSet pointSelection, String pointRIDFieldName, String pointMeasureFieldName, int updateHow, boolean ignoreGaps, double tolerance, boolean allInputFeatures, IFeatureClassName outputFClassName, IGeometryDef outputGeometryDef, String configKeyword, ITrackCancel trackCancel) Create routes from polylines using points to assign measures.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IFeatureClass	getInputFeatureClass() The input features.
ISelectionSet	getInputFeatureSelection() A selection set of input features.
String	getInputRouteIDFieldName() The input route identifier field name.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isBuildOutputIndex() Indicates whether an index is going to be built on the route id field on the output result.
void	setBuildOutputIndex(boolean status) Indicates whether an index is going to be built on the route id field on the output result.
void	setInputFeatureClassByRef(IFeatureClass inputFeatureClass) The input features.
void	setInputFeatureSelectionByRef(ISelectionSet selection) A selection set of input features.
void	setInputRouteIDFieldName(String fieldName) The input route identifier field name.

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

RouteMeasureCreator

public RouteMeasureCreator()
                    throws IOException,
                           UnknownHostException

Constructs a RouteMeasureCreator using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RouteMeasureCreator

public RouteMeasureCreator(Object obj)
                    throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RouteMeasureCreator theRouteMeasureCreator = (RouteMeasureCreator) obj;

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

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

setInputFeatureClassByRef

public void setInputFeatureClassByRef(IFeatureClass inputFeatureClass)
                               throws IOException,
                                      AutomationException

The input features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setInputFeatureClassByRef in interface IRouteMeasureCreator

Parameters:

inputFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputFeatureClass

public IFeatureClass getInputFeatureClass()
                                   throws IOException,
                                          AutomationException

The input features.

Remarks

This sets the input feature class, IFeatureClass, the routes are to be created from. The input feature class must have its geometry of type Polyline.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getInputFeatureClass in interface IRouteMeasureCreator

Returns:

A reference to a com.esri.arcgis.geodatabase.IFeatureClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInputFeatureSelectionByRef

public void setInputFeatureSelectionByRef(ISelectionSet selection)
                                   throws IOException,
                                          AutomationException

A selection set of input features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setInputFeatureSelectionByRef in interface IRouteMeasureCreator

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.

getInputFeatureSelection

public ISelectionSet getInputFeatureSelection()
                                       throws IOException,
                                              AutomationException

A selection set of input features.

Remarks

If the InputFeatureSelection is set, the InputFeatureClass does not get used even if it is set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getInputFeatureSelection in interface IRouteMeasureCreator

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.

setInputRouteIDFieldName

public void setInputRouteIDFieldName(String fieldName)
                              throws IOException,
                                     AutomationException

The input route identifier field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setInputRouteIDFieldName in interface IRouteMeasureCreator

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputRouteIDFieldName

public String getInputRouteIDFieldName()
                                throws IOException,
                                       AutomationException

The input route identifier field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getInputRouteIDFieldName in interface IRouteMeasureCreator

Returns:

The fieldName

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 IRouteMeasureCreator

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.

Remarks

The BuildOutputIndex property can be used to create an index on the route identifier of the output feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isBuildOutputIndex in interface IRouteMeasureCreator

Returns:

The status

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createUsing2Fields

public IEnumBSTR createUsing2Fields(String fmFieldName,
                                    String tmFieldName,
                                    IFeatureClassName outputFClassName,
                                    IGeometryDef outputGeometryDef,
                                    String configKeyword,
                                    ITrackCancel trackCancel)
                             throws IOException,
                                    AutomationException

Create routes from polylines using two fields.

Remarks

The fmFieldName and tmFieldName parameters passed into this method are the names of the fields in the InputFeatureClass which are used to set the start (from) and the end (to) measure values of that feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createUsing2Fields in interface IRouteMeasureCreator

Parameters:

fmFieldName - The fmFieldName (in)

tmFieldName - The tmFieldName (in)

outputFClassName - A reference to a com.esri.arcgis.geodatabase.IFeatureClassName (in)

outputGeometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)

configKeyword - The configKeyword (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createUsingCoordinatePriority

public IEnumBSTR createUsingCoordinatePriority(String lengthFieldName,
                                               int seedingCorner,
                                               boolean ignoreGaps,
                                               IFeatureClassName outputFClassName,
                                               IGeometryDef outputGeometryDef,
                                               String configKeyword,
                                               ITrackCancel trackCancel)
                                        throws IOException,
                                               AutomationException

Create routes from using topology.

Remarks

The lengthFieldName is the name of the field in the input feature class which contains the measures of the route. Measures will be set starting from zero to the value in this field.

The seedingCorner parameter specifies the coordinate priority of where the route measure will start (measure = 0). The coordinate priority can be:

0 - esriMSeedingUperLeft

1 - esriMSeedingBottomLeft

2 - esriMSeedingUpperRight

3 - esriMSeedingBottomRight

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createUsingCoordinatePriority in interface IRouteMeasureCreator

Parameters:

lengthFieldName - The lengthFieldName (in)

seedingCorner - A com.esri.arcgis.location.esriMSeedingCorner constant (in)

ignoreGaps - The ignoreGaps (in)

outputFClassName - A reference to a com.esri.arcgis.geodatabase.IFeatureClassName (in)

outputGeometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)

configKeyword - The configKeyword (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createUsingPoints

public IEnumBSTR createUsingPoints(ISelectionSet pointSelection,
                                   String pointRIDFieldName,
                                   String pointMeasureFieldName,
                                   int updateHow,
                                   boolean ignoreGaps,
                                   double tolerance,
                                   boolean allInputFeatures,
                                   IFeatureClassName outputFClassName,
                                   IGeometryDef outputGeometryDef,
                                   String configKeyword,
                                   ITrackCancel trackCancel)
                            throws IOException,
                                   AutomationException

Create routes from polylines using points to assign measures.

Remarks

The CreateUsingPoints method creates a route feature class by taking input a Polyline feature class and a selection set of Points or Multipoints which represent the calibration points to be used to set the measures of the Polyline. The calibration points are features inside a feature class, which contain fields pointRIDFieldName and pointMeasrueFieldName . The pointRIDFieldName field is the route identifier (the line feature in the InputFeatureClass) the calibration point refers to. The pointMeasureFieldName field contains the calibration measure values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createUsingPoints in interface IRouteMeasureCreator

Parameters:

pointSelection - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

pointRIDFieldName - The pointRIDFieldName (in)

pointMeasureFieldName - The pointMeasureFieldName (in)

updateHow - The updateHow (in)

ignoreGaps - The ignoreGaps (in)

tolerance - The tolerance (in)

allInputFeatures - The allInputFeatures (in)

outputFClassName - A reference to a com.esri.arcgis.geodatabase.IFeatureClassName (in)

outputGeometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)

configKeyword - The configKeyword (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createUsing2Fields2

public IEnumBSTR createUsing2Fields2(String fmFieldName,
                                     String tmFieldName,
                                     double factor,
                                     double offset,
                                     IFeatureClassName outputFClassName,
                                     IGeometryDef outputGeometryDef,
                                     String configKeyword,
                                     ITrackCancel trackCancel)
                              throws IOException,
                                     AutomationException

Create routes from polylines using two fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createUsing2Fields2 in interface IRouteMeasureCreator2

Parameters:

fmFieldName - The fmFieldName (in)

tmFieldName - The tmFieldName (in)

factor - The factor (in)

offset - The offset (in)

outputFClassName - A reference to a com.esri.arcgis.geodatabase.IFeatureClassName (in)

outputGeometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)

configKeyword - The configKeyword (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createUsingCoordinatePriority2

public IEnumBSTR createUsingCoordinatePriority2(String lengthFieldName,
                                                double factor,
                                                double offset,
                                                int seedingCorner,
                                                boolean ignoreGaps,
                                                IFeatureClassName outputFClassName,
                                                IGeometryDef outputGeometryDef,
                                                String configKeyword,
                                                ITrackCancel trackCancel)
                                         throws IOException,
                                                AutomationException

Create routes from using topology.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createUsingCoordinatePriority2 in interface IRouteMeasureCreator2

Parameters:

lengthFieldName - The lengthFieldName (in)

factor - The factor (in)

offset - The offset (in)

seedingCorner - A com.esri.arcgis.location.esriMSeedingCorner constant (in)

ignoreGaps - The ignoreGaps (in)

outputFClassName - A reference to a com.esri.arcgis.geodatabase.IFeatureClassName (in)

outputGeometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)

configKeyword - The configKeyword (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

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.