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

Creates a new table from an input table. The fields on the output table are based on the input pivot field. Values in the new fields are based on the input value field. The Pivot Table tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool is typically 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.
• The Input Field(s) parameter's Add Field button is used only in ModelBuilder to access and load the expected fields of a preceding process that has not yet been run into the Input Field(s) list so you can complete the Pivot Table dialog box and continue to build the model.

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 - the table whose records will be pivoted.

fields - the fields that define records to be included in the output table.

pivotField - the field whose record values are used to generate the field names in the output table.

valueField - the field whose values populate the pivoted fields in the output table.

outTable - the table to be created.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is 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 the table whose records will be pivoted. This is a required parameter.

Parameters:

inTable - the table whose records will be pivoted.

getFields

public Object getFields()

Returns the Input Field(s) parameter of this tool . This parameter is the fields that define records to be included in the output table. 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 the fields that define records to be included in the output table. This is a required parameter.

Parameters:

fields - the fields that define records to be included in the output table.

getPivotField

public Object getPivotField()

Returns the Pivot Field parameter of this tool . This parameter is the field whose record values are used to generate the field names 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 the field whose record values are used to generate the field names in the output table. This is a required parameter.

Parameters:

pivotField - the field whose record values are used to generate the field names in the output table.

getValueField

public Object getValueField()

Returns the Value Field parameter of this tool . This parameter is the field whose values populate the pivoted 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 the field whose values populate the pivoted fields in the output table. This is a required parameter.

Parameters:

valueField - the field whose values populate the pivoted fields in the output table.

getOutTable

public Object getOutTable()

Returns the Output Table parameter of this tool . This parameter is 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 the table to be created. This is a required parameter.

Parameters:

outTable - 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