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

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

All Implemented Interfaces:

GPTool

public class ConvertTimeField
extends AbstractGPTool

Converts time values stored in a string or numeric field to a date field. The tool allows you to pick the format in which your time values were recorded and converts those into a date format. The Convert Time Field tool is contained in the Data Management Tools tool box.

Usage tips:

• The input time field can be a string or numeric field.
• When converting time values stored in a custom format you should specify the locale which supports that format.

Field Summary

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

vals

Constructor Summary

ConvertTimeField()
Creates the Convert Time Field tool with defaults.

ConvertTimeField(Object inTable, Object inputTimeField, String inputTimeFormat, String outputTimeField)
Creates the Convert Time Field tool with the required parameters.

Method Summary

Object	getInputTimeField() Returns the Input Time Field parameter of this tool .
String	getInputTimeFormat() Returns the Input Time Format parameter of this tool .
Object	getInTable() Returns the Input Table parameter of this tool .
String	getOutputTimeField() Returns the Output Time Field parameter of this tool .
Object	getOutTable() Returns the Output Table parameter of this tool (Read only).
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	setInputTimeField(Object inputTimeField) Sets the Input Time Field parameter of this tool .
void	setInputTimeFormat(String inputTimeFormat) Sets the Input Time Format parameter of this tool .
void	setInTable(Object inTable) Sets the Input Table parameter of this tool .
void	setOutputTimeField(String outputTimeField) Sets the Output Time 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

ConvertTimeField

public ConvertTimeField()

Creates the Convert Time Field tool with defaults.

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

ConvertTimeField

public ConvertTimeField(Object inTable,
                        Object inputTimeField,
                        String inputTimeFormat,
                        String outputTimeField)

Creates the Convert Time Field 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 layer or table that contains the field containing the time values that need to be converted and stored in Date field.

inputTimeField - the field containing the time values. May be of type short, long, float, double, or text.

inputTimeFormat - the format in which the time values were stored. For example, the time values may have been stored in one of the standard formats such as yyyy/MM/dd HH:mm:ss or in a custom format such as dd/MM/yyyy HH:mm:ss. For the custom format, you can also specify the AM, PM designator.

outputTimeField - the name of output field. The output field created will be of type Date.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is the layer or table that contains the field containing the time values that need to be converted and stored in Date field. 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 layer or table that contains the field containing the time values that need to be converted and stored in Date field. This is a required parameter.

Parameters:

inTable - the layer or table that contains the field containing the time values that need to be converted and stored in Date field.

getInputTimeField

public Object getInputTimeField()

Returns the Input Time Field parameter of this tool . This parameter is the field containing the time values. May be of type short, long, float, double, or text. This is a required parameter.

Returns:

the Input Time Field

setInputTimeField

public void setInputTimeField(Object inputTimeField)

Sets the Input Time Field parameter of this tool . This parameter is the field containing the time values. May be of type short, long, float, double, or text. This is a required parameter.

Parameters:

inputTimeField - the field containing the time values. May be of type short, long, float, double, or text.

getInputTimeFormat

public String getInputTimeFormat()

Returns the Input Time Format parameter of this tool . This parameter is the format in which the time values were stored. For example, the time values may have been stored in one of the standard formats such as yyyy/MM/dd HH:mm:ss or in a custom format such as dd/MM/yyyy HH:mm:ss. For the custom format, you can also specify the AM, PM designator. This is a required parameter.

Returns:

the Input Time Format

setInputTimeFormat

public void setInputTimeFormat(String inputTimeFormat)

Sets the Input Time Format parameter of this tool . This parameter is the format in which the time values were stored. For example, the time values may have been stored in one of the standard formats such as yyyy/MM/dd HH:mm:ss or in a custom format such as dd/MM/yyyy HH:mm:ss. For the custom format, you can also specify the AM, PM designator. This is a required parameter.

Parameters:

inputTimeFormat - the format in which the time values were stored. For example, the time values may have been stored in one of the standard formats such as yyyy/MM/dd HH:mm:ss or in a custom format such as dd/MM/yyyy HH:mm:ss. For the custom format, you can also specify the AM, PM designator.

getOutputTimeField

public String getOutputTimeField()

Returns the Output Time Field parameter of this tool . This parameter is the name of output field. The output field created will be of type Date. This is a required parameter.

Returns:

the Output Time Field

setOutputTimeField

public void setOutputTimeField(String outputTimeField)

Sets the Output Time Field parameter of this tool . This parameter is the name of output field. The output field created will be of type Date. This is a required parameter.

Parameters:

outputTimeField - the name of output field. The output field created will be of type Date.

getOutTable

public Object getOutTable()

Returns the Output Table parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Table

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