com.esri.arcgis.trackinganalyst
Class AMSDatasetName

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.AMSDatasetName
All Implemented Interfaces:
IDatasetName, ITableName, com.esri.arcgis.interop.RemoteObjRef, IName, IAMSDatasetName, Serializable

public class AMSDatasetName
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAMSDatasetName, IName, IDatasetName, ITableName

Controls the settings for the tracking dataset names.

Description

This class is the defintion for the COM object that is the dataset name object of the workspace. The AMSDatasetName object provides an extension to ESRI's datasetname object by providing an additional property named Enabled. This allows the workspace to limit the dataset names that are returned through the convesional IWorkspace datasetnames property to those that are enabled.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
AMSDatasetName()
          Constructs a AMSDatasetName using ArcGIS Engine.
AMSDatasetName(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AMSDatasetName theAMSDatasetName = (AMSDatasetName) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 String getCategory()
          The category of the dataset.
static String getClsid()
          getClsid.
 IDatasetName getFeatureDatasetName()
          The Feature Dataset Name object.
 int getFeatureType()
          The feature type for this feature class name.
 String getName()
          The name of the dataset.
 String getNameString()
          The name string of the object.
 String getShapeFieldName()
          The spatial column name for this feature class name.
 int getShapeType()
          The feature class shape type.
 IEnumDatasetName getSubsetNames()
          Subset names contained within this dataset name.
 String getTemporalColumnName()
          Name of the column containing the time and date information.
 ITrackingServiceDef getTrackingService()
          Defines a tracking service within the real-time data connection in the workspace.
 int getType()
          The type of the dataset.
 IWorkspaceName getWorkspaceName()
          The WorkspaceName of the DatasetName.
 int hashCode()
          the hashcode for this object
 boolean isVisible()
          Indicates whether or not the dataset name is visible in the workspace dialog.
 Object open()
          Opens the object referred to by this name.
 void setCategory(String category)
          The category of the dataset.
 void setFeatureDatasetNameByRef(IDatasetName featureDatasetName)
          The Feature Dataset Name object.
 void setFeatureType(int type)
          The feature type for this feature class name.
 void setName(String name)
          The name of the dataset.
 void setNameString(String nameString)
          The name string of the object.
 void setShapeFieldName(String name)
          The spatial column name for this feature class name.
 void setShapeType(int type)
          The feature class shape type.
 void setTrackingServiceByRef(ITrackingServiceDef pVal)
          Defines a tracking service within the real-time data connection in the workspace.
 void setVisible(boolean pVal)
          Indicates whether or not the dataset name is visible in the workspace dialog.
 void setWorkspaceNameByRef(IWorkspaceName workspaceName)
          The WorkspaceName of the DatasetName.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

AMSDatasetName

public AMSDatasetName()
               throws IOException,
                      UnknownHostException
Constructs a AMSDatasetName using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

AMSDatasetName

public AMSDatasetName(Object obj)
               throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AMSDatasetName theAMSDatasetName = (AMSDatasetName) obj;

Construct a AMSDatasetName using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AMSDatasetName.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException
Indicates whether or not the dataset name is visible in the workspace dialog.

Description

This property indicates whether or not to list this dataset name in the dataset's property of IWorkspace.

Product Availability

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

Specified by:
isVisible in interface IAMSDatasetName
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean pVal)
                throws IOException,
                       AutomationException
Indicates whether or not the dataset name is visible in the workspace dialog.

Description

This property indicates whether or not to list this dataset name in the dataset's property of IWorkspace.

Product Availability

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

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

getTemporalColumnName

public String getTemporalColumnName()
                             throws IOException,
                                    AutomationException
Name of the column containing the time and date information.

Product Availability

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

Specified by:
getTemporalColumnName in interface IAMSDatasetName
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTrackingService

public ITrackingServiceDef getTrackingService()
                                       throws IOException,
                                              AutomationException
Defines a tracking service within the real-time data connection in the workspace.

Product Availability

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

Specified by:
getTrackingService in interface IAMSDatasetName
Returns:
A reference to a com.esri.arcgis.trackinganalyst.ITrackingServiceDef
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrackingServiceByRef

public void setTrackingServiceByRef(ITrackingServiceDef pVal)
                             throws IOException,
                                    AutomationException
Defines a tracking service within the real-time data connection in the workspace.

Product Availability

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

Specified by:
setTrackingServiceByRef in interface IAMSDatasetName
Parameters:
pVal - A reference to a com.esri.arcgis.trackinganalyst.ITrackingServiceDef (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShapeType

public int getShapeType()
                 throws IOException,
                        AutomationException
The feature class shape type.

Product Availability

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

Specified by:
getShapeType in interface IAMSDatasetName
Returns:
A com.esri.arcgis.geometry.esriGeometryType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShapeType

public void setShapeType(int type)
                  throws IOException,
                         AutomationException
The feature class shape type.

Product Availability

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

Specified by:
setShapeType in interface IAMSDatasetName
Parameters:
type - A com.esri.arcgis.geometry.esriGeometryType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureDatasetName

public IDatasetName getFeatureDatasetName()
                                   throws IOException,
                                          AutomationException
The Feature Dataset Name object.

Product Availability

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

Specified by:
getFeatureDatasetName in interface IAMSDatasetName
Returns:
A reference to a com.esri.arcgis.geodatabase.IDatasetName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureDatasetNameByRef

public void setFeatureDatasetNameByRef(IDatasetName featureDatasetName)
                                throws IOException,
                                       AutomationException
The Feature Dataset Name object.

Product Availability

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

Specified by:
setFeatureDatasetNameByRef in interface IAMSDatasetName
Parameters:
featureDatasetName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureType

public int getFeatureType()
                   throws IOException,
                          AutomationException
The feature type for this feature class name.

Product Availability

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

Specified by:
getFeatureType in interface IAMSDatasetName
Returns:
A com.esri.arcgis.geodatabase.esriFeatureType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureType

public void setFeatureType(int type)
                    throws IOException,
                           AutomationException
The feature type for this feature class name.

Product Availability

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

Specified by:
setFeatureType in interface IAMSDatasetName
Parameters:
type - A com.esri.arcgis.geodatabase.esriFeatureType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShapeFieldName

public String getShapeFieldName()
                         throws IOException,
                                AutomationException
The spatial column name for this feature class name.

Product Availability

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

Specified by:
getShapeFieldName in interface IAMSDatasetName
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShapeFieldName

public void setShapeFieldName(String name)
                       throws IOException,
                              AutomationException
The spatial column name for this feature class name.

Product Availability

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

Specified by:
setShapeFieldName in interface IAMSDatasetName
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
The name of the dataset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IDatasetName
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException
The name of the dataset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setName in interface IDatasetName
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException
The type of the dataset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getType in interface IDatasetName
Returns:
A com.esri.arcgis.geodatabase.esriDatasetType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException
The category of the dataset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCategory in interface IDatasetName
Returns:
The category
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(String category)
                 throws IOException,
                        AutomationException
The category of the dataset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCategory in interface IDatasetName
Parameters:
category - The category (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

public IWorkspaceName getWorkspaceName()
                                throws IOException,
                                       AutomationException
The WorkspaceName of the DatasetName.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getWorkspaceName in interface IDatasetName
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspaceName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWorkspaceNameByRef

public void setWorkspaceNameByRef(IWorkspaceName workspaceName)
                           throws IOException,
                                  AutomationException
The WorkspaceName of the DatasetName.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setWorkspaceNameByRef in interface IDatasetName
Parameters:
workspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubsetNames

public IEnumDatasetName getSubsetNames()
                                throws IOException,
                                       AutomationException
Subset names contained within this dataset name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSubsetNames in interface IDatasetName
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumDatasetName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNameString

public void setNameString(String nameString)
                   throws IOException,
                          AutomationException
The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setNameString in interface IName
Parameters:
nameString - The nameString (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNameString

public String getNameString()
                     throws IOException,
                            AutomationException
The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getNameString in interface IName
Returns:
The nameString
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

open

public Object open()
            throws IOException,
                   AutomationException
Opens the object referred to by this name.

Remarks

The Open method lets you instantiate the actual object given the name object.

Note: Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.

Example:

IName   pName = pFeatureClassName; 
pFeatureClass = new IFeatureClassProxy(pName.open());

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
open in interface IName
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.