|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.esri.arcgis.geoprocessing.AbstractGPTool
com.esri.arcgis.geoprocessing.tools.datamanagementtools.FeatureCompare
public class FeatureCompare
Compares two feature classes or layers and returns the comparison results. Feature Compare can report differences with geometry, tabular values, spatial reference, and field definitions. The Feature Compare tool is contained in the Data Management Tools tool box.
Field Summary |
---|
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool |
---|
vals |
Constructor Summary | |
---|---|
FeatureCompare()
Creates the Feature Compare tool with defaults. |
|
FeatureCompare(Object inBaseFeatures,
Object inTestFeatures,
Object sortField)
Creates the Feature Compare tool with the required parameters. |
Method Summary | |
---|---|
Object |
getAttributeTolerances()
Returns the Attribute Tolerance parameter of this tool . |
String |
getCompareStatus()
Returns the Compare Status parameter of this tool (Read only). |
String |
getCompareType()
Returns the Compare Type parameter of this tool . |
String |
getContinueCompare()
Returns the Continue Comparison parameter of this tool . |
Object |
getIgnoreOptions()
Returns the Ignore Options parameter of this tool . |
Object |
getInBaseFeatures()
Returns the Input Base Features parameter of this tool . |
Object |
getInTestFeatures()
Returns the Input Test Features parameter of this tool . |
double |
getMTolerance()
Returns the M Tolerance parameter of this tool . |
Object |
getOmitField()
Returns the Omit Fields parameter of this tool . |
Object |
getOutCompareFile()
Returns the Output Compare File parameter of this tool . |
Object |
getSortField()
Returns the Sort Field 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 |
setAttributeTolerances(Object attributeTolerances)
Sets the Attribute Tolerance parameter of this tool . |
void |
setCompareType(String compareType)
Sets the Compare Type parameter of this tool . |
void |
setContinueCompare(String continueCompare)
Sets the Continue Comparison parameter of this tool . |
void |
setIgnoreOptions(Object ignoreOptions)
Sets the Ignore Options parameter of this tool . |
void |
setInBaseFeatures(Object inBaseFeatures)
Sets the Input Base Features parameter of this tool . |
void |
setInTestFeatures(Object inTestFeatures)
Sets the Input Test Features parameter of this tool . |
void |
setMTolerance(double mTolerance)
Sets the M Tolerance parameter of this tool . |
void |
setOmitField(Object omitField)
Sets the Omit Fields parameter of this tool . |
void |
setOutCompareFile(Object outCompareFile)
Sets the Output Compare File parameter of this tool . |
void |
setSortField(Object sortField)
Sets the Sort Field 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 |
---|
public FeatureCompare()
Initializes the array of tool parameters with the default values specified when the tool was created.
public FeatureCompare(Object inBaseFeatures, Object inTestFeatures, Object sortField)
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.
inBaseFeatures
- the Input Base Features are compared with the Input Test Features. Input Base features refers to data that you have declared valid. This base data has the correct geometry definitions, field definitions, and spatial reference.inTestFeatures
- the Input Test Features are compared against the Input Base Features. Input Test Features refers to data that you have made changes to by editing or compiling new features.sortField
- the field or fields used to sort records in the Input Base Table and the Input Test Table. The records are sorted in ascending order. Sorting by a common field in both the Input Base Features and the Input Test Features ensures that you are comparing the same row from each input dataset.Method Detail |
---|
public Object getInBaseFeatures()
public void setInBaseFeatures(Object inBaseFeatures)
inBaseFeatures
- the Input Base Features are compared with the Input Test Features. Input Base features refers to data that you have declared valid. This base data has the correct geometry definitions, field definitions, and spatial reference.public Object getInTestFeatures()
public void setInTestFeatures(Object inTestFeatures)
inTestFeatures
- the Input Test Features are compared against the Input Base Features. Input Test Features refers to data that you have made changes to by editing or compiling new features.public Object getSortField()
public void setSortField(Object sortField)
sortField
- the field or fields used to sort records in the Input Base Table and the Input Test Table. The records are sorted in ascending order. Sorting by a common field in both the Input Base Features and the Input Test Features ensures that you are comparing the same row from each input dataset.public String getCompareType()
public void setCompareType(String compareType)
compareType
- the comparision type. ALL is the default. The default will compare all properties of the features being compared.public Object getIgnoreOptions()
public void setIgnoreOptions(Object ignoreOptions)
ignoreOptions
- these properties will not be compared during comparison.public Object getXyTolerance()
public void setXyTolerance(Object xyTolerance)
xyTolerance
- the distance that determines the range in which features are considered equal. To minimize error, the value you choose for the compare tolerance should be as small as possible. By default, the compare tolerance is the XY Tolerance of the input base features.public double getMTolerance()
public void setMTolerance(double mTolerance)
mTolerance
- the measure tolerance is the minimum distance between measures before they are considered equal.public double getZTolerance()
public void setZTolerance(double zTolerance)
zTolerance
- the Z Tolerance is the minimum distance between Z coordinates before they are considered equal.public Object getAttributeTolerances()
public void setAttributeTolerances(Object attributeTolerances)
attributeTolerances
- the numeric value that determines the range in which attribute values are considered equal. This only applies to numeric field types.public Object getOmitField()
public void setOmitField(Object omitField)
omitField
- the field or fields that will be omitted during comparison. The field definitions and the tabular values for these fields will be ignored.public String getContinueCompare()
public void setContinueCompare(String continueCompare)
continueCompare
- indicates whether to compare all properties after encountering the first mismatch.public Object getOutCompareFile()
public void setOutCompareFile(Object outCompareFile)
outCompareFile
- this file will contain all similarities and differences between the Input Base Features and the Input Test Features. This file is a comma-delimited text file which can be viewed and used as a table in ArcGIS.public String getCompareStatus()
public String getToolName()
public String getToolboxName()
public String getToolboxAlias()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |