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

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

All Implemented Interfaces:

GPTool

public class CalculateEndDate
extends AbstractGPTool

Populates the values for a specified end date field with values calculated using the start date field specified. This tool is useful when the intervals between start date field values are not regular and you want to animate the feature class or table through time or some other value using the Animation toolbar. The Calculate End Date tool is contained in the Data Management Tools tool box.

Usage tips:

• The table is first sorted by entity (unique value field) if this is specified, and then by time stamp. With the start date field sorted in ascending order, the end date of any row is the same as the start date of the next row.
• In order to use this tool the start date field must be able to be sorted in ascending order. To test this, open the attribute table for the feature class, right-click the field and click Sort Ascending. If the field cannot be sorted in ascending order, the field must be reformatted before using this tool.
• The end date field value for the last row will be the same as the start date field value.

Field Summary

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

vals

Constructor Summary

CalculateEndDate()
Creates the Calculate End Date tool with defaults.

CalculateEndDate(Object inputTable, Object startDateField, Object endDateField)
Creates the Calculate End Date tool with the required parameters.

Method Summary

Object	getEndDateField() Returns the End Date Field parameter of this tool .
Object	getInputTable() Returns the Input Table parameter of this tool .
Object	getOutputTable() Returns the Output Table parameter of this tool (Read only).
Object	getStartDateField() Returns the Start Date 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.
Object	getUniqueIDFields() Returns the Unique ID Fields parameter of this tool .
void	setEndDateField(Object endDateField) Sets the End Date Field parameter of this tool .
void	setInputTable(Object inputTable) Sets the Input Table parameter of this tool .
void	setStartDateField(Object startDateField) Sets the Start Date Field parameter of this tool .
void	setUniqueIDFields(Object uniqueIDFields) Sets the Unique ID Fields 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

CalculateEndDate

public CalculateEndDate()

Creates the Calculate End Date tool with defaults.

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

CalculateEndDate

public CalculateEndDate(Object inputTable,
                        Object startDateField,
                        Object endDateField)

Creates the Calculate End Date 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:

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

startDateField - null

endDateField - null

Method Detail

getInputTable

public Object getInputTable()

Returns the Input Table parameter of this tool . This parameter is the feature class or table for which an end date field is calculated based on the start date field specified. This is a required parameter.

Returns:

the Input Table

setInputTable

public void setInputTable(Object inputTable)

Sets the Input Table parameter of this tool . This parameter is the feature class or table for which an end date field is calculated based on the start date field specified. This is a required parameter.

Parameters:

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

getUniqueIDFields

public Object getUniqueIDFields()

Returns the Unique 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 Unique ID Fields

setUniqueIDFields

public void setUniqueIDFields(Object uniqueIDFields)

Sets the Unique 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:

uniqueIDFields - 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.

getStartDateField

public Object getStartDateField()

Returns the Start Date Field parameter of this tool . This is a required parameter.

Returns:

the Start Date Field

setStartDateField

public void setStartDateField(Object startDateField)

Sets the Start Date Field parameter of this tool . This is a required parameter.

Parameters:

startDateField - null

getEndDateField

public Object getEndDateField()

Returns the End Date Field parameter of this tool . This is a required parameter.

Returns:

the End Date Field

setEndDateField

public void setEndDateField(Object endDateField)

Sets the End Date Field parameter of this tool . This is a required parameter.

Parameters:

endDateField - null

getOutputTable

public Object getOutputTable()

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