com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class SelectLayerByLocation

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.SelectLayerByLocation

All Implemented Interfaces:

GPTool

public class SelectLayerByLocation
extends AbstractGPTool

Adds, updates, or removes a layer's selection based on a spatial relationship to features in another layer. The Select Layer By Location tool is contained in the Data Management Tools tool box.

Usage tips:

• The input must be a feature layer; it cannot be a feature class.
• This tool works on layers in the ArcMap table of contents, and also on layers created in ArcCatalog or in scripts using the tool.
• The coordinate system in which the spatial relationship is evaluated can affect the result. Features which intersect when projected to one coordinate system may not intersect in another. Spatial relationships are evaluated in the coordinate system of the Input Feature Layer's data source. Setting the will cause the evaluation of the spatial relationship to in a specified coordinate system. The Select By Location functionality available from the Selection menu in ArcMap, ArcScene and ArcGlobe all perform the operation in the same coordinate system as the application's display. To match this coordinate system with this tool set the output coordinate system to "same as display").
• This tool can be used to select features based on their spatial relationships to other features within the same layer. For examples see:
• The tool can be used to find the number of features selected by the Select Layer By Location tool. This can be useful for determining if any features were selected before continuing to further analysis in a script or model.
• For more information about using the three-dimensional spatial relationships (INTERSECT_3D, WITHIN_A_DISTANCE_3D), see .

Field Summary

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

vals

Constructor Summary

SelectLayerByLocation()
Creates the Select Layer By Location tool with defaults.

SelectLayerByLocation(Object inLayer)
Creates the Select Layer By Location tool with the required parameters.

Method Summary

Object	getInLayer() Returns the Input Feature Layer parameter of this tool .
Object	getOutLayerOrView() Returns the Output Layer Name parameter of this tool (Read only).
String	getOverlapType() Returns the Relationship parameter of this tool .
Object	getSearchDistance() Returns the Search Distance parameter of this tool .
Object	getSelectFeatures() Returns the Selecting Features parameter of this tool .
String	getSelectionType() Returns the Selection type 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	setInLayer(Object inLayer) Sets the Input Feature Layer parameter of this tool .
void	setOverlapType(String overlapType) Sets the Relationship parameter of this tool .
void	setSearchDistance(Object searchDistance) Sets the Search Distance parameter of this tool .
void	setSelectFeatures(Object selectFeatures) Sets the Selecting Features parameter of this tool .
void	setSelectionType(String selectionType) Sets the Selection type 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

SelectLayerByLocation

public SelectLayerByLocation()

Creates the Select Layer By Location tool with defaults.

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

SelectLayerByLocation

public SelectLayerByLocation(Object inLayer)

Creates the Select Layer By Location 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:

inLayer - the layer containing the features which be evaluated against the Selecting Features. The selection will be applied to this layer. The input can be a layer in the ArcMap table of contents, or a layer created in ArcCatalog or in scripts using the Make Feature Layer tool. The input cannot be the path to a feature class on disk.

Method Detail

getInLayer

public Object getInLayer()

Returns the Input Feature Layer parameter of this tool . This parameter is the layer containing the features which be evaluated against the Selecting Features. The selection will be applied to this layer. The input can be a layer in the ArcMap table of contents, or a layer created in ArcCatalog or in scripts using the Make Feature Layer tool. The input cannot be the path to a feature class on disk. This is a required parameter.

Returns:

the Input Feature Layer

setInLayer

public void setInLayer(Object inLayer)

Sets the Input Feature Layer parameter of this tool . This parameter is the layer containing the features which be evaluated against the Selecting Features. The selection will be applied to this layer. The input can be a layer in the ArcMap table of contents, or a layer created in ArcCatalog or in scripts using the Make Feature Layer tool. The input cannot be the path to a feature class on disk. This is a required parameter.

Parameters:

inLayer - the layer containing the features which be evaluated against the Selecting Features. The selection will be applied to this layer. The input can be a layer in the ArcMap table of contents, or a layer created in ArcCatalog or in scripts using the Make Feature Layer tool. The input cannot be the path to a feature class on disk.

getOverlapType

public String getOverlapType()

Returns the Relationship parameter of this tool . This parameter is the spatial relationship to be evaluated. This is an optional parameter.

Returns:

the Relationship

setOverlapType

public void setOverlapType(String overlapType)

Sets the Relationship parameter of this tool . This parameter is the spatial relationship to be evaluated. This is an optional parameter.

Parameters:

overlapType - the spatial relationship to be evaluated.

getSelectFeatures

public Object getSelectFeatures()

Returns the Selecting Features parameter of this tool . This parameter is the features in the Input Feature Layer will be selected based on their relationship to the features from this layer or feature class. This is an optional parameter.

Returns:

the Selecting Features

setSelectFeatures

public void setSelectFeatures(Object selectFeatures)

Sets the Selecting Features parameter of this tool . This parameter is the features in the Input Feature Layer will be selected based on their relationship to the features from this layer or feature class. This is an optional parameter.

Parameters:

selectFeatures - the features in the Input Feature Layer will be selected based on their relationship to the features from this layer or feature class.

getSearchDistance

public Object getSearchDistance()

Returns the Search Distance parameter of this tool . This parameter is this parameter is only valid if the Relationship parameter is set to one of the following: WITHIN_A_DISTANCE, WITHIN_A_DISTANCE_3D, INTERSECT, INTERSECT_3D, HAVE_THEIR_CENTER_IN, CONTAINS, WITHIN. This is an optional parameter.

Returns:

the Search Distance

setSearchDistance

public void setSearchDistance(Object searchDistance)

Sets the Search Distance parameter of this tool . This parameter is this parameter is only valid if the Relationship parameter is set to one of the following: WITHIN_A_DISTANCE, WITHIN_A_DISTANCE_3D, INTERSECT, INTERSECT_3D, HAVE_THEIR_CENTER_IN, CONTAINS, WITHIN. This is an optional parameter.

Parameters:

searchDistance - this parameter is only valid if the Relationship parameter is set to one of the following: WITHIN_A_DISTANCE, WITHIN_A_DISTANCE_3D, INTERSECT, INTERSECT_3D, HAVE_THEIR_CENTER_IN, CONTAINS, WITHIN.

getSelectionType

public String getSelectionType()

Returns the Selection type parameter of this tool . This parameter is determines how the selection will be applied to the input, and how to combine with an existing selection. Note that there is no option here to clear an existing selection. To clear a selection use the CLEAR_SELECTION option on the Select Layer By Attribute Tool. This is an optional parameter.

Returns:

the Selection type

setSelectionType

public void setSelectionType(String selectionType)

Sets the Selection type parameter of this tool . This parameter is determines how the selection will be applied to the input, and how to combine with an existing selection. Note that there is no option here to clear an existing selection. To clear a selection use the CLEAR_SELECTION option on the Select Layer By Attribute Tool. This is an optional parameter.

Parameters:

selectionType - determines how the selection will be applied to the input, and how to combine with an existing selection. Note that there is no option here to clear an existing selection. To clear a selection use the CLEAR_SELECTION option on the Select Layer By Attribute Tool.

getOutLayerOrView

public Object getOutLayerOrView()

Returns the Output Layer Name parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Layer Name

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