com.esri.arcgis.geoprocessing.tools.linearreferencingtools
Class DissolveRouteEvents

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.linearreferencingtools.DissolveRouteEvents
All Implemented Interfaces:
GPTool

public class DissolveRouteEvents
extends AbstractGPTool

Removes redundant information from event tables or separates event tables having more than one descriptive attribute into individual tables. The Dissolve Route Events tool is contained in the Linear Referencing Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
DissolveRouteEvents()
          Creates the Dissolve Route Events tool with defaults.
DissolveRouteEvents(Object inEvents, Object inEventProperties, Object dissolveField, Object outTable, Object outEventProperties)
          Creates the Dissolve Route Events tool with the required parameters.
 
Method Summary
 String getBuildIndex()
          Returns the Build index parameter of this tool .
 Object getDissolveField()
          Returns the Dissolve Fields parameter of this tool .
 String getDissolveType()
          Returns the Combine adjacent events only parameter of this tool .
 Object getInEventProperties()
          Returns the Event Table Properties parameter of this tool .
 Object getInEvents()
          Returns the Input Event Table parameter of this tool .
 Object getOutEventProperties()
          Returns the Output Event Table Properties parameter of this tool .
 Object getOutTable()
          Returns the Output Event Table parameter of this tool .
 String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 String getToolboxName()
          Returns the name of the tool box containing this tool.
 String getToolName()
          Returns the name of this tool.
 void setBuildIndex(String buildIndex)
          Sets the Build index parameter of this tool .
 void setDissolveField(Object dissolveField)
          Sets the Dissolve Fields parameter of this tool .
 void setDissolveType(String dissolveType)
          Sets the Combine adjacent events only parameter of this tool .
 void setInEventProperties(Object inEventProperties)
          Sets the Event Table Properties parameter of this tool .
 void setInEvents(Object inEvents)
          Sets the Input Event Table parameter of this tool .
 void setOutEventProperties(Object outEventProperties)
          Sets the Output Event Table Properties parameter of this tool .
 void setOutTable(Object outTable)
          Sets the Output Event Table parameter of this tool .
 
Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
getParameterValues, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DissolveRouteEvents

public DissolveRouteEvents()
Creates the Dissolve Route Events tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.


DissolveRouteEvents

public DissolveRouteEvents(Object inEvents,
                           Object inEventProperties,
                           Object dissolveField,
                           Object outTable,
                           Object outEventProperties)
Creates the Dissolve Route Events tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:
inEvents - Table View, the table whose rows will be aggregated.
inEventProperties - Route Measure Event Properties, to-Measure FieldA field containing measure values. This field must be numeric and is required when the event type is LINE.
dissolveField - Field, the field or fields used to aggregate rows.
outTable - Table, the table to be created.
outEventProperties - Route Measure Event Properties, to-Measure FieldA field that will contain measure values. Required when the event type is LINE.
Method Detail

getInEvents

public Object getInEvents()
Returns the Input Event Table parameter of this tool . This parameter is Table View, the table whose rows will be aggregated. This is a required parameter.

Returns:
the Input Event Table

setInEvents

public void setInEvents(Object inEvents)
Sets the Input Event Table parameter of this tool . This parameter is Table View, the table whose rows will be aggregated. This is a required parameter.

Parameters:
inEvents - Table View, the table whose rows will be aggregated.

getInEventProperties

public Object getInEventProperties()
Returns the Event Table Properties parameter of this tool . This parameter is Route Measure Event Properties, to-Measure FieldA field containing measure values. This field must be numeric and is required when the event type is LINE. This is a required parameter.

Returns:
the Event Table Properties

setInEventProperties

public void setInEventProperties(Object inEventProperties)
Sets the Event Table Properties parameter of this tool . This parameter is Route Measure Event Properties, to-Measure FieldA field containing measure values. This field must be numeric and is required when the event type is LINE. This is a required parameter.

Parameters:
inEventProperties - Route Measure Event Properties, to-Measure FieldA field containing measure values. This field must be numeric and is required when the event type is LINE.

getDissolveField

public Object getDissolveField()
Returns the Dissolve Fields parameter of this tool . This parameter is Field, the field or fields used to aggregate rows. This is a required parameter.

Returns:
the Dissolve Fields

setDissolveField

public void setDissolveField(Object dissolveField)
Sets the Dissolve Fields parameter of this tool . This parameter is Field, the field or fields used to aggregate rows. This is a required parameter.

Parameters:
dissolveField - Field, the field or fields used to aggregate rows.

getOutTable

public Object getOutTable()
Returns the Output Event Table parameter of this tool . This parameter is Table, the table to be created. This is a required parameter.

Returns:
the Output Event Table

setOutTable

public void setOutTable(Object outTable)
Sets the Output Event Table parameter of this tool . This parameter is Table, the table to be created. This is a required parameter.

Parameters:
outTable - Table, the table to be created.

getOutEventProperties

public Object getOutEventProperties()
Returns the Output Event Table Properties parameter of this tool . This parameter is Route Measure Event Properties, to-Measure FieldA field that will contain measure values. Required when the event type is LINE. This is a required parameter.

Returns:
the Output Event Table Properties

setOutEventProperties

public void setOutEventProperties(Object outEventProperties)
Sets the Output Event Table Properties parameter of this tool . This parameter is Route Measure Event Properties, to-Measure FieldA field that will contain measure values. Required when the event type is LINE. This is a required parameter.

Parameters:
outEventProperties - Route Measure Event Properties, to-Measure FieldA field that will contain measure values. Required when the event type is LINE.

getDissolveType

public String getDissolveType()
Returns the Combine adjacent events only parameter of this tool . This parameter is String, specifies whether the input events will be concatenated or dissolved. This is an optional parameter.

Returns:
the Combine adjacent events only

setDissolveType

public void setDissolveType(String dissolveType)
Sets the Combine adjacent events only parameter of this tool . This parameter is String, specifies whether the input events will be concatenated or dissolved. This is an optional parameter.

Parameters:
dissolveType - String, specifies whether the input events will be concatenated or dissolved.

getBuildIndex

public String getBuildIndex()
Returns the Build index parameter of this tool . This parameter is String, specifies whether an attribute index will be created for the route identifier field that is written to the output event table. This is an optional parameter.

Returns:
the Build index

setBuildIndex

public void setBuildIndex(String buildIndex)
Sets the Build index parameter of this tool . This parameter is String, specifies whether an attribute index will be created for the route identifier field that is written to the output event table. This is an optional parameter.

Parameters:
buildIndex - String, specifies whether an attribute index will be created for the route identifier field that is written to the output event table.

getToolName

public String getToolName()
Returns the name of this tool.

Returns:
the tool name

getToolboxName

public String getToolboxName()
Returns the name of the tool box containing this tool.

Returns:
the tool box name

getToolboxAlias

public String getToolboxAlias()
Returns the alias of the tool box containing this tool.

Returns:
the tool box alias