com.esri.arcgis.geoprocessing.tools.cartographytools
Class SelectFeatureByOverride

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.cartographytools.SelectFeatureByOverride

All Implemented Interfaces:

GPTool

public class SelectFeatureByOverride
extends AbstractGPTool

Selects features that have representation geometry and/or property overrides. The Select Feature By Override tool is contained in the Cartography Tools tool box.

Usage tips:

• Input Features must be a layer whose source is a geodatabase feature class with at least one feature class representation.
• The output is a selected set, so the results can only be used in models, scripts, and in ArcMap sessions.
• Representation geometry overrides are sometimes called representation shape overrides.

Field Summary

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

vals

Constructor Summary

SelectFeatureByOverride()
Creates the Select Feature By Override tool with defaults.

SelectFeatureByOverride(Object inFeatures)
Creates the Select Feature By Override tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input Features With Representations parameter of this tool .
Object	getOutFeatures() Returns the Output Features parameter of this tool (Read only).
String	getSelectOption() Returns the Select Option 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	setInFeatures(Object inFeatures) Sets the Input Features With Representations parameter of this tool .
void	setSelectOption(String selectOption) Sets the Select Option 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

SelectFeatureByOverride

public SelectFeatureByOverride()

Creates the Select Feature By Override tool with defaults.

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

SelectFeatureByOverride

public SelectFeatureByOverride(Object inFeatures)

Creates the Select Feature By Override 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:

inFeatures - the input feature layer containing representations.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features With Representations parameter of this tool . This parameter is the input feature layer containing representations. This is a required parameter.

Returns:

the Input Features With Representations

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features With Representations parameter of this tool . This parameter is the input feature layer containing representations. This is a required parameter.

Parameters:

inFeatures - the input feature layer containing representations.

getSelectOption

public String getSelectOption()

Returns the Select Option parameter of this tool . This parameter is specifies the type of representation override to use as a selection criterion. This is an optional parameter.

Returns:

the Select Option

setSelectOption

public void setSelectOption(String selectOption)

Sets the Select Option parameter of this tool . This parameter is specifies the type of representation override to use as a selection criterion. This is an optional parameter.

Parameters:

selectOption - specifies the type of representation override to use as a selection criterion.

getOutFeatures

public Object getOutFeatures()

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

Returns:

the Output Features

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