|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geoprocessing.AbstractGPTool com.esri.arcgis.geoprocessing.tools.datamanagementtools.TransposeTimeFields
public class TransposeTimeFields
Creates time stamps from the time columns in a table or feature class. It shifts fields from columns to rows in a table or feature class that have time as the field names.This tool is useful when your table or feature class stores time in field names (such as Pop1980, Pop1990, Pop2000 and so on), and you want to create time stamps for the feature class or table so that it can be animated through time. The Transpose Time Fields tool is contained in the Data Management Tools tool box.
Field Summary |
---|
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool |
---|
vals |
Constructor Summary | |
---|---|
TransposeTimeFields()
Creates the Transpose Time Fields tool with defaults. |
|
TransposeTimeFields(Object inputFeatureClassOrTable,
Object fieldsToTranspose,
Object outputFeatureClassOrTable,
String timeFieldName,
String valueFieldName)
Creates the Transpose Time Fields tool with the required parameters. |
Method Summary | |
---|---|
Object |
getAttributeFields()
Returns the Attribute Fields parameter of this tool . |
Object |
getFieldsToTranspose()
Returns the Fields to Transpose parameter of this tool . |
Object |
getInputFeatureClassOrTable()
Returns the Input Feature Class or Table parameter of this tool . |
Object |
getOutputFeatureClassOrTable()
Returns the Output Feature Class or Table parameter of this tool . |
String |
getTimeFieldName()
Returns the Time Field Name 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. |
String |
getValueFieldName()
Returns the Value Field Name parameter of this tool . |
void |
setAttributeFields(Object attributeFields)
Sets the Attribute Fields parameter of this tool . |
void |
setFieldsToTranspose(Object fieldsToTranspose)
Sets the Fields to Transpose parameter of this tool . |
void |
setInputFeatureClassOrTable(Object inputFeatureClassOrTable)
Sets the Input Feature Class or Table parameter of this tool . |
void |
setOutputFeatureClassOrTable(Object outputFeatureClassOrTable)
Sets the Output Feature Class or Table parameter of this tool . |
void |
setTimeFieldName(String timeFieldName)
Sets the Time Field Name parameter of this tool . |
void |
setValueFieldName(String valueFieldName)
Sets the Value Field Name 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 TransposeTimeFields()
Initializes the array of tool parameters with the default values specified when the tool was created.
public TransposeTimeFields(Object inputFeatureClassOrTable, Object fieldsToTranspose, Object outputFeatureClassOrTable, String timeFieldName, String valueFieldName)
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.
inputFeatureClassOrTable
- the input feature class or table for which time stamps will be created.fieldsToTranspose
- the columns from the input table and the corresponding time values. multiple strings can be entered, depending on how many fields you are transposing. Each string should be formatted as "Field_Name Time" (without the quotation marks). Each is a pair of substrings separated by a space. For example, the following string is a valid input - "POP1980 1980". In this example, POP1980 is the field name of a field containing population values for 1980. 1980 is the string that will be substituted for POP1980 and populated in the time field of the output table or feature class.outputFeatureClassOrTable
- the output feature class or table. The output table can be specified as a .dbf table, an info table, or a geodatabase table. The output feature class can only be stored in a geodatabase (shapefile is not available as a format for the output). The output feature class or table will contain a time field, a value field, and any number of attribute fields specified that need to be inherited from the input table.timeFieldName
- the name of the time field that will be created to store time values. The default name is "Time". Any valid field name can be used.valueFieldName
- the name of the value field that will be created to store the values from the input table. The default name is "Value". 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 |
---|
public Object getInputFeatureClassOrTable()
public void setInputFeatureClassOrTable(Object inputFeatureClassOrTable)
inputFeatureClassOrTable
- the input feature class or table for which time stamps will be created.public Object getFieldsToTranspose()
public void setFieldsToTranspose(Object fieldsToTranspose)
fieldsToTranspose
- the columns from the input table and the corresponding time values. multiple strings can be entered, depending on how many fields you are transposing. Each string should be formatted as "Field_Name Time" (without the quotation marks). Each is a pair of substrings separated by a space. For example, the following string is a valid input - "POP1980 1980". In this example, POP1980 is the field name of a field containing population values for 1980. 1980 is the string that will be substituted for POP1980 and populated in the time field of the output table or feature class.public Object getOutputFeatureClassOrTable()
public void setOutputFeatureClassOrTable(Object outputFeatureClassOrTable)
outputFeatureClassOrTable
- the output feature class or table. The output table can be specified as a .dbf table, an info table, or a geodatabase table. The output feature class can only be stored in a geodatabase (shapefile is not available as a format for the output). The output feature class or table will contain a time field, a value field, and any number of attribute fields specified that need to be inherited from the input table.public String getTimeFieldName()
public void setTimeFieldName(String timeFieldName)
timeFieldName
- the name of the time field that will be created to store time values. The default name is "Time". Any valid field name can be used.public String getValueFieldName()
public void setValueFieldName(String valueFieldName)
valueFieldName
- the name of the value field that will be created to store the values from the input table. The default name is "Value". 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.public Object getAttributeFields()
public void setAttributeFields(Object attributeFields)
attributeFields
- attribute fields from the input table to be included in the output table.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 |