com.esri.arcgis.geoprocessing.tools.networkanalysttools
Class AddLocations

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

public class AddLocations
extends AbstractGPTool

Adds network locations to a network analysis layer. The Add Locations tool is contained in the Network Analyst Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
AddLocations()
          Creates the Add Locations tool with defaults.
AddLocations(Object inNetworkAnalysisLayer, String subLayer, Object inTable, Object fieldMappings, Object searchTolerance)
          Creates the Add Locations tool with the required parameters.
 
Method Summary
 String getAppend()
          Returns the Append to existing locations parameter of this tool .
 Object getFieldMappings()
          Returns the Field mappings parameter of this tool .
 Object getInNetworkAnalysisLayer()
          Returns the Input network analysis layer parameter of this tool .
 Object getInTable()
          Returns the Input locations parameter of this tool .
 String getMatchType()
          Returns the Find closest among all classes parameter of this tool .
 Object getOutputLayer()
          Returns the Network Analyst Layer parameter of this tool (Read only).
 Object getSearchCriteria()
          Returns the Search criteria parameter of this tool .
 Object getSearchTolerance()
          Returns the Search tolerance parameter of this tool .
 Object getSnapOffset()
          Returns the Snap Offset parameter of this tool .
 String getSnapToPositionAlongNetwork()
          Returns the Snap to Network parameter of this tool .
 Object getSortField()
          Returns the Sort field parameter of this tool .
 String getSubLayer()
          Returns the Sub layer 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 setAppend(String append)
          Sets the Append to existing locations parameter of this tool .
 void setFieldMappings(Object fieldMappings)
          Sets the Field mappings parameter of this tool .
 void setInNetworkAnalysisLayer(Object inNetworkAnalysisLayer)
          Sets the Input network analysis layer parameter of this tool .
 void setInTable(Object inTable)
          Sets the Input locations parameter of this tool .
 void setMatchType(String matchType)
          Sets the Find closest among all classes parameter of this tool .
 void setSearchCriteria(Object searchCriteria)
          Sets the Search criteria parameter of this tool .
 void setSearchTolerance(Object searchTolerance)
          Sets the Search tolerance parameter of this tool .
 void setSnapOffset(Object snapOffset)
          Sets the Snap Offset parameter of this tool .
 void setSnapToPositionAlongNetwork(String snapToPositionAlongNetwork)
          Sets the Snap to Network parameter of this tool .
 void setSortField(Object sortField)
          Sets the Sort field parameter of this tool .
 void setSubLayer(String subLayer)
          Sets the Sub layer 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

AddLocations

public AddLocations()
Creates the Add Locations tool with defaults.

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


AddLocations

public AddLocations(Object inNetworkAnalysisLayer,
                    String subLayer,
                    Object inTable,
                    Object fieldMappings,
                    Object searchTolerance)
Creates the Add Locations 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:
inNetworkAnalysisLayer - Network Analyst Layer, network analysis layer to which network locations will be added.
subLayer - String, adds network locations to the selected sublayer of the input network analysis layer.
inTable - Table View, the feature class or layer that is the source for the new network locations.
fieldMappings - Network Analyst Field Map, sets the values for the properties of the network locations. Properties can be set to a constant or mapped to a field on the input feature class.
searchTolerance - Linear Unit, the search tolerance for locating the input features on the network. The parameter includes a value and units for the tolerance.
Method Detail

getInNetworkAnalysisLayer

public Object getInNetworkAnalysisLayer()
Returns the Input network analysis layer parameter of this tool . This parameter is Network Analyst Layer, network analysis layer to which network locations will be added. This is a required parameter.

Returns:
the Input network analysis layer

setInNetworkAnalysisLayer

public void setInNetworkAnalysisLayer(Object inNetworkAnalysisLayer)
Sets the Input network analysis layer parameter of this tool . This parameter is Network Analyst Layer, network analysis layer to which network locations will be added. This is a required parameter.

Parameters:
inNetworkAnalysisLayer - Network Analyst Layer, network analysis layer to which network locations will be added.

getSubLayer

public String getSubLayer()
Returns the Sub layer parameter of this tool . This parameter is String, adds network locations to the selected sublayer of the input network analysis layer. This is a required parameter.

Returns:
the Sub layer

setSubLayer

public void setSubLayer(String subLayer)
Sets the Sub layer parameter of this tool . This parameter is String, adds network locations to the selected sublayer of the input network analysis layer. This is a required parameter.

Parameters:
subLayer - String, adds network locations to the selected sublayer of the input network analysis layer.

getInTable

public Object getInTable()
Returns the Input locations parameter of this tool . This parameter is Table View, the feature class or layer that is the source for the new network locations. This is a required parameter.

Returns:
the Input locations

setInTable

public void setInTable(Object inTable)
Sets the Input locations parameter of this tool . This parameter is Table View, the feature class or layer that is the source for the new network locations. This is a required parameter.

Parameters:
inTable - Table View, the feature class or layer that is the source for the new network locations.

getFieldMappings

public Object getFieldMappings()
Returns the Field mappings parameter of this tool . This parameter is Network Analyst Field Map, sets the values for the properties of the network locations. Properties can be set to a constant or mapped to a field on the input feature class. This is a required parameter.

Returns:
the Field mappings

setFieldMappings

public void setFieldMappings(Object fieldMappings)
Sets the Field mappings parameter of this tool . This parameter is Network Analyst Field Map, sets the values for the properties of the network locations. Properties can be set to a constant or mapped to a field on the input feature class. This is a required parameter.

Parameters:
fieldMappings - Network Analyst Field Map, sets the values for the properties of the network locations. Properties can be set to a constant or mapped to a field on the input feature class.

getSearchTolerance

public Object getSearchTolerance()
Returns the Search tolerance parameter of this tool . This parameter is Linear Unit, the search tolerance for locating the input features on the network. The parameter includes a value and units for the tolerance. This is a required parameter.

Returns:
the Search tolerance

setSearchTolerance

public void setSearchTolerance(Object searchTolerance)
Sets the Search tolerance parameter of this tool . This parameter is Linear Unit, the search tolerance for locating the input features on the network. The parameter includes a value and units for the tolerance. This is a required parameter.

Parameters:
searchTolerance - Linear Unit, the search tolerance for locating the input features on the network. The parameter includes a value and units for the tolerance.

getSortField

public Object getSortField()
Returns the Sort field parameter of this tool . This parameter is Field, a field in which to sort the locations as they are added to the network analysis layer. This is an optional parameter.

Returns:
the Sort field

setSortField

public void setSortField(Object sortField)
Sets the Sort field parameter of this tool . This parameter is Field, a field in which to sort the locations as they are added to the network analysis layer. This is an optional parameter.

Parameters:
sortField - Field, a field in which to sort the locations as they are added to the network analysis layer.

getSearchCriteria

public Object getSearchCriteria()
Returns the Search criteria parameter of this tool . This parameter is String, allows you to specify which sources in your network dataset will be searched when finding locations, as well as specifying what portions of geometry will be used. This is an optional parameter.

Returns:
the Search criteria

setSearchCriteria

public void setSearchCriteria(Object searchCriteria)
Sets the Search criteria parameter of this tool . This parameter is String, allows you to specify which sources in your network dataset will be searched when finding locations, as well as specifying what portions of geometry will be used. This is an optional parameter.

Parameters:
searchCriteria - String, allows you to specify which sources in your network dataset will be searched when finding locations, as well as specifying what portions of geometry will be used.

getMatchType

public String getMatchType()
Returns the Find closest among all classes parameter of this tool . This parameter is String, specifies whether or not to match new network locations to the closest element of any class in the network analysis layer This is an optional parameter.

Returns:
the Find closest among all classes

setMatchType

public void setMatchType(String matchType)
Sets the Find closest among all classes parameter of this tool . This parameter is String, specifies whether or not to match new network locations to the closest element of any class in the network analysis layer This is an optional parameter.

Parameters:
matchType - String, specifies whether or not to match new network locations to the closest element of any class in the network analysis layer

getAppend

public String getAppend()
Returns the Append to existing locations parameter of this tool . This parameter is String, specifies whether or not to append new network locations to existing locations. This is an optional parameter.

Returns:
the Append to existing locations

setAppend

public void setAppend(String append)
Sets the Append to existing locations parameter of this tool . This parameter is String, specifies whether or not to append new network locations to existing locations. This is an optional parameter.

Parameters:
append - String, specifies whether or not to append new network locations to existing locations.

getSnapToPositionAlongNetwork

public String getSnapToPositionAlongNetwork()
Returns the Snap to Network parameter of this tool . This parameter is String, specifies whether or not the new network locations should snap to positions on the network source features where they are located. This is an optional parameter.

Returns:
the Snap to Network

setSnapToPositionAlongNetwork

public void setSnapToPositionAlongNetwork(String snapToPositionAlongNetwork)
Sets the Snap to Network parameter of this tool . This parameter is String, specifies whether or not the new network locations should snap to positions on the network source features where they are located. This is an optional parameter.

Parameters:
snapToPositionAlongNetwork - String, specifies whether or not the new network locations should snap to positions on the network source features where they are located.

getSnapOffset

public Object getSnapOffset()
Returns the Snap Offset parameter of this tool . This parameter is Long, when snapping a point to the network, you can apply an offset distance. An offset distance of zero means the point will be coincident with the network feature (typically a line). To offset the point from the network feature, enter an offset distance. The offset is in relation to the original point location. That is, if the original point was on the left side, its new location will be offset to the left. If it was originally on the right side, its new location will be offset to the right. This is an optional parameter.

Returns:
the Snap Offset

setSnapOffset

public void setSnapOffset(Object snapOffset)
Sets the Snap Offset parameter of this tool . This parameter is Long, when snapping a point to the network, you can apply an offset distance. An offset distance of zero means the point will be coincident with the network feature (typically a line). To offset the point from the network feature, enter an offset distance. The offset is in relation to the original point location. That is, if the original point was on the left side, its new location will be offset to the left. If it was originally on the right side, its new location will be offset to the right. This is an optional parameter.

Parameters:
snapOffset - Long, when snapping a point to the network, you can apply an offset distance. An offset distance of zero means the point will be coincident with the network feature (typically a line). To offset the point from the network feature, enter an offset distance. The offset is in relation to the original point location. That is, if the original point was on the left side, its new location will be offset to the left. If it was originally on the right side, its new location will be offset to the right.

getOutputLayer

public Object getOutputLayer()
Returns the Network Analyst Layer parameter of this tool (Read only). This is an derived parameter.

Returns:
the Network Analyst Layer

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