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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.linearreferencingtools.OverlayRouteEvents

All Implemented Interfaces:

GPTool

public class OverlayRouteEvents
extends AbstractGPTool

Overlays two event tables to create an output event table that represents the union or intersection of the input. The Overlay Route Events tool is contained in the Linear Referencing Tools tool box.

Usage tips:

• Line-on-line, line-on-point, point-on-line, and point-on-point event overlays can be performed.
• The input and overlay events should be based on the same route reference.
• The input tables can be any type of table that ArcGIS supports. The output table can be a dBASE file or a geodatabase table.
• The output table can be displayed in ArcMap using the tool or using the .
• If both the input and overlay event properties are type POINT, the output event properties must also be defined as type POINT.
• If both the input and overlay event properties are type LINE, the output event properties must also be defined as type LINE.
• If either the input or overlay event properties are type POINT, the output event properties must be defined as type POINT when an INTERSECT overlay is performed. The output event properties must be defined as type LINE when a UNION overlay is performed.
• If both the input and overlay event properties are type POINT, only the points that have the exact same measure value are considered to intersect. There is no search tolerance.
• An attribute index on the route identifier field speeds up the dynamic segmentation process. If you will be using the Output Event Table for , it is recommended that you choose to have an attribute index created.
• Use the tool prior to this tool to effectively reduce the number of events that will be processed.
• If either the input or overlay events do not have an ObjectID field, use the tool prior to this tool to add a virtual ObjectID field.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

OverlayRouteEvents()
Creates the Overlay Route Events tool with defaults.

OverlayRouteEvents(Object inTable, Object inEventProperties, Object overlayTable, Object overlayEventProperties, String overlayType, Object outTable, Object outEventProperties)
Creates the Overlay Route Events tool with the required parameters.

Method Summary

String	getBuildIndex() Returns the Build index parameter of this tool .
Object	getInEventProperties() Returns the Input Event Table Properties parameter of this tool .
String	getInFields() Returns the Include all fields from input parameter of this tool .
Object	getInTable() 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 .
Object	getOverlayEventProperties() Returns the Overlay Event Table Properties parameter of this tool .
Object	getOverlayTable() Returns the Overlay Event Table parameter of this tool .
String	getOverlayType() Returns the Type of Overlay 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.
String	getZeroLengthEvents() Returns the Keep zero length line events parameter of this tool .
void	setBuildIndex(String buildIndex) Sets the Build index parameter of this tool .
void	setInEventProperties(Object inEventProperties) Sets the Input Event Table Properties parameter of this tool .
void	setInFields(String inFields) Sets the Include all fields from input parameter of this tool .
void	setInTable(Object inTable) 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 .
void	setOverlayEventProperties(Object overlayEventProperties) Sets the Overlay Event Table Properties parameter of this tool .
void	setOverlayTable(Object overlayTable) Sets the Overlay Event Table parameter of this tool .
void	setOverlayType(String overlayType) Sets the Type of Overlay parameter of this tool .
void	setZeroLengthEvents(String zeroLengthEvents) Sets the Keep zero length line events 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

OverlayRouteEvents

public OverlayRouteEvents()

Creates the Overlay Route Events tool with defaults.

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

OverlayRouteEvents

public OverlayRouteEvents(Object inTable,
                          Object inEventProperties,
                          Object overlayTable,
                          Object overlayEventProperties,
                          String overlayType,
                          Object outTable,
                          Object outEventProperties)

Creates the Overlay 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:

inTable - the input event table.

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

overlayTable - the overlay event table.

overlayEventProperties - parameter consisting of the route location fields and the type of events in the overlay event table. route Identifier Field—The field containing values that indicate which route each event is along. This field can be numeric or character. event Type—The type of events in the overlay event table (POINT or LINE). from-Measure Field—A field containing measure values. This field must be numeric and is required when the event type is POINT or LINE. Note when the Event Type is POINT the label for this parameter becomes "Measure Field". to-Measure Field—A field containing measure values. This field must be numeric and is required when the event type is LINE.

overlayType - the type of overlay to be performed.

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

getInTable

public Object getInTable()

Returns the Input Event Table parameter of this tool . This parameter is the input event table. This is a required parameter.

Returns:

the Input Event Table

setInTable

public void setInTable(Object inTable)

Sets the Input Event Table parameter of this tool . This parameter is the input event table. This is a required parameter.

Parameters:

inTable - the input event table.

getInEventProperties

public Object getInEventProperties()

Returns the Input 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 Input Event Table Properties

setInEventProperties

public void setInEventProperties(Object inEventProperties)

Sets the Input 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.

getOverlayTable

public Object getOverlayTable()

Returns the Overlay Event Table parameter of this tool . This parameter is the overlay event table. This is a required parameter.

Returns:

the Overlay Event Table

setOverlayTable

public void setOverlayTable(Object overlayTable)

Sets the Overlay Event Table parameter of this tool . This parameter is the overlay event table. This is a required parameter.

Parameters:

overlayTable - the overlay event table.

getOverlayEventProperties

public Object getOverlayEventProperties()

Returns the Overlay Event Table Properties parameter of this tool . This parameter is parameter consisting of the route location fields and the type of events in the overlay event table. route Identifier Field—The field containing values that indicate which route each event is along. This field can be numeric or character. event Type—The type of events in the overlay event table (POINT or LINE). from-Measure Field—A field containing measure values. This field must be numeric and is required when the event type is POINT or LINE. Note when the Event Type is POINT the label for this parameter becomes "Measure Field". to-Measure Field—A 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 Overlay Event Table Properties

setOverlayEventProperties

public void setOverlayEventProperties(Object overlayEventProperties)

Sets the Overlay Event Table Properties parameter of this tool . This parameter is parameter consisting of the route location fields and the type of events in the overlay event table. route Identifier Field—The field containing values that indicate which route each event is along. This field can be numeric or character. event Type—The type of events in the overlay event table (POINT or LINE). from-Measure Field—A field containing measure values. This field must be numeric and is required when the event type is POINT or LINE. Note when the Event Type is POINT the label for this parameter becomes "Measure Field". to-Measure Field—A field containing measure values. This field must be numeric and is required when the event type is LINE. This is a required parameter.

Parameters:

overlayEventProperties - parameter consisting of the route location fields and the type of events in the overlay event table. route Identifier Field—The field containing values that indicate which route each event is along. This field can be numeric or character. event Type—The type of events in the overlay event table (POINT or LINE). from-Measure Field—A field containing measure values. This field must be numeric and is required when the event type is POINT or LINE. Note when the Event Type is POINT the label for this parameter becomes "Measure Field". to-Measure Field—A field containing measure values. This field must be numeric and is required when the event type is LINE.

getOverlayType

public String getOverlayType()

Returns the Type of Overlay parameter of this tool . This parameter is the type of overlay to be performed. This is a required parameter.

Returns:

the Type of Overlay

setOverlayType

public void setOverlayType(String overlayType)

Sets the Type of Overlay parameter of this tool . This parameter is the type of overlay to be performed. This is a required parameter.

Parameters:

overlayType - the type of overlay to be performed.

getOutTable

public 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(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 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(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.

getZeroLengthEvents

public String getZeroLengthEvents()

Returns the Keep zero length line events parameter of this tool . This parameter is specifies whether to keep zero length line events in the output table. This parameter is only valid when the output event type is LINE. This is an optional parameter.

Returns:

the Keep zero length line events

setZeroLengthEvents

public void setZeroLengthEvents(String zeroLengthEvents)

Sets the Keep zero length line events parameter of this tool . This parameter is specifies whether to keep zero length line events in the output table. This parameter is only valid when the output event type is LINE. This is an optional parameter.

Parameters:

zeroLengthEvents - specifies whether to keep zero length line events in the output table. This parameter is only valid when the output event type is LINE.

getInFields

public String getInFields()

Returns the Include all fields from input parameter of this tool . This parameter is specifies whether all the fields from the input and overlay event tables will be written to the output event table. This is an optional parameter.

Returns:

the Include all fields from input

setInFields

public void setInFields(String inFields)

Sets the Include all fields from input parameter of this tool . This parameter is specifies whether all the fields from the input and overlay event tables will be written to the output event table. This is an optional parameter.

Parameters:

inFields - specifies whether all the fields from the input and overlay event tables will be written to the output event table.

getBuildIndex

public 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(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 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