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

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

All Implemented Interfaces:

GPTool

public class CalculateEndTime
extends AbstractGPTool

Populates the values for a specified end time field with values calculated using the start time field specified. This tool is useful when the intervals between start time field values are not regular and you want to visualize the feature class or table through time using the Time Slider. The Calculate End Time tool is contained in the Data Management Tools tool box.

Usage tips:

• The table is first sorted by the fields in theID Fields parameter and then by the Start Time Field. After this sort, the end time of any row is the same as the start time of the next row.
• The end time field value for the last row will be the same as the start time field value for that row.

Field Summary

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

vals

Constructor Summary

CalculateEndTime()
Creates the Calculate End Time tool with defaults.

CalculateEndTime(Object inTable, Object startField, Object endField)
Creates the Calculate End Time tool with the required parameters.

Method Summary

Object	getEndField() Returns the End Time Field parameter of this tool .
Object	getFields() Returns the ID Fields parameter of this tool .
Object	getInTable() Returns the Input Table parameter of this tool .
Object	getOutTable() Returns the Output Table parameter of this tool (Read only).
Object	getStartField() Returns the Start Time 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.
void	setEndField(Object endField) Sets the End Time Field parameter of this tool .
void	setFields(Object fields) Sets the ID Fields parameter of this tool .
void	setInTable(Object inTable) Sets the Input Table parameter of this tool .
void	setStartField(Object startField) Sets the Start 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

CalculateEndTime

public CalculateEndTime()

Creates the Calculate End Time tool with defaults.

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

CalculateEndTime

public CalculateEndTime(Object inTable,
                        Object startField,
                        Object endField)

Creates the Calculate End Time 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 feature class or table for which an end time field is calculated based on the start time field specified.

startField - the field containing values that will be used to calculate values for the end time field. The start time field and the end time field must be of the same type. For example, if the start time field is of type LONG, then the end time field should be of type LONG as well.

endField - the field that will be populated with values based on the start time field specified. The start time field and the end time field must be of the same format.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is the feature class or table for which an end time field is calculated based on the start time field specified. 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 feature class or table for which an end time field is calculated based on the start time field specified. This is a required parameter.

Parameters:

inTable - the feature class or table for which an end time field is calculated based on the start time field specified.

getStartField

public Object getStartField()

Returns the Start Time Field parameter of this tool . This parameter is the field containing values that will be used to calculate values for the end time field. The start time field and the end time field must be of the same type. For example, if the start time field is of type LONG, then the end time field should be of type LONG as well. This is a required parameter.

Returns:

the Start Time Field

setStartField

public void setStartField(Object startField)

Sets the Start Time Field parameter of this tool . This parameter is the field containing values that will be used to calculate values for the end time field. The start time field and the end time field must be of the same type. For example, if the start time field is of type LONG, then the end time field should be of type LONG as well. This is a required parameter.

Parameters:

startField - the field containing values that will be used to calculate values for the end time field. The start time field and the end time field must be of the same type. For example, if the start time field is of type LONG, then the end time field should be of type LONG as well.

getEndField

public Object getEndField()

Returns the End Time Field parameter of this tool . This parameter is the field that will be populated with values based on the start time field specified. The start time field and the end time field must be of the same format. This is a required parameter.

Returns:

the End Time Field

setEndField

public void setEndField(Object endField)

Sets the End Time Field parameter of this tool . This parameter is the field that will be populated with values based on the start time field specified. The start time field and the end time field must be of the same format. This is a required parameter.

Parameters:

endField - the field that will be populated with values based on the start time field specified. The start time field and the end time field must be of the same format.

getFields

public Object getFields()

Returns the ID Fields parameter of this tool . This parameter is the name of the field or fields that can be used to uniquely identify spatial entities. This field or these fields are used to first sort based on entity type if there is more than one entity. For instance, for a feature class representing population values per state over time, state name could be the unique value field (the entity). If population figures are per county, you would need to set county name and state name as the unique value fields, since some county names are the same for different states. If there is only one entity, this parameter can be ignored. This is an optional parameter.

Returns:

the ID Fields

setFields

public void setFields(Object fields)

Sets the ID Fields parameter of this tool . This parameter is the name of the field or fields that can be used to uniquely identify spatial entities. This field or these fields are used to first sort based on entity type if there is more than one entity. For instance, for a feature class representing population values per state over time, state name could be the unique value field (the entity). If population figures are per county, you would need to set county name and state name as the unique value fields, since some county names are the same for different states. If there is only one entity, this parameter can be ignored. This is an optional parameter.

Parameters:

fields - the name of the field or fields that can be used to uniquely identify spatial entities. This field or these fields are used to first sort based on entity type if there is more than one entity. For instance, for a feature class representing population values per state over time, state name could be the unique value field (the entity). If population figures are per county, you would need to set county name and state name as the unique value fields, since some county names are the same for different states. If there is only one entity, this parameter can be ignored.

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