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 selection on the input layer based on spatial relationships to features in another layer. The features in the Input Feature Layer are evaluated against each individual feature in the Selecting Features layer, if the Relationship is met, the feature will be selected. The Select Layer By Location tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• For examples of spatial relationships that will be selected by the overlap types, see Select by Location: Graphical examples;
• The input must be a feature layer; or a table view; . It cannot be a feature class; or table;
• This tool is not limited to working in ArcMap; it works on layers and table views in ArcCatalog and in scripts. The Make Feature Layer; tool makes a layer for a feature class, and the Make Table View; tool does the equivalent for a table.
• Learn more about working with layers and table views;
• If an extent or a definition query is present on the Input Feature Layer, only those features or rows that match the extent and/or definition query will be available to be selected.
• The Get Count; tool returns the number of features selected by the tool.
• This tool can be used to select features based on spatial relationships to other features within the layer. For further details and graphical examples of this click here;
• The following environment settings affect this tool: workspace; scratch workspace;

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 - Feature Layer, the input feature layer name. This can be a layer in ArcMap or a layer created by Make Layer in ArcCatalog or in a script.

Method Detail

getInLayer

public Object getInLayer()

Returns the Input Feature Layer parameter of this tool . This parameter is Feature Layer, the input feature layer name. This can be a layer in ArcMap or a layer created by Make Layer in ArcCatalog or in a script. 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 Feature Layer, the input feature layer name. This can be a layer in ArcMap or a layer created by Make Layer in ArcCatalog or in a script. This is a required parameter.

Parameters:

inLayer - Feature Layer, the input feature layer name. This can be a layer in ArcMap or a layer created by Make Layer in ArcCatalog or in a script.

getOverlapType

public String getOverlapType()

Returns the Relationship parameter of this tool . This parameter is String, the spatial relationship between the features in the input layer and the Select Layer on which the selection will be based. If textual description is unclear refer to the This is an optional parameter.

Returns:

the Relationship

setOverlapType

public void setOverlapType(String overlapType)

Sets the Relationship parameter of this tool . This parameter is String, the spatial relationship between the features in the input layer and the Select Layer on which the selection will be based. If textual description is unclear refer to the This is an optional parameter.

Parameters:

overlapType - String, the spatial relationship between the features in the input layer and the Select Layer on which the selection will be based. If textual description is unclear refer to the

getSelectFeatures

public Object getSelectFeatures()

Returns the Selecting Features parameter of this tool . This parameter is Feature Layer, the features in the input layer will be selected based on their topological 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 Feature Layer, the features in the input layer will be selected based on their topological relationship to the features from this layer or feature class. This is an optional parameter.

Parameters:

selectFeatures - Feature Layer, the features in the input layer will be selected based on their topological 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 Linear unit, the following Overlap type options do not support the search distance buffering: SHARE_A_LINE_SEGMENT_WITH and ARE_IDENTICAL_TO. 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 Linear unit, the following Overlap type options do not support the search distance buffering: SHARE_A_LINE_SEGMENT_WITH and ARE_IDENTICAL_TO. This is an optional parameter.

Parameters:

searchDistance - Linear unit, the following Overlap type options do not support the search distance buffering: SHARE_A_LINE_SEGMENT_WITH and ARE_IDENTICAL_TO.

getSelectionType

public String getSelectionType()

Returns the Selection type parameter of this tool . This parameter is String, determines how the selection will be applied and what to do if a selection already exists. 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 String, determines how the selection will be applied and what to do if a selection already exists. This is an optional parameter.

Parameters:

selectionType - String, determines how the selection will be applied and what to do if a selection already exists.

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