com.esri.arcgis.geodatabase
Class IPlugInDatasetHelperProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geodatabase.IPlugInDatasetHelperProxy
All Implemented Interfaces:
IPlugInDatasetHelper, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
IPlugInDatasetHelper2Proxy

public class IPlugInDatasetHelperProxy
extends com.esri.arcgis.interop.Dispatch
implements IPlugInDatasetHelper, java.io.Serializable

Internal use class Proxy for COM Interface 'IPlugInDatasetHelper'. Generated 3/19/2015 1:20:54 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description: 'Provides access to members that help Plug-In datasets.' 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
 boolean noncastable
           
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Constructor Summary
  IPlugInDatasetHelperProxy()
          For internal use only
  IPlugInDatasetHelperProxy(java.lang.Object obj)
           
protected IPlugInDatasetHelperProxy(java.lang.Object obj, java.lang.String iid)
           
  IPlugInDatasetHelperProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
protected IPlugInDatasetHelperProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
           
 IPlugInCursorHelper fetchAll(int classIndex, java.lang.String whereClause, java.lang.Object fieldMap)
          Gets all the records in the database.
 IPlugInCursorHelper fetchByEnvelope(int classIndex, IEnvelope env, boolean strictSearch, java.lang.String whereClause, java.lang.Object fieldMap)
          Gets the records within the envelope (or the full extent if the envelope is null).
 IPlugInCursorHelper fetchByID(int classIndex, int iD, java.lang.Object fieldMap)
          Gets a record by object id.
 IEnvelope getBounds()
          The extent of the dataset.
 int getClassCount()
          The number of classes in the dataset.
 int getClassIndex(java.lang.String name)
          The index of the named class.
 java.lang.String getClassName(int index)
          The name of the indicated class.
 IFields getFields(int classIndex)
          The field set of the indicated class.
 int getOIDFieldIndex(int classIndex)
          The index of the oid field in the field set of the indicated dataset.
 int getShapeFieldIndex(int classIndex)
          The index of the shape field in the field set of the indicated dataset.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable
Constructor Detail

IPlugInDatasetHelperProxy

public IPlugInDatasetHelperProxy(java.lang.String CLSID,
                                 java.lang.String host,
                                 com.esri.arcgis.interop.AuthInfo authInfo)
                          throws java.net.UnknownHostException,
                                 java.io.IOException
Throws:
java.net.UnknownHostException
java.io.IOException

IPlugInDatasetHelperProxy

public IPlugInDatasetHelperProxy()
For internal use only


IPlugInDatasetHelperProxy

public IPlugInDatasetHelperProxy(java.lang.Object obj)
                          throws java.io.IOException
Throws:
java.io.IOException

IPlugInDatasetHelperProxy

protected IPlugInDatasetHelperProxy(java.lang.Object obj,
                                    java.lang.String iid)
                             throws java.io.IOException
Throws:
java.io.IOException

IPlugInDatasetHelperProxy

protected IPlugInDatasetHelperProxy(java.lang.String CLSID,
                                    java.lang.String iid,
                                    java.lang.String host,
                                    com.esri.arcgis.interop.AuthInfo authInfo)
                             throws java.io.IOException
Throws:
java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

getClassCount

public int getClassCount()
                  throws java.io.IOException,
                         AutomationException
The number of classes in the dataset.

Description

Returns the number of classes contained in this dataset. Tables and standalone feature classes should return 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getClassName

public java.lang.String getClassName(int index)
                              throws java.io.IOException,
                                     AutomationException
The name of the indicated class.

Product Availability

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

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

getClassIndex

public int getClassIndex(java.lang.String name)
                  throws java.io.IOException,
                         AutomationException
The index of the named class.

Product Availability

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

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

getBounds

public IEnvelope getBounds()
                    throws java.io.IOException,
                           AutomationException
The extent of the dataset.

Description

Gets an envelope which is the full extent of the data in the dataset. Implementations of the getBounds method should employ the com.esri.arcgis.geometry.Envelope class to define and return an envelope that corresponds to the full extent of the data in the dataset. The spatial reference property on the envelope must be set. All feature classes in a feature dataset share the same bounds and spatial reference.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBounds in interface IPlugInDatasetHelper
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields(int classIndex)
                  throws java.io.IOException,
                         AutomationException
The field set of the indicated class.

Product Availability

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

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

getOIDFieldIndex

public int getOIDFieldIndex(int classIndex)
                     throws java.io.IOException,
                            AutomationException
The index of the oid field in the field set of the indicated dataset.

Product Availability

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

Specified by:
getOIDFieldIndex in interface IPlugInDatasetHelper
Parameters:
classIndex - The classIndex (in)
Returns:
The oIDFieldIndex
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShapeFieldIndex

public int getShapeFieldIndex(int classIndex)
                       throws java.io.IOException,
                              AutomationException
The index of the shape field in the field set of the indicated dataset.

Product Availability

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

Specified by:
getShapeFieldIndex in interface IPlugInDatasetHelper
Parameters:
classIndex - The classIndex (in)
Returns:
The shapeFieldIndex
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

fetchByID

public IPlugInCursorHelper fetchByID(int classIndex,
                                     int iD,
                                     java.lang.Object fieldMap)
                              throws java.io.IOException,
                                     AutomationException
Gets a record by object id.

Description

Returns a record by object ID. The cursor will have a single record. If there is no object with the given id, this method should fail.

FieldMap indicates which fields should be returned by the query. See IPlugInCursorHelper::QueryValues and IPlugInFastQueryValues::FastQueryValues for a description of how to use the field map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
fetchByID in interface IPlugInDatasetHelper
Parameters:
classIndex - The classIndex (in)
iD - The iD (in)
fieldMap - A Variant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IPlugInCursorHelper
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

fetchAll

public IPlugInCursorHelper fetchAll(int classIndex,
                                    java.lang.String whereClause,
                                    java.lang.Object fieldMap)
                             throws java.io.IOException,
                                    AutomationException
Gets all the records in the database.

Description

Returns a cursor of all the records in the dataset that match the optional where clause. An empty or null where clause means all records should be returned. The where clause will always be null if IPlugInWorkspaceFactoryHelper::CanSupportSQL returns false. The method should fail if there are no records.

The field map indicates which fields should be returned by the query. See IPlugInCursorHelper::QueryValues and IPlugInFastQueryValues::FastQueryValues for a description of how to use the field map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
fetchAll in interface IPlugInDatasetHelper
Parameters:
classIndex - The classIndex (in)
whereClause - The whereClause (in)
fieldMap - A Variant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IPlugInCursorHelper
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

fetchByEnvelope

public IPlugInCursorHelper fetchByEnvelope(int classIndex,
                                           IEnvelope env,
                                           boolean strictSearch,
                                           java.lang.String whereClause,
                                           java.lang.Object fieldMap)
                                    throws java.io.IOException,
                                           AutomationException
Gets the records within the envelope (or the full extent if the envelope is null).

Description

Returns a record set of all records that are in the envelope and that match the optional where clause. The where clause will always be null if IPlugInWorkspaceFactoryHelper::CanSupportSQL returns false. The method should fail if there are no records in the envelope that match the optional where clause.

Fieldmap indicates which fields should be returned by the query. See IPlugInCursorHelper::QueryValues and IPlugInFastQueryValues::FastQueryValues for a description of how to use the field map.

Many data sources use spatial indexes or other spatial organization methods. If strictSearch is false, these data sources should return a cursor containing all the records which are in indexes or blocks within the query envelope. If strictSearch is true, the cursor should contain only the records within the envelope. Data sources that donít use indexes or blocks may ignore this parameter.

Remarks

The FetchByEnvelope function returns all records in the Dataset if the Envelope parameter given is Nothing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
fetchByEnvelope in interface IPlugInDatasetHelper
Parameters:
classIndex - The classIndex (in)
env - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
strictSearch - The strictSearch (in)
whereClause - The whereClause (in)
fieldMap - A Variant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IPlugInCursorHelper
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.