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

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

All Implemented Interfaces:

GPTool

public class PivotTable
extends AbstractGPTool

Sorts and summarizes the input table fields, based on the selected pivot field and value field, in the output table to reduce redundancy. The Pivot Table tool is contained in the Data Management Tools tool box.

Software restrictions: ArcInfo only

Illustration:

Usage tips:

• Pivot Table is used to reduce redundant records and flatten one-to-many relationships.
• If the pivot field is a numeric type, its value will be appended to its original field name in the output table.
• Pivot Table can be used to normalize the one-to-many relationship between CAD objects and attribute tags created by Import From CAD; in the Attrib table of the Staging Geodatabase;
• The Input Field(s) parameter's Add Field button is used only in ModelBuilder. In ModelBuilder, where the preceding tool has not been run, or its derived data does not exist, the Input Field(s) parameter may not be populated with field names. The Add Field button allows you to add expected field(s) so you can complete the Pivot Table dialog and continue to build your model.
• The following environments affect this tool: configKeyword; scratchWorkspace; , and workspace;

Field Summary

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

vals

Constructor Summary

PivotTable()
Creates the Pivot Table tool with defaults.

PivotTable(Object inTable, Object fields, Object pivotField, Object valueField, Object outTable)
Creates the Pivot Table tool with the required parameters.

Method Summary

Object	getFields() Returns the Input Field(s) parameter of this tool .
Object	getInTable() Returns the Input Table parameter of this tool .
Object	getOutTable() Returns the Output Table parameter of this tool .
Object	getPivotField() Returns the Pivot 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	getValueField() Returns the Value Field parameter of this tool .
void	setFields(Object fields) Sets the Input Field(s) parameter of this tool .
void	setInTable(Object inTable) Sets the Input Table parameter of this tool .
void	setOutTable(Object outTable) Sets the Output Table parameter of this tool .
void	setPivotField(Object pivotField) Sets the Pivot Field parameter of this tool .
void	setValueField(Object valueField) Sets the Value Field 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

PivotTable

public PivotTable()

Creates the Pivot Table tool with defaults.

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

PivotTable

public PivotTable(Object inTable,
                  Object fields,
                  Object pivotField,
                  Object valueField,
                  Object outTable)

Creates the Pivot Table 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:

inTable - Table View, the table whose records will be pivoted.

fields - Field, the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so you can complete the dialog and continue to build your model.

pivotField - Field, the field whose record values will be used to generate names of new fields in the output table.

valueField - Field, the field containing values used to populate the new fields in the output table.

outTable - Table, the table to be created.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is Table View, the table whose records will be pivoted. This is a required parameter.

Returns:

the Input Table

setInTable

public void setInTable(Object inTable)

Sets the Input Table parameter of this tool . This parameter is Table View, the table whose records will be pivoted. This is a required parameter.

Parameters:

inTable - Table View, the table whose records will be pivoted.

getFields

public Object getFields()

Returns the Input Field(s) parameter of this tool . This parameter is Field, the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so you can complete the dialog and continue to build your model. This is a required parameter.

Returns:

the Input Field(s)

setFields

public void setFields(Object fields)

Sets the Input Field(s) parameter of this tool . This parameter is Field, the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so you can complete the dialog and continue to build your model. This is a required parameter.

Parameters:

fields - Field, the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so you can complete the dialog and continue to build your model.

getPivotField

public Object getPivotField()

Returns the Pivot Field parameter of this tool . This parameter is Field, the field whose record values will be used to generate names of new fields in the output table. This is a required parameter.

Returns:

the Pivot Field

setPivotField

public void setPivotField(Object pivotField)

Sets the Pivot Field parameter of this tool . This parameter is Field, the field whose record values will be used to generate names of new fields in the output table. This is a required parameter.

Parameters:

pivotField - Field, the field whose record values will be used to generate names of new fields in the output table.

getValueField

public Object getValueField()

Returns the Value Field parameter of this tool . This parameter is Field, the field containing values used to populate the new fields in the output table. This is a required parameter.

Returns:

the Value Field

setValueField

public void setValueField(Object valueField)

Sets the Value Field parameter of this tool . This parameter is Field, the field containing values used to populate the new fields in the output table. This is a required parameter.

Parameters:

valueField - Field, the field containing values used to populate the new fields in the output table.

getOutTable

public Object getOutTable()

Returns the Output Table parameter of this tool . This parameter is Table, the table to be created. This is a required parameter.

Returns:

the Output Table

setOutTable

public void setOutTable(Object outTable)

Sets the Output Table parameter of this tool . This parameter is Table, the table to be created. This is a required parameter.

Parameters:

outTable - Table, the table to be created.

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