com.esri.arcgis.datainterop
Class FMEWorkspaceHelper

java.lang.Object
  extended by com.esri.arcgis.datainterop.FMEWorkspaceHelper
All Implemented Interfaces:
IPlugInMetadataPath, IPlugInWorkspaceHelper, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class FMEWorkspaceHelper
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPlugInWorkspaceHelper, IPlugInMetadataPath

FMEWorkspaceHelper Class

Product Availability

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

See Also:
Serialized Form

Constructor Summary
FMEWorkspaceHelper()
          Constructs a FMEWorkspaceHelper using ArcGIS Engine.
FMEWorkspaceHelper(Object obj)
          Construct a FMEWorkspaceHelper using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 IArray getDatasetNames(int datasetType)
          An array of dataset helpers for each dataset in the workspace.
 String getMetadataPath(String localName)
          The path to the metadata file for the dataset indentified by localName.
 INativeType getNativeType(int datasetType, String localName)
          The native type object for datasetType.
 int hashCode()
          the hashcode for this object
 boolean isOIDIsRecordNumber()
          Indicates whether the OID is the number of the record, i.e., whether id's are continuous.
 boolean isRowCountIsCalculated()
          Indicates if a dataset has to count each row to get the number of rows in the dataset.
 IPlugInDatasetHelper openDataset(String localName)
          Opens a dataset helper for the dataset identified by localName.
 
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

FMEWorkspaceHelper

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

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

FMEWorkspaceHelper

public FMEWorkspaceHelper(Object obj)
                   throws IOException
Construct a FMEWorkspaceHelper using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to FMEWorkspaceHelper.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems FMEWorkspaceHelper theFMEWorkspaceHelper = (FMEWorkspaceHelper) obj;
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

isRowCountIsCalculated

public boolean isRowCountIsCalculated()
                               throws IOException,
                                      AutomationException
Indicates if a dataset has to count each row to get the number of rows in the dataset.

Description

Returns true if the only way to count the number of rows in the dataset is to get a cursor and count. If the data source has a faster method for getting a count of rows in a dataset, this method should return false and the optional interface IPlugInFastRowCount should be implemented on dataset helpers returned by OpenDataset. It is always safe to return true here.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isRowCountIsCalculated in interface IPlugInWorkspaceHelper
Returns:
The rowCountCalculated
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOIDIsRecordNumber

public boolean isOIDIsRecordNumber()
                            throws IOException,
                                   AutomationException
Indicates whether the OID is the number of the record, i.e., whether id's are continuous.

Description

It should return true if the record number of your data source is used as the Object ID, that is the Object IDs are always continuous. If true, some joins are optimized.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isOIDIsRecordNumber in interface IPlugInWorkspaceHelper
Returns:
The oIDIsRecordNumber
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNativeType

public INativeType getNativeType(int datasetType,
                                 String localName)
                          throws IOException,
                                 AutomationException
The native type object for datasetType.

Product Availability

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

Specified by:
getNativeType in interface IPlugInWorkspaceHelper
Parameters:
datasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
localName - The localName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.INativeType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDatasetNames

public IArray getDatasetNames(int datasetType)
                       throws IOException,
                              AutomationException
An array of dataset helpers for each dataset in the workspace.

Product Availability

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

Specified by:
getDatasetNames in interface IPlugInWorkspaceHelper
Parameters:
datasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openDataset

public IPlugInDatasetHelper openDataset(String localName)
                                 throws IOException,
                                        AutomationException
Opens a dataset helper for the dataset identified by localName.

Description

Creates and initializes an instance of the dataset helper class and returns its IPlugInDatasetHelper pointer. If localName is not a local name of a dataset, the method should fail and return a null pointer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
openDataset in interface IPlugInWorkspaceHelper
Parameters:
localName - The localName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IPlugInDatasetHelper
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMetadataPath

public String getMetadataPath(String localName)
                       throws IOException,
                              AutomationException
The path to the metadata file for the dataset indentified by localName.

Product Availability

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

Specified by:
getMetadataPath in interface IPlugInMetadataPath
Parameters:
localName - The localName (in)
Returns:
The metadataPath
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.