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

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

All Implemented Interfaces:

GPTool

public class ConvertTimeZone
extends AbstractGPTool

Converts time values recorded in a date field from one time zone to another time zone. The Convert Time Zone tool is contained in the Data Management Tools tool box.

Usage tips:

• The input time values to be converted must be stored in a Date field.
• The added output time field will be a Date type field.
• If your data was collected in a time zone which uses Daylight Savings, then you should choose the parameters to honor Daylight Savings in the input and output fields. .

Field Summary

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

vals

Constructor Summary

ConvertTimeZone()
Creates the Convert Time Zone tool with defaults.

ConvertTimeZone(Object inTable, Object inputTimeField, String inputTimeZone, String outputTimeField)
Creates the Convert Time Zone tool with the required parameters.

Method Summary

String	getInputDst() Returns the Input time field uses Daylight Savings Time parameter of this tool .
Object	getInputTimeField() Returns the Input Time Field parameter of this tool .
String	getInputTimeZone() Returns the Input Time Zone parameter of this tool .
Object	getInTable() Returns the Input Table parameter of this tool .
String	getOutputDst() Returns the Output time field uses Daylight Savings Time parameter of this tool .
String	getOutputTimeField() Returns the Output Time Field parameter of this tool .
String	getOutputTimeZone() Returns the Output Time Zone 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	setInputDst(String inputDst) Sets the Input time field uses Daylight Savings Time parameter of this tool .
void	setInputTimeField(Object inputTimeField) Sets the Input Time Field parameter of this tool .
void	setInputTimeZone(String inputTimeZone) Sets the Input Time Zone parameter of this tool .
void	setInTable(Object inTable) Sets the Input Table parameter of this tool .
void	setOutputDst(String outputDst) Sets the Output time field uses Daylight Savings Time parameter of this tool .
void	setOutputTimeField(String outputTimeField) Sets the Output Time Field parameter of this tool .
void	setOutputTimeZone(String outputTimeZone) Sets the Output Time Zone 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

ConvertTimeZone

public ConvertTimeZone()

Creates the Convert Time Zone tool with defaults.

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

ConvertTimeZone

public ConvertTimeZone(Object inTable,
                       Object inputTimeField,
                       String inputTimeZone,
                       String outputTimeField)

Creates the Convert Time Zone 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 that contains the time stamps which will be transformed to a different time zone.

inputTimeField - the input field that contains the time stamps which will be transformed to a different time zone.

inputTimeZone - the input time zone in which the time stamps were collected.

outputTimeField - the output field in which the transformed time stamps will be stored.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is the input feature class or table that contains the time stamps which will be transformed to a different time zone. 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 input feature class or table that contains the time stamps which will be transformed to a different time zone. This is a required parameter.

Parameters:

inTable - the input feature class or table that contains the time stamps which will be transformed to a different time zone.

getInputTimeField

public Object getInputTimeField()

Returns the Input Time Field parameter of this tool . This parameter is the input field that contains the time stamps which will be transformed to a different time zone. 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 input field that contains the time stamps which will be transformed to a different time zone. This is a required parameter.

Parameters:

inputTimeField - the input field that contains the time stamps which will be transformed to a different time zone.

getInputTimeZone

public String getInputTimeZone()

Returns the Input Time Zone parameter of this tool . This parameter is the input time zone in which the time stamps were collected. This is a required parameter.

Returns:

the Input Time Zone

setInputTimeZone

public void setInputTimeZone(String inputTimeZone)

Sets the Input Time Zone parameter of this tool . This parameter is the input time zone in which the time stamps were collected. This is a required parameter.

Parameters:

inputTimeZone - the input time zone in which the time stamps were collected.

getOutputTimeField

public String getOutputTimeField()

Returns the Output Time Field parameter of this tool . This parameter is the output field in which the transformed time stamps will be stored. 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 output field in which the transformed time stamps will be stored. This is a required parameter.

Parameters:

outputTimeField - the output field in which the transformed time stamps will be stored.

getOutputTimeZone

public String getOutputTimeZone()

Returns the Output Time Zone parameter of this tool . This parameter is the time zone to which the time stamps will be transformed. This is an optional parameter.

Returns:

the Output Time Zone

setOutputTimeZone

public void setOutputTimeZone(String outputTimeZone)

Sets the Output Time Zone parameter of this tool . This parameter is the time zone to which the time stamps will be transformed. This is an optional parameter.

Parameters:

outputTimeZone - the time zone to which the time stamps will be transformed.

getInputDst

public String getInputDst()

Returns the Input time field uses Daylight Savings Time parameter of this tool . This parameter is indicates whether the time stamps were collected in Daylight Savings Time. When reading the time values to convert the time zone, the time values will be adjusted to account for the shift in time during Daylight Savings Time in the input time zone. by default, the shift in time due to Daylight Savings Time in the input time zone is ignored when reading the time values from the input time field. This is an optional parameter.

Returns:

the Input time field uses Daylight Savings Time

setInputDst

public void setInputDst(String inputDst)

Sets the Input time field uses Daylight Savings Time parameter of this tool . This parameter is indicates whether the time stamps were collected in Daylight Savings Time. When reading the time values to convert the time zone, the time values will be adjusted to account for the shift in time during Daylight Savings Time in the input time zone. by default, the shift in time due to Daylight Savings Time in the input time zone is ignored when reading the time values from the input time field. This is an optional parameter.

Parameters:

inputDst - indicates whether the time stamps were collected in Daylight Savings Time. When reading the time values to convert the time zone, the time values will be adjusted to account for the shift in time during Daylight Savings Time in the input time zone. by default, the shift in time due to Daylight Savings Time in the input time zone is ignored when reading the time values from the input time field.

getOutputDst

public String getOutputDst()

Returns the Output time field uses Daylight Savings Time parameter of this tool . This parameter is indicates whether the output time values will account for the shift in time due to the Daylight Savings Time in the desired output time zone. by default, the shift in time due to the Daylight Savings Time in the desired output time zone is ignored when writing the time values to the output time field. This is an optional parameter.

Returns:

the Output time field uses Daylight Savings Time

setOutputDst

public void setOutputDst(String outputDst)

Sets the Output time field uses Daylight Savings Time parameter of this tool . This parameter is indicates whether the output time values will account for the shift in time due to the Daylight Savings Time in the desired output time zone. by default, the shift in time due to the Daylight Savings Time in the desired output time zone is ignored when writing the time values to the output time field. This is an optional parameter.

Parameters:

outputDst - indicates whether the output time values will account for the shift in time due to the Daylight Savings Time in the desired output time zone. by default, the shift in time due to the Daylight Savings Time in the desired output time zone is ignored when writing the time values to the output time field.

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