com.esri.arcgis.trackinganalyst
Interface IDatasetDef

All Superinterfaces:
Serializable
All Known Implementing Classes:
DataSetDefinition

public interface IDatasetDef
extends Serializable

Provides access to methods and properties needed to manage a dataset definition.

Superseded By

IDatasetDef2

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.


Method Summary
 IEditDataSetColumn addColumnDefinition()
          Adds a column definition to the dataset definition.
 IDatasetColumn findColumn(String szColumnName)
          Finds the specified column.
 String get_GeometryColumns(int nGeometryColumnIndex)
          Returns geometry column values for the dataset definition.
 IDatasetColumn getColumn(int nIndex)
          Returns column information for the dataset definition.
 int getColumnCount()
          Number of columns in dataset definition.
 int getGeometryColumnCount()
          Number of geometry columns included in the dataset definition.
 String getID()
          Identifies ID value for dataset definition.
 String getName()
          Identifies Name to include in the dataset definition.
 Object getSpatialReferance()
          Spatial reference included in the dataset definition.
 String getTrackingColumn()
          Identifies Tracking column value for the dataset definition.
 void moveTo(int nFromIndex, int nToIndex)
          Moves current dataset definition to a specified location.
 void removeColumnDefinition(String[] pcName)
          Removes a column definition from the dataset definition.
 void setName(String pVal)
          Identifies Name to include in the dataset definition.
 void setSpatialReferance(Object piSpatialReference)
          Spatial reference included in the dataset definition.
 void setTrackingColumn(String pVal)
          Identifies Tracking column value for the dataset definition.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Identifies Name to include in the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

void setName(String pVal)
             throws IOException,
                    AutomationException
Identifies Name to include in the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getID

String getID()
             throws IOException,
                    AutomationException
Identifies ID value for dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTrackingColumn

String getTrackingColumn()
                         throws IOException,
                                AutomationException
Identifies Tracking column value for the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrackingColumn

void setTrackingColumn(String pVal)
                       throws IOException,
                              AutomationException
Identifies Tracking column value for the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeometryColumnCount

int getGeometryColumnCount()
                           throws IOException,
                                  AutomationException
Number of geometry columns included in the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialReferance

Object getSpatialReferance()
                           throws IOException,
                                  AutomationException
Spatial reference included in the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpatialReferance

void setSpatialReferance(Object piSpatialReference)
                         throws IOException,
                                AutomationException
Spatial reference included in the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
piSpatialReference - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColumnCount

int getColumnCount()
                   throws IOException,
                          AutomationException
Number of columns in dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findColumn

IDatasetColumn findColumn(String szColumnName)
                          throws IOException,
                                 AutomationException
Finds the specified column.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
szColumnName - The szColumnName (in)
Returns:
A reference to a com.esri.arcgis.trackinganalyst.IDatasetColumn
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addColumnDefinition

IEditDataSetColumn addColumnDefinition()
                                       throws IOException,
                                              AutomationException
Adds a column definition to the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
A reference to a com.esri.arcgis.trackinganalyst.IEditDataSetColumn
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeColumnDefinition

void removeColumnDefinition(String[] pcName)
                            throws IOException,
                                   AutomationException
Removes a column definition from the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
pcName - The pcName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColumn

IDatasetColumn getColumn(int nIndex)
                         throws IOException,
                                AutomationException
Returns column information for the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
nIndex - The nIndex (in)
Returns:
A reference to a com.esri.arcgis.trackinganalyst.IDatasetColumn
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

get_GeometryColumns

String get_GeometryColumns(int nGeometryColumnIndex)
                           throws IOException,
                                  AutomationException
Returns geometry column values for the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
nGeometryColumnIndex - The nGeometryColumnIndex (in)
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

moveTo

void moveTo(int nFromIndex,
            int nToIndex)
            throws IOException,
                   AutomationException
Moves current dataset definition to a specified location.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
nFromIndex - The nFromIndex (in)
nToIndex - The nToIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.