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

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

All Implemented Interfaces:

GPTool

public class Sort
extends AbstractGPTool

This tool reorders, in ascending or descending order, records in a feature class or table based on field values. The reordered result is copied to a new dataset. The Sort tool is contained in the Data Management Tools tool box.

Usage tips:

• Feature classes can be spatially reordered, or sorted. The 'Shape' field must be used as the sort field for spatial sorting. There are a number of spatial sort methods that arrange the features differently based on their location.
• Geodatabase and SDE feature classes, shapefiles, feature layers, tables, and table views are valid inputs. Individual components of CAD and SDC datasets are also valid inputs.
• If any input records are selected, only the subset of selected records are sorted and copied to the output.
• If more than one field is set as a sort field, rows are first sorted by the first field and within that order sorted by the second field, and so on.
• Polygon features can be sorted by their area using the Shape_Area field of a geodatabase feature class. Similarly, polyline features can be sorted by their length using the Shape_Length field. If you want to sort polygon features in a Shapefile add a new field, calculate the area into the new field using and run Sort using the new field.

Field Summary

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

vals

Constructor Summary

Sort()
Creates the Sort tool with defaults.

Sort(Object inDataset, Object outDataset, Object sortField)
Creates the Sort tool with the required parameters.

Method Summary

Object	getInDataset() Returns the Input Dataset parameter of this tool .
Object	getOutDataset() Returns the Output Dataset parameter of this tool .
Object	getSortField() Returns the Field(s) parameter of this tool .
String	getSpatialSortMethod() Returns the Spatial Sort Method 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	setInDataset(Object inDataset) Sets the Input Dataset parameter of this tool .
void	setOutDataset(Object outDataset) Sets the Output Dataset parameter of this tool .
void	setSortField(Object sortField) Sets the Field(s) parameter of this tool .
void	setSpatialSortMethod(String spatialSortMethod) Sets the Spatial Sort Method 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

Sort

public Sort()

Creates the Sort tool with defaults.

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

Sort

public Sort(Object inDataset,
            Object outDataset,
            Object sortField)

Creates the Sort 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 input dataset whose records will be reordered based on the field values in the sort field(s).

outDataset - the output feature class or table.

sortField - specifies the field(s) whose values will be used to reorder the input records, and the direction the records will be sorted.

Method Detail

getInDataset

public Object getInDataset()

Returns the Input Dataset parameter of this tool . This parameter is the input dataset whose records will be reordered based on the field values in the sort field(s). 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 input dataset whose records will be reordered based on the field values in the sort field(s). This is a required parameter.

Parameters:

inDataset - the input dataset whose records will be reordered based on the field values in the sort field(s).

getOutDataset

public Object getOutDataset()

Returns the Output Dataset parameter of this tool . This parameter is the output feature class or table. 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 feature class or table. This is a required parameter.

Parameters:

outDataset - the output feature class or table.

getSortField

public Object getSortField()

Returns the Field(s) parameter of this tool . This parameter is specifies the field(s) whose values will be used to reorder the input records, and the direction the records will be sorted. This is a required parameter.

Returns:

the Field(s)

setSortField

public void setSortField(Object sortField)

Sets the Field(s) parameter of this tool . This parameter is specifies the field(s) whose values will be used to reorder the input records, and the direction the records will be sorted. This is a required parameter.

Parameters:

sortField - specifies the field(s) whose values will be used to reorder the input records, and the direction the records will be sorted.

getSpatialSortMethod

public String getSpatialSortMethod()

Returns the Spatial Sort Method parameter of this tool . This parameter is specifies how features are spatially sorted. Sort method is only enabled when 'Shape' is selected as one of the sort fields. This is an optional parameter.

Returns:

the Spatial Sort Method

setSpatialSortMethod

public void setSpatialSortMethod(String spatialSortMethod)

Sets the Spatial Sort Method parameter of this tool . This parameter is specifies how features are spatially sorted. Sort method is only enabled when 'Shape' is selected as one of the sort fields. This is an optional parameter.

Parameters:

spatialSortMethod - specifies how features are spatially sorted. Sort method is only enabled when 'Shape' is selected as one of the sort 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