com.esri.arcgis.trackinganalyst
Class AMSWorkspaceFactory

java.lang.Object
  com.esri.arcgis.trackinganalyst.AMSWorkspaceFactory

All Implemented Interfaces:

IRemoteDatabaseWorkspaceFactory, IWorkspaceFactory, IWorkspaceFactory2, ITemporalWorkspaceStatistics, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class AMSWorkspaceFactory
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IWorkspaceFactory2, IWorkspaceFactory, IRemoteDatabaseWorkspaceFactory, ITemporalWorkspaceStatistics, ISupportErrorInfo

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

Description 'Controls functionality for the tracking workspace factory.' 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

Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceFactory2

IID, IIDd29cd15f_3014_11d4_8141_00c04f686238, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceFactory

IIDf173fc16_d63a_11d1_aa81_00c04fa33a15

Fields inherited from interface com.esri.arcgis.geodatabase.IRemoteDatabaseWorkspaceFactory

IID, IIDab4a2d7a_055b_11d2_aa97_00c04fa33a15, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ITemporalWorkspaceStatistics

IID, IID052ac5b2_cdc1_479d_b69e_479e34a2c071, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

AMSWorkspaceFactory()
Constructs a AMSWorkspaceFactory using ArcGIS Engine.

AMSWorkspaceFactory(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AMSWorkspaceFactory theAMSWorkspaceFactory = (AMSWorkspaceFactory) obj;

Method Summary

boolean	containsWorkspace(java.lang.String parentDirectory, IFileNames fileNames) Indicates if parentDirectory contains a valid workspace, or is a valid file-system workspace.
boolean	copy(IWorkspaceName workspaceName, java.lang.String destinationFolder, IWorkspaceName[] workspaceNameCopy) Copies a workspace to the specified destination folder.
IWorkspaceName	create(java.lang.String parentDirectory, java.lang.String name, IPropertySet connectionProperties, int hWnd) Creates a new workspace specified by the directory, file name, and connection properties.
void	deleteConnectionFile(java.lang.String pathName) Deletes the remote database workspace connection file.
IWorkspaceName	editConnectionFile(java.lang.String pathName, int hWnd) Edits the properties of a remote database workspace connection file.
boolean	equals(java.lang.Object o) Compare this object with another
IPropertySet	getAllMessageRates() Indicates message rate for each TemporalFeatureClass under the workspace or workspace factory.
IPropertySet	getAllSampleSizes() Indicates sample size used for calculating message rate for each TemporalFeatureClass under the workspace or workspace factory.
IPropertySet	getAllTotalFeatureCounts() Indicates the total number of features logged for each TemporalFeatureClass under the workspace or workspace factory.
IPropertySet	getAllTrackCounts() Indicates track count for each TemporalFeatureClass under the workspace or workspace factory.
IUID	getClassID() The class ID of the WorkspaceFactory.
static java.lang.String	getClsid() getClsid.
IPropertySet	getConnectionStatus() Indicates the connection status of each workspace under the workspace factory
IPropertySet	getCurrentDiscardedMessageCounts() Indicates current number of messages discarded.
IPropertySet	getDiscardedMessageCounts() Indicates total number of messages discarded.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IPropertySet	getPulledMessageCounts() Indicates total number of messages pulled.
IPropertySet	getQueuedMessageCounts() Indicates total number of messages queued.
IPropertySet	getReceivedMessageCounts() Indicates total number of messages received.
java.lang.String	getWorkspaceDescription(boolean plural) A singular or plural description of the type of workspace the workspace factory opens/creates.
IWorkspaceName	getWorkspaceName(java.lang.String parentDirectory, IFileNames fileNames) Retrieves the workspace name of a workspace from the given list of file names.
int	getWorkspaceType() The type of workspace the workspace factory opens/creates.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isWorkspace(java.lang.String fileName) True if the specified file identifies a workspace supported by the workspace factory.
boolean	move(IWorkspaceName workspaceName, java.lang.String destinationFolder) Moves a workspace to the specified destination folder.
IWorkspace	open(IPropertySet connectionProperties, int hWnd) Opens the workspace specified by the connection properties.
IWorkspace	openFromFile(java.lang.String fileName, int hWnd) Opens the workspace specified by the given file name.
IWorkspace	openFromString(java.lang.String connectStr, int hWnd) Opens the workspace specified by a connection string.
IPropertySet	readConnectionPropertiesFromFile(java.lang.String fileName) The connection properties from the specified file.
void	release() Release a AMSWorkspaceFactory.
IWorkspaceName	renameConnectionFile(java.lang.String oldPathName, java.lang.String newName) Renames the remote database workspace connection file.
void	resetAllFeatureCounts() Resets total feature count for each TemporalFeatureClass under the workspace or workspace factory.
void	resetAllMessageRates() Resets message rate for each TemporalFeatureClass under the workspace or workspace factory.
void	setAllSampleSizes(int lSampleSize) Sets sample size for each TemporalFeatureClass under the workspace or workspace factory.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AMSWorkspaceFactory

public AMSWorkspaceFactory()
                    throws java.io.IOException,
                           java.net.UnknownHostException

Constructs a AMSWorkspaceFactory using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

AMSWorkspaceFactory

public AMSWorkspaceFactory(java.lang.Object obj)
                    throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AMSWorkspaceFactory theAMSWorkspaceFactory = (AMSWorkspaceFactory) obj;

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

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

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

openFromString

public IWorkspace openFromString(java.lang.String connectStr,
                                 int hWnd)
                          throws java.io.IOException,
                                 AutomationException

Opens the workspace specified by a connection string.

Specified by:

openFromString in interface IWorkspaceFactory2

Parameters:

connectStr - The connectStr (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

public IWorkspace open(IPropertySet connectionProperties,
                       int hWnd)
                throws java.io.IOException,
                       AutomationException

Opens the workspace specified by the connection properties.

Specified by:

open in interface IWorkspaceFactory

Parameters:

connectionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openFromFile

public IWorkspace openFromFile(java.lang.String fileName,
                               int hWnd)
                        throws java.io.IOException,
                               AutomationException

Opens the workspace specified by the given file name.

Specified by:

openFromFile in interface IWorkspaceFactory

Parameters:

fileName - The fileName (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

create

public IWorkspaceName create(java.lang.String parentDirectory,
                             java.lang.String name,
                             IPropertySet connectionProperties,
                             int hWnd)
                      throws java.io.IOException,
                             AutomationException

Creates a new workspace specified by the directory, file name, and connection properties.

Specified by:

create in interface IWorkspaceFactory

Parameters:

parentDirectory - The parentDirectory (in)

name - The name (in)

connectionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

hWnd - The hWnd (A COM typedef) (in)

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.

containsWorkspace

public boolean containsWorkspace(java.lang.String parentDirectory,
                                 IFileNames fileNames)
                          throws java.io.IOException,
                                 AutomationException

Indicates if parentDirectory contains a valid workspace, or is a valid file-system workspace.

Specified by:

containsWorkspace in interface IWorkspaceFactory

Parameters:

parentDirectory - The parentDirectory (in)

fileNames - A reference to a com.esri.arcgis.system.IFileNames (in)

Returns:

The containsWorkspace

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

public IWorkspaceName getWorkspaceName(java.lang.String parentDirectory,
                                       IFileNames fileNames)
                                throws java.io.IOException,
                                       AutomationException

Retrieves the workspace name of a workspace from the given list of file names.

Specified by:

getWorkspaceName in interface IWorkspaceFactory

Parameters:

parentDirectory - The parentDirectory (in)

fileNames - A reference to a com.esri.arcgis.system.IFileNames (in)

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.

getClassID

public IUID getClassID()
                throws java.io.IOException,
                       AutomationException

The class ID of the WorkspaceFactory.

Specified by:

getClassID in interface IWorkspaceFactory

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isWorkspace

public boolean isWorkspace(java.lang.String fileName)
                    throws java.io.IOException,
                           AutomationException

True if the specified file identifies a workspace supported by the workspace factory.

Specified by:

isWorkspace in interface IWorkspaceFactory

Parameters:

fileName - The fileName (in)

Returns:

The isWorkspace

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

readConnectionPropertiesFromFile

public IPropertySet readConnectionPropertiesFromFile(java.lang.String fileName)
                                              throws java.io.IOException,
                                                     AutomationException

The connection properties from the specified file.

Specified by:

readConnectionPropertiesFromFile in interface IWorkspaceFactory

Parameters:

fileName - The fileName (in)

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceDescription

public java.lang.String getWorkspaceDescription(boolean plural)
                                         throws java.io.IOException,
                                                AutomationException

A singular or plural description of the type of workspace the workspace factory opens/creates.

Specified by:

getWorkspaceDescription in interface IWorkspaceFactory

Parameters:

plural - The plural (in)

Returns:

The description

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceType

public int getWorkspaceType()
                     throws java.io.IOException,
                            AutomationException

The type of workspace the workspace factory opens/creates.

Specified by:

getWorkspaceType in interface IWorkspaceFactory

Returns:

A com.esri.arcgis.geodatabase.esriWorkspaceType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

public boolean copy(IWorkspaceName workspaceName,
                    java.lang.String destinationFolder,
                    IWorkspaceName[] workspaceNameCopy)
             throws java.io.IOException,
                    AutomationException

Copies a workspace to the specified destination folder.

Specified by:

copy in interface IWorkspaceFactory

Parameters:

workspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

destinationFolder - The destinationFolder (in)

workspaceNameCopy - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (out: use single element array)

Returns:

The successfulCopy

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

move

public boolean move(IWorkspaceName workspaceName,
                    java.lang.String destinationFolder)
             throws java.io.IOException,
                    AutomationException

Moves a workspace to the specified destination folder.

Specified by:

move in interface IWorkspaceFactory

Parameters:

workspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

destinationFolder - The destinationFolder (in)

Returns:

The successfulMove

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteConnectionFile

public void deleteConnectionFile(java.lang.String pathName)
                          throws java.io.IOException,
                                 AutomationException

Deletes the remote database workspace connection file.

Specified by:

deleteConnectionFile in interface IRemoteDatabaseWorkspaceFactory

Parameters:

pathName - The pathName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

renameConnectionFile

public IWorkspaceName renameConnectionFile(java.lang.String oldPathName,
                                           java.lang.String newName)
                                    throws java.io.IOException,
                                           AutomationException

Renames the remote database workspace connection file.

Specified by:

renameConnectionFile in interface IRemoteDatabaseWorkspaceFactory

Parameters:

oldPathName - The oldPathName (in)

newName - The newName (in)

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.

editConnectionFile

public IWorkspaceName editConnectionFile(java.lang.String pathName,
                                         int hWnd)
                                  throws java.io.IOException,
                                         AutomationException

Edits the properties of a remote database workspace connection file.

Specified by:

editConnectionFile in interface IRemoteDatabaseWorkspaceFactory

Parameters:

pathName - The pathName (in)

hWnd - The hWnd (A COM typedef) (in)

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.

getAllTrackCounts

public IPropertySet getAllTrackCounts()
                               throws java.io.IOException,
                                      AutomationException

Indicates track count for each TemporalFeatureClass under the workspace or workspace factory.

Specified by:

getAllTrackCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllMessageRates

public IPropertySet getAllMessageRates()
                                throws java.io.IOException,
                                       AutomationException

Indicates message rate for each TemporalFeatureClass under the workspace or workspace factory.

Specified by:

getAllMessageRates in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllSampleSizes

public IPropertySet getAllSampleSizes()
                               throws java.io.IOException,
                                      AutomationException

Indicates sample size used for calculating message rate for each TemporalFeatureClass under the workspace or workspace factory.

Specified by:

getAllSampleSizes in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllTotalFeatureCounts

public IPropertySet getAllTotalFeatureCounts()
                                      throws java.io.IOException,
                                             AutomationException

Indicates the total number of features logged for each TemporalFeatureClass under the workspace or workspace factory.

Specified by:

getAllTotalFeatureCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionStatus

public IPropertySet getConnectionStatus()
                                 throws java.io.IOException,
                                        AutomationException

Indicates the connection status of each workspace under the workspace factory

Specified by:

getConnectionStatus in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReceivedMessageCounts

public IPropertySet getReceivedMessageCounts()
                                      throws java.io.IOException,
                                             AutomationException

Indicates total number of messages received.

Specified by:

getReceivedMessageCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPulledMessageCounts

public IPropertySet getPulledMessageCounts()
                                    throws java.io.IOException,
                                           AutomationException

Indicates total number of messages pulled.

Specified by:

getPulledMessageCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDiscardedMessageCounts

public IPropertySet getDiscardedMessageCounts()
                                       throws java.io.IOException,
                                              AutomationException

Indicates total number of messages discarded.

Specified by:

getDiscardedMessageCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentDiscardedMessageCounts

public IPropertySet getCurrentDiscardedMessageCounts()
                                              throws java.io.IOException,
                                                     AutomationException

Indicates current number of messages discarded.

Specified by:

getCurrentDiscardedMessageCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueuedMessageCounts

public IPropertySet getQueuedMessageCounts()
                                    throws java.io.IOException,
                                           AutomationException

Indicates total number of messages queued.

Specified by:

getQueuedMessageCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetAllFeatureCounts

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

Resets total feature count for each TemporalFeatureClass under the workspace or workspace factory.

Specified by:

resetAllFeatureCounts in interface ITemporalWorkspaceStatistics

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetAllMessageRates

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

Resets message rate for each TemporalFeatureClass under the workspace or workspace factory.

Specified by:

resetAllMessageRates in interface ITemporalWorkspaceStatistics

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllSampleSizes

public void setAllSampleSizes(int lSampleSize)
                       throws java.io.IOException,
                              AutomationException

Sets sample size for each TemporalFeatureClass under the workspace or workspace factory.

Specified by:

setAllSampleSizes in interface ITemporalWorkspaceStatistics

Parameters:

lSampleSize - The lSampleSize (in)

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.