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

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

All Implemented Interfaces:

GPTool

public class TransposeFields
extends AbstractGPTool

Shifts data entered in fields or columns into rows in a table or feature class. The Transpose Fields tool is contained in the Data Management Tools tool box.

Usage tips:

• By default, the output is a geodatabase table. However, if you want to transpose the fields in a feature class you can choose to either output a geodatabase table or output a feature class with the transposed fields. To output a feature class you should choose the Shape field under Attribute fields.
• The output must be a geodatabase table or feature class. A shapefile is not a supported format for the output feature class.
• ObjectID (or OID, FID, and so on) should not be set as attribute fields.

Field Summary

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

vals

Constructor Summary

TransposeFields()
Creates the Transpose Fields tool with defaults.

TransposeFields(java.lang.Object inTable, java.lang.Object inField, java.lang.Object outTable, java.lang.String inTransposedFieldName, java.lang.String inValueFieldName)
Creates the Transpose Fields tool with the required parameters.

Method Summary

java.lang.Object	getAttributeFields() Returns the Attribute Fields parameter of this tool .
java.lang.Object	getInField() Returns the Fields To Transpose parameter of this tool .
java.lang.Object	getInTable() Returns the Input Table parameter of this tool .
java.lang.String	getInTransposedFieldName() Returns the Transposed Field parameter of this tool .
java.lang.String	getInValueFieldName() Returns the Value Field parameter of this tool .
java.lang.Object	getOutTable() Returns the Output Table parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setAttributeFields(java.lang.Object attributeFields) Sets the Attribute Fields parameter of this tool .
void	setInField(java.lang.Object inField) Sets the Fields To Transpose parameter of this tool .
void	setInTable(java.lang.Object inTable) Sets the Input Table parameter of this tool .
void	setInTransposedFieldName(java.lang.String inTransposedFieldName) Sets the Transposed Field parameter of this tool .
void	setInValueFieldName(java.lang.String inValueFieldName) Sets the Value Field parameter of this tool .
void	setOutTable(java.lang.Object outTable) Sets the Output Table 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

TransposeFields

public TransposeFields()

Creates the Transpose Fields tool with defaults.

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

TransposeFields

public TransposeFields(java.lang.Object inTable,
                       java.lang.Object inField,
                       java.lang.Object outTable,
                       java.lang.String inTransposedFieldName,
                       java.lang.String inValueFieldName)

Creates the Transpose Fields 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 input feature class or table for which the fields containing data values will be transposed.

inField - the fields or columns containing data values in the input table that need to be transposed. depending on your needs, you can select multiple fields that need to be transposed. For the fields that are selected to be transposed, a corresponding value has to be specified. By default, the value is the same as the field name. However, you can choose to overwrite it and specify your own value. For example, if the field names of the fields you want to transpose are Pop1991, Pop1992, etc., by default the values for these field will be the same i.e., Pop1991, Pop1992, etc. However, you can choose to specify your own values such as 1991, 1992, etc.

outTable - the output feature class or table. The output feature class can only be stored in a geodatabase. The output feature class or table will contain the transposed field, a value field, and any number of attribute fields specified that need to be inherited from the input table.

inTransposedFieldName - the name of the field that will be created to store field name values of the fields that are selected to be transposed. Any valid field name can be used.

inValueFieldName - the name of the value field that will be created to store the values from the input table. Any valid field name can be set, as long as it does not conflict with existing field names from the input table or feature class.

Method Detail

getInTable

public java.lang.Object getInTable()

Returns the Input Table parameter of this tool . This parameter is the input feature class or table for which the fields containing data values will be transposed. This is a required parameter.

Returns:

the Input Table

setInTable

public void setInTable(java.lang.Object inTable)

Sets the Input Table parameter of this tool . This parameter is the input feature class or table for which the fields containing data values will be transposed. This is a required parameter.

Parameters:

inTable - the input feature class or table for which the fields containing data values will be transposed.

getInField

public java.lang.Object getInField()

Returns the Fields To Transpose parameter of this tool . This parameter is the fields or columns containing data values in the input table that need to be transposed. depending on your needs, you can select multiple fields that need to be transposed. For the fields that are selected to be transposed, a corresponding value has to be specified. By default, the value is the same as the field name. However, you can choose to overwrite it and specify your own value. For example, if the field names of the fields you want to transpose are Pop1991, Pop1992, etc., by default the values for these field will be the same i.e., Pop1991, Pop1992, etc. However, you can choose to specify your own values such as 1991, 1992, etc. This is a required parameter.

Returns:

the Fields To Transpose

setInField

public void setInField(java.lang.Object inField)

Sets the Fields To Transpose parameter of this tool . This parameter is the fields or columns containing data values in the input table that need to be transposed. depending on your needs, you can select multiple fields that need to be transposed. For the fields that are selected to be transposed, a corresponding value has to be specified. By default, the value is the same as the field name. However, you can choose to overwrite it and specify your own value. For example, if the field names of the fields you want to transpose are Pop1991, Pop1992, etc., by default the values for these field will be the same i.e., Pop1991, Pop1992, etc. However, you can choose to specify your own values such as 1991, 1992, etc. This is a required parameter.

Parameters:

inField - the fields or columns containing data values in the input table that need to be transposed. depending on your needs, you can select multiple fields that need to be transposed. For the fields that are selected to be transposed, a corresponding value has to be specified. By default, the value is the same as the field name. However, you can choose to overwrite it and specify your own value. For example, if the field names of the fields you want to transpose are Pop1991, Pop1992, etc., by default the values for these field will be the same i.e., Pop1991, Pop1992, etc. However, you can choose to specify your own values such as 1991, 1992, etc.

getOutTable

public java.lang.Object getOutTable()

Returns the Output Table parameter of this tool . This parameter is the output feature class or table. The output feature class can only be stored in a geodatabase. The output feature class or table will contain the transposed field, a value field, and any number of attribute fields specified that need to be inherited from the input table. This is a required parameter.

Returns:

the Output Table

setOutTable

public void setOutTable(java.lang.Object outTable)

Sets the Output Table parameter of this tool . This parameter is the output feature class or table. The output feature class can only be stored in a geodatabase. The output feature class or table will contain the transposed field, a value field, and any number of attribute fields specified that need to be inherited from the input table. This is a required parameter.

Parameters:

outTable - the output feature class or table. The output feature class can only be stored in a geodatabase. The output feature class or table will contain the transposed field, a value field, and any number of attribute fields specified that need to be inherited from the input table.

getInTransposedFieldName

public java.lang.String getInTransposedFieldName()

Returns the Transposed Field parameter of this tool . This parameter is the name of the field that will be created to store field name values of the fields that are selected to be transposed. Any valid field name can be used. This is a required parameter.

Returns:

the Transposed Field

setInTransposedFieldName

public void setInTransposedFieldName(java.lang.String inTransposedFieldName)

Sets the Transposed Field parameter of this tool . This parameter is the name of the field that will be created to store field name values of the fields that are selected to be transposed. Any valid field name can be used. This is a required parameter.

Parameters:

inTransposedFieldName - the name of the field that will be created to store field name values of the fields that are selected to be transposed. Any valid field name can be used.

getInValueFieldName

public java.lang.String getInValueFieldName()

Returns the Value Field parameter of this tool . This parameter is the name of the value field that will be created to store the values from the input table. Any valid field name can be set, as long as it does not conflict with existing field names from the input table or feature class. This is a required parameter.

Returns:

the Value Field

setInValueFieldName

public void setInValueFieldName(java.lang.String inValueFieldName)

Sets the Value Field parameter of this tool . This parameter is the name of the value field that will be created to store the values from the input table. Any valid field name can be set, as long as it does not conflict with existing field names from the input table or feature class. This is a required parameter.

Parameters:

inValueFieldName - the name of the value field that will be created to store the values from the input table. Any valid field name can be set, as long as it does not conflict with existing field names from the input table or feature class.

getAttributeFields

public java.lang.Object getAttributeFields()

Returns the Attribute Fields parameter of this tool . This parameter is attribute fields from the input table to be included in the output table. If you want to output a feature class, choose the Shape field. This is an optional parameter.

Returns:

the Attribute Fields

setAttributeFields

public void setAttributeFields(java.lang.Object attributeFields)

Sets the Attribute Fields parameter of this tool . This parameter is attribute fields from the input table to be included in the output table. If you want to output a feature class, choose the Shape field. This is an optional parameter.

Parameters:

attributeFields - attribute fields from the input table to be included in the output table. If you want to output a feature class, choose the Shape field.

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias