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

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

All Implemented Interfaces:

GPTool

public class FindIdentical
extends AbstractGPTool

Reports any records in a feature class or table that have identical values in a list of fields, and generates a table listing these identical records. If the field 'Shape' is selected, feature geometries are compared. The Find Identical tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool finds identical records based on input field values. The values from multiple fields in the input dataset can be compared. If more than one field is specified, records are matched by the values in the first field, then by the values of the second field, and so on.
• The output table will have the same number of records as the input dataset and will contain two fields: IN_FID and FEAT_SEQ. Identical records have the same FEAT_SEQ value. FEAT_SEQ values are generated by this tool—they have no relationship to object IDs. The IN_FID field can be used to join the output table to the input dataset based on FID.
• With feature class or feature layer input, select the field 'Shape' in the Field(s) parameter to compare feature geometries to find identical features by location. The XY Tolerance and Z Tolerance parameters are only valid when 'Shape' is selected as one of the input fields.

Field Summary

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

vals

Constructor Summary

FindIdentical()
Creates the Find Identical tool with defaults.

FindIdentical(Object inDataset, Object outDataset, Object fields)
Creates the Find Identical tool with the required parameters.

Method Summary

Object	getFields() Returns the Field(s) parameter of this tool .
Object	getInDataset() Returns the Input Dataset parameter of this tool .
Object	getOutDataset() Returns the Output Dataset 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.
Object	getXyTolerance() Returns the XY Tolerance parameter of this tool .
double	getZTolerance() Returns the Z Tolerance parameter of this tool .
void	setFields(Object fields) Sets the Field(s) parameter of this tool .
void	setInDataset(Object inDataset) Sets the Input Dataset parameter of this tool .
void	setOutDataset(Object outDataset) Sets the Output Dataset parameter of this tool .
void	setXyTolerance(Object xyTolerance) Sets the XY Tolerance parameter of this tool .
void	setZTolerance(double zTolerance) Sets the Z Tolerance 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

FindIdentical

public FindIdentical()

Creates the Find Identical tool with defaults.

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

FindIdentical

public FindIdentical(Object inDataset,
                     Object outDataset,
                     Object fields)

Creates the Find Identical 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:

inDataset - the table or feature class for which identical records will be found.

outDataset - the output table reporting any identical records. This table will have the same number of records as the input dataset and will contain two fields: IN_FID and FEAT_SEQ. Identical records have the same FEAT_SEQ value.

fields - the field(s) whose values will be compared to find identical records.

Method Detail

getInDataset

public Object getInDataset()

Returns the Input Dataset parameter of this tool . This parameter is the table or feature class for which identical records will be found. This is a required parameter.

Returns:

the Input Dataset

setInDataset

public void setInDataset(Object inDataset)

Sets the Input Dataset parameter of this tool . This parameter is the table or feature class for which identical records will be found. This is a required parameter.

Parameters:

inDataset - the table or feature class for which identical records will be found.

getOutDataset

public Object getOutDataset()

Returns the Output Dataset parameter of this tool . This parameter is the output table reporting any identical records. This table will have the same number of records as the input dataset and will contain two fields: IN_FID and FEAT_SEQ. Identical records have the same FEAT_SEQ value. This is a required parameter.

Returns:

the Output Dataset

setOutDataset

public void setOutDataset(Object outDataset)

Sets the Output Dataset parameter of this tool . This parameter is the output table reporting any identical records. This table will have the same number of records as the input dataset and will contain two fields: IN_FID and FEAT_SEQ. Identical records have the same FEAT_SEQ value. This is a required parameter.

Parameters:

outDataset - the output table reporting any identical records. This table will have the same number of records as the input dataset and will contain two fields: IN_FID and FEAT_SEQ. Identical records have the same FEAT_SEQ value.

getFields

public Object getFields()

Returns the Field(s) parameter of this tool . This parameter is the field(s) whose values will be compared to find identical records. This is a required parameter.

Returns:

the Field(s)

setFields

public void setFields(Object fields)

Sets the Field(s) parameter of this tool . This parameter is the field(s) whose values will be compared to find identical records. This is a required parameter.

Parameters:

fields - the field(s) whose values will be compared to find identical records.

getXyTolerance

public Object getXyTolerance()

Returns the XY Tolerance parameter of this tool . This parameter is the xy tolerance which will be applied to each vertex when evaluating if there is an identical vertex in another feature. This parameter is enabled only when 'Shape' is selected as one of the fields. This is an optional parameter.

Returns:

the XY Tolerance

setXyTolerance

public void setXyTolerance(Object xyTolerance)

Sets the XY Tolerance parameter of this tool . This parameter is the xy tolerance which will be applied to each vertex when evaluating if there is an identical vertex in another feature. This parameter is enabled only when 'Shape' is selected as one of the fields. This is an optional parameter.

Parameters:

xyTolerance - the xy tolerance which will be applied to each vertex when evaluating if there is an identical vertex in another feature. This parameter is enabled only when 'Shape' is selected as one of the fields.

getZTolerance

public double getZTolerance()

Returns the Z Tolerance parameter of this tool . This parameter is the z tolerance which will be applied to each vertex when evaluating if there is an identical vertex in another feature. This parameter is enabled only when 'Shape' is selected as one of the fields. This is an optional parameter.

Returns:

the Z Tolerance

setZTolerance

public void setZTolerance(double zTolerance)

Sets the Z Tolerance parameter of this tool . This parameter is the z tolerance which will be applied to each vertex when evaluating if there is an identical vertex in another feature. This parameter is enabled only when 'Shape' is selected as one of the fields. This is an optional parameter.

Parameters:

zTolerance - the z tolerance which will be applied to each vertex when evaluating if there is an identical vertex in another feature. This parameter is enabled only when 'Shape' is selected as one of the fields.

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