com.esri.arcgis.trackinganalyst
Interface IDatasetDef2

All Superinterfaces:
Serializable
All Known Implementing Classes:
DataSetDefinition

public interface IDatasetDef2
extends Serializable

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

Product Availability

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


Method Summary
 IEditDataSetColumn addColumnDefinition()
          Adds a column to the dataset definition.
 IDatasetColumn findColumn(String szColumnName)
          Finds column within the dataset definition.
 String get_GeometryColumns(int nGeometryColumnIndex)
          Gets value for geometry column(s) in the dataset definition.
 String getActiveMetaDataEditor()
          Class ID of the active metadata editor.
 IDatasetColumn getColumn(int nIndex)
          Gets value in a column in the dataset definition.
 int getColumnCount()
          Number of columns defined for the dataset.
 Object getDateModified()
          Identifies the date of the last modification to the dataset definition.
 int getGeometryColumnCount()
          Number of geometry columns in the dataset definition.
 String getID()
          ID value for the dataset.
 String getMetaData()
          Identifies metadata information for the dataset definition.
 String getName()
          Indicates name of the dataset for the definition.
 Object getSpatialReferance()
          Spatial reference value for the dataset definition.
 String getTrackingColumn()
          Indicates value for the Tracking column in the dataset definition.
 void moveTo(int nFromIndex, int nToIndex)
          Moves item in dataset definition to a new location.
 void removeColumnDefinition(String[] pcName)
          Removes a column from the dataset definition.
 void setActiveMetaDataEditor(String pbstrActiveMetaDataEditor)
          Class ID of the active metadata editor.
 void setID(String pVal)
          ID value for the dataset.
 void setMetaData(String pbstrMetaData)
          Identifies metadata information for the dataset definition.
 void setName(String pVal)
          Indicates name of the dataset for the definition.
 void setSpatialReferance(Object piSpatialReference)
          Spatial reference value for the dataset definition.
 void setTrackingColumn(String pVal)
          Indicates value for the Tracking column in the dataset definition.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Indicates name of the dataset for the 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
Indicates name of the dataset for the 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
ID value for the dataset.

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
Indicates value for the Tracking column 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.

setTrackingColumn

void setTrackingColumn(String pVal)
                       throws IOException,
                              AutomationException
Indicates value for the Tracking column 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.

getGeometryColumnCount

int getGeometryColumnCount()
                           throws IOException,
                                  AutomationException
Number of geometry columns 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 value for 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 value for 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 defined for the dataset.

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 column within the dataset definition.

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 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 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
Gets value in a column in 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
Gets value for geometry column(s) in 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 item in dataset definition to a new 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.

getMetaData

String getMetaData()
                   throws IOException,
                          AutomationException
Identifies metadata information for the dataset definition.

Product Availability

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

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

setMetaData

void setMetaData(String pbstrMetaData)
                 throws IOException,
                        AutomationException
Identifies metadata information for the dataset definition.

Product Availability

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

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

getDateModified

Object getDateModified()
                       throws IOException,
                              AutomationException
Identifies the date of the last modification to 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.

setID

void setID(String pVal)
           throws IOException,
                  AutomationException
ID value for the dataset.

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.

getActiveMetaDataEditor

String getActiveMetaDataEditor()
                               throws IOException,
                                      AutomationException
Class ID of the active metadata editor.

Product Availability

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

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

setActiveMetaDataEditor

void setActiveMetaDataEditor(String pbstrActiveMetaDataEditor)
                             throws IOException,
                                    AutomationException
Class ID of the active metadata editor.

Product Availability

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

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