com.esri.arcgis.trackinganalyst
Class AMSDatasetName

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.AMSDatasetName
All Implemented Interfaces:
IDatasetName, IFeatureClassName, ITableName, IAMSDatasetName, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IName, IPersist, IPersistStream, ISupportErrorInfo, java.io.Externalizable, java.io.Serializable

public class AMSDatasetName
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IAMSDatasetName, IName, IDatasetName, ITableName, ISupportErrorInfo, IPersist, IPersistStream, IDocumentVersionSupportGEN, IFeatureClassName, java.io.Externalizable

COM Class 'AMSDatasetName'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'Controls the settings for the tracking dataset names.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.geodatabaseextensions.IAMSDatasetName
IID, IIDa677ab64_2fb8_11d5_b7e2_00010265adc5, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDatasetName
IID89e75917_c287_11d1_aa77_00c04fa33a15
 
Fields inherited from interface com.esri.arcgis.geodatabase.ITableName
IID, IID62ee07d6_09c4_11d4_a05e_00c04f6bdd84, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.geodatabase.IFeatureClassName
IID, IID3c5bbe8f_c9c3_11d1_aa7c_00c04fa33a15, xxDummy
 
Constructor Summary
AMSDatasetName()
          Constructs a AMSDatasetName using ArcGIS Engine.
AMSDatasetName(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AMSDatasetName theAMSDatasetName = (AMSDatasetName) obj;
 
Method Summary
 java.lang.Object convertToSupportedObject(int docVersion)
          Convert the object to another object that is supported.
 boolean equals(java.lang.Object o)
          Compare this object with another
 java.lang.String getCategory()
          The category of the dataset.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 IDatasetName getFeatureDatasetName()
          The Feature Dataset Name object.
 int getFeatureType()
          The feature type for this feature class name.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getName()
          The name of the dataset.
 java.lang.String getNameString()
          The name string of the object.
 java.lang.String getShapeFieldName()
          The spatial column name for this feature class name.
 int getShapeType()
          The feature class shape type.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 IEnumDatasetName getSubsetNames()
          Subset names contained within this dataset name.
 java.lang.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
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 void isDirty()
          isDirty
 boolean isSupportedAtVersion(int docVersion)
          Is this object valid at the given document version.
 boolean isVisible()
          Indicates whether or not the dataset name is visible in the workspace dialog.
 void load(IStream pstm)
          load
 java.lang.Object open()
          Opens the object referred to by this name.
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a AMSDatasetName.
 void save(IStream pstm, int fClearDirty)
          save
 void setCategory(java.lang.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(java.lang.String name)
          The name of the dataset.
 void setNameString(java.lang.String nameString)
          The name string of the object.
 void setShapeFieldName(java.lang.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.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

AMSDatasetName

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

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

AMSDatasetName

public AMSDatasetName(java.lang.Object obj)
               throws java.io.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:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

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

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a AMSDatasetName.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

isVisible

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

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

setVisible

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

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

getTemporalColumnName

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

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

getTrackingService

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

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

setTrackingServiceByRef

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

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

getShapeType

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

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

setShapeType

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

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

getFeatureDatasetName

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

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

setFeatureDatasetNameByRef

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

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

getFeatureType

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

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

setFeatureType

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

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

getShapeFieldName

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

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

setShapeFieldName

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

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

getName

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

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

setName

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

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

getType

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

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

getCategory

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

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

setCategory

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

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

getWorkspaceName

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

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

setWorkspaceNameByRef

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

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

getSubsetNames

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

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

setNameString

public void setNameString(java.lang.String nameString)
                   throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNameString

public java.lang.String getNameString()
                               throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

open

public java.lang.Object open()
                      throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
getClassID

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
save

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException
getSizeMax

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException
Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:
isSupportedAtVersion in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:
The supported
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException
Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:
convertToSupportedObject in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException