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.

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(java.lang.Object inEvents, java.lang.Object inEventProperties, java.lang.Object dissolveField, java.lang.Object outTable, java.lang.Object outEventProperties)
          Creates the Dissolve Route Events tool with the required parameters.
 
Method Summary
 java.lang.String getBuildIndex()
          Returns the Build index parameter of this tool .
 java.lang.Object getDissolveField()
          Returns the Dissolve Fields parameter of this tool .
 java.lang.String getDissolveType()
          Returns the Combine adjacent events only parameter of this tool .
 java.lang.Object getInEventProperties()
          Returns the Event Table Properties parameter of this tool .
 java.lang.Object getInEvents()
          Returns the Input Event Table parameter of this tool .
 java.lang.Object getOutEventProperties()
          Returns the Output Event Table Properties parameter of this tool .
 java.lang.Object getOutTable()
          Returns the Output Event Table parameter of this tool .
 java.lang.String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 java.lang.String getToolboxName()
          Returns the name of the tool box containing this tool.
 java.lang.String getToolName()
          Returns the name of this tool.
 void setBuildIndex(java.lang.String buildIndex)
          Sets the Build index parameter of this tool .
 void setDissolveField(java.lang.Object dissolveField)
          Sets the Dissolve Fields parameter of this tool .
 void setDissolveType(java.lang.String dissolveType)
          Sets the Combine adjacent events only parameter of this tool .
 void setInEventProperties(java.lang.Object inEventProperties)
          Sets the Event Table Properties parameter of this tool .
 void setInEvents(java.lang.Object inEvents)
          Sets the Input Event Table parameter of this tool .
 void setOutEventProperties(java.lang.Object outEventProperties)
          Sets the Output Event Table Properties parameter of this tool .
 void setOutTable(java.lang.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(java.lang.Object inEvents,
                           java.lang.Object inEventProperties,
                           java.lang.Object dissolveField,
                           java.lang.Object outTable,
                           java.lang.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 - the table whose rows will be aggregated.
inEventProperties - parameter consisting of the route location fields and the type of events in the input event table.
dissolveField - the field(s)used to aggregate rows.
outTable - the table to be created.
outEventProperties - parameter consisting of the route location fields and the type of events that will be written to the output event table.
Method Detail

getInEvents

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

Returns:
the Input Event Table

setInEvents

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

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

getInEventProperties

public java.lang.Object getInEventProperties()
Returns the Event Table Properties parameter of this tool . This parameter is parameter consisting of the route location fields and the type of events in the input event table. This is a required parameter.

Returns:
the Event Table Properties

setInEventProperties

public void setInEventProperties(java.lang.Object inEventProperties)
Sets the Event Table Properties parameter of this tool . This parameter is parameter consisting of the route location fields and the type of events in the input event table. This is a required parameter.

Parameters:
inEventProperties - parameter consisting of the route location fields and the type of events in the input event table.

getDissolveField

public java.lang.Object getDissolveField()
Returns the Dissolve Fields parameter of this tool . This parameter is the field(s)used to aggregate rows. This is a required parameter.

Returns:
the Dissolve Fields

setDissolveField

public void setDissolveField(java.lang.Object dissolveField)
Sets the Dissolve Fields parameter of this tool . This parameter is the field(s)used to aggregate rows. This is a required parameter.

Parameters:
dissolveField - the field(s)used to aggregate rows.

getOutTable

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

Returns:
the Output Event Table

setOutTable

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

Parameters:
outTable - the table to be created.

getOutEventProperties

public java.lang.Object getOutEventProperties()
Returns the Output Event Table Properties parameter of this tool . This parameter is parameter consisting of the route location fields and the type of events that will be written to the output event table. This is a required parameter.

Returns:
the Output Event Table Properties

setOutEventProperties

public void setOutEventProperties(java.lang.Object outEventProperties)
Sets the Output Event Table Properties parameter of this tool . This parameter is parameter consisting of the route location fields and the type of events that will be written to the output event table. This is a required parameter.

Parameters:
outEventProperties - parameter consisting of the route location fields and the type of events that will be written to the output event table.

getDissolveType

public java.lang.String getDissolveType()
Returns the Combine adjacent events only parameter of this tool . This parameter is 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(java.lang.String dissolveType)
Sets the Combine adjacent events only parameter of this tool . This parameter is specifies whether the input events will be concatenated or dissolved. This is an optional parameter.

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

getBuildIndex

public java.lang.String getBuildIndex()
Returns the Build index parameter of this tool . This parameter is 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(java.lang.String buildIndex)
Sets the Build index parameter of this tool . This parameter is 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 - specifies whether an attribute index will be created for the route identifier field that is written to the output event table.

getToolName

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

Returns:
the tool name

getToolboxName

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

Returns:
the tool box name

getToolboxAlias

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

Returns:
the tool box alias