com.esri.arcgis.geodatabase
Class IFeatureClassProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.IClassProxy
          com.esri.arcgis.geodatabase.IObjectClassProxy
              com.esri.arcgis.geodatabase.IFeatureClassProxy

All Implemented Interfaces:

java.io.Externalizable, IClass, IFeatureClass, IObjectClass, java.io.Serializable

Direct Known Subclasses:

INetworkClassProxy

public class IFeatureClassProxy

extends IObjectClassProxy

implements IFeatureClass, java.io.Serializable

Provides access to members that control the behavior and properties of a feature class.

Product Availability

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

See Also:

Serialized Form

Field Summary

static java.lang.Class

targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF

Constructor Summary

	IFeatureClassProxy() For internal use only
	IFeatureClassProxy(java.lang.Object obj)
protected	IFeatureClassProxy(java.lang.Object obj, java.lang.String iid)
	IFeatureClassProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
protected	IFeatureClassProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Adds a Java object to be a listener for a specific kind of event generated by the COM object.
IFeature	createFeature() Create a new feature, with a system assigned object ID and null property values.
IFeatureBuffer	createFeatureBuffer() Create a feature buffer that can be used with an insert cursor.
int	featureCount(IQueryFilter queryFilter) The number of features selected by the specified query.
IField	getAreaField() The geometry area field.
IFeature	getFeature(int iD) Get the feature with the specified object ID.
int	getFeatureClassID() The unique ID for the Feature Class.
IFeatureDataset	getFeatureDataset() The feature dataset that contains the feature class.
IFeatureCursor	getFeatures(java.lang.Object fids, boolean recycling) Get a cursor of Rows given a set of object ids.
int	getFeatureType() The type of features in this feature class.
IField	getLengthField() The geometry length field.
java.lang.String	getShapeFieldName() The name of the default sShape field.
int	getShapeType() The type of the default Shape for the features in this feature class.
IFeatureCursor	IFeatureClass_insert(boolean useBuffering) Returns a cursor that can be used to insert new features.
IFeatureCursor	IFeatureClass_update(IQueryFilter filter, boolean recycling) Returns a cursor that can be used to update features selected by the specified query.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Removes a Java object as a listener to events generated by a COM object.
IFeatureCursor	search(IQueryFilter filter, boolean recycling) Returns an object cursor that can be used to fetch feature objects selected by the specified query.
ISelectionSet	select(IQueryFilter queryFilter, int selType, int selOption, IWorkspace selectionContainer) Returns a selection That contains the object ids selected by the specified query.

Methods inherited from class com.esri.arcgis.geodatabase.IObjectClassProxy

getAliasName, getObjectClassID, getRelationshipClasses

Methods inherited from class com.esri.arcgis.geodatabase.IClassProxy

addField, addIndex, deleteField, deleteIndex, findField, getCLSID, getEXTCLSID, getExtension, getExtensionProperties, getFields, getIndexes, getOIDFieldName, isHasOID

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, hashCode, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, readExternal, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.geodatabase.IObjectClass

getAliasName, getObjectClassID, getRelationshipClasses

Methods inherited from interface com.esri.arcgis.geodatabase.IClass

addField, addIndex, deleteField, deleteIndex, findField, getCLSID, getEXTCLSID, getExtension, getExtensionProperties, getFields, getIndexes, getOIDFieldName, isHasOID

Field Detail

targetClass

public static final java.lang.Class targetClass

Constructor Detail

IFeatureClassProxy

public IFeatureClassProxy(java.lang.String CLSID,
                          java.lang.String host,
                          AuthInfo authInfo)
                   throws java.net.UnknownHostException,
                          java.io.IOException

IFeatureClassProxy

public IFeatureClassProxy()

For internal use only

IFeatureClassProxy

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

IFeatureClassProxy

protected IFeatureClassProxy(java.lang.Object obj,
                             java.lang.String iid)
                      throws java.io.IOException

IFeatureClassProxy

protected IFeatureClassProxy(java.lang.String CLSID,
                             java.lang.String iid,
                             java.lang.String host,
                             AuthInfo authInfo)
                      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

Description copied from class: Dispatch

Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

addListener in class IObjectClassProxy

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Description copied from class: Dispatch

Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

removeListener in class IObjectClassProxy

Throws:

java.io.IOException

getShapeType

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

Description copied from interface: IFeatureClass

The type of the default Shape for the features in this feature class.

Supported Platforms

Windows, Solaris, Linux

Description

ShapeType returns the basic type of geometry of a shape. For the purposes of using the ShapeType property in deciding how to render/symbolize a layer, only esriGeometryPolyline, esriGeometryPolygon, esriGeometryPoint, esriGeometryMulitpoint, and esriGeometryMultipatch need to be checked. All the other types will report as being one of these five types. The reason is that esriGeometryBezier3Curve or esriGeometryPath, etc. can be segments or parts of another shape.

Remarks

This read-only property returns the shape type for the feature class. This shape type can be one of the following esriGeometryType.

Specified by:

getShapeType in interface IFeatureClass

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.

getFeatureType

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

Description copied from interface: IFeatureClass

The type of features in this feature class.

Supported Platforms

Windows, Solaris, Linux

Remarks

This read-only property returns the feature type for the feature class. This feature type can be one of the following esriFeatureType. This property can be used to determine if a feature class is of a particular type, in order for the feature class to added to a network or topology, or possibly to skip over the feature class in an enumeration.

Specified by:

getFeatureType in interface IFeatureClass

Returns:

A com.esri.arcgis.geodatabase.esriFeatureType constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

esriFeatureType

getShapeFieldName

public java.lang.String getShapeFieldName()
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IFeatureClass

The name of the default sShape field.

Supported Platforms

Windows, Solaris, Linux

Remarks

This read-only property returns the name of the geometry field for the feature class.

Specified by:

getShapeFieldName in interface IFeatureClass

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

IGeometry, ILine, IPoint, IPolygon

getAreaField

public IField getAreaField()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IFeatureClass

The geometry area field.

Supported Platforms

Windows, Solaris, Linux

Remarks

This read-only property returns the name of the field which records the area of each feature. Only feature classes that have a ShapeType of esriGeometryPolygon have an Area field.

A null pointer will be returned if:

• the feature class does not have a shape type of esriGeometryPolygon
• the underlying database does not maintain an area field
• the feature class is a shapefile or CAD data
  
  

Specified by:

getAreaField in interface IFeatureClass

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

IField, IFields

getLengthField

public IField getLengthField()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IFeatureClass

The geometry length field.

Supported Platforms

Windows, Solaris, Linux

Remarks

This read-only property returns the name of the field which records the length of each feature. Only feature classes that have a ShapeType of esriGeometryPolygon or esriGeometryPolyLine have a Length field. For Line features, this field records the length of the polyline. For polygon features, this field records the perimeter of the polygon.

A null pointer will be returned if:

• the feature class does not have a shape type of esriGeometryPolygon or esriGeometryPolyLine
• the underlying database does not maintain an area field
• the feature class is a shapefile or CAD data
  

Specified by:

getLengthField in interface IFeatureClass

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

IField, IFields

getFeatureDataset

public IFeatureDataset getFeatureDataset()
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IFeatureClass

The feature dataset that contains the feature class.

Supported Platforms

Windows, Solaris, Linux

Remarks

This read-only property returns the IFeatureDataset interface on the feature dataset that this feature class is a memeber of. If the feature class is a stand alone feature class (it does not have a feature dataset), then this function will return a null pointer. A coverage feature class will return the IFeatureDataset interface to the coverage itself. Shapefiles will always return a null pointer.

Specified by:

getFeatureDataset in interface IFeatureClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IFeatureDataset, IDataset

createFeature

public IFeature createFeature()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IFeatureClass

Create a new feature, with a system assigned object ID and null property values.

Supported Platforms

Windows, Solaris, Linux

Remarks

CreateFeature will create a new feature for the feature class. The new feature is by default assigned a unique object ID (OID). All other fields are initialized to null values if they can be made null and to built-in default values appropriate to the type of the field if they cannot be made null. Use the IFeature::Store method to actually store this new feature in the database. When working with a versioned feature class, CreateFeature should only be called within an edit session. You can start an edit session by calling IWorkspaceEdit::StartEditing. All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.

After calling CreateFeature, the default subtype value is not automatically set nor are default values initialized. For features without a subtype that have defined default values, calling IRowSubtypes::InitDefaultValues will initialize the default values. Use IRowSubtypes::SubtypeCode to set the subtype value for features with subtypes before calling IRowSubtypes::InitDefaultValues to initialize the default values for the particular subtype.

Calling the CreateFeature method on a feature class (via the IFeatureClass interface on the feature class) has the same effect as calling the CreateRow method on the FeatureClass (via the ITable interface on the feature class) except that the IFeatureClass methods return IFeature interfaces on the returned row object.

The basic process to create a new feature is:

1) Create the feature
2) Create the geometry for the feature
3) Store the geometry in the feature
4) Store the feature

Specified by:

createFeature in interface IFeatureClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IFeature, IRowSubtypes, IWorkspaceEdit

getFeature

public IFeature getFeature(int iD)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IFeatureClass

Get the feature with the specified object ID.

Supported Platforms

Windows, Solaris, Linux

Remarks

GetFeature will return the IFeature interface for a feature in the feature class with a given Object ID (OID). This method is typically used to find a particular feature that you know the OID for. Use a cursor if you wish to loop through all features in the feature class.

Calling the GetFeature method on a feature class (via the IFeatureClass interface on the feature class) has the same effect as calling the GetRow method on the FeatureClass (via the ITable interface on the feature class) except that the IFeatureClass methods return IFeature interfaces.

Specified by:

getFeature in interface IFeatureClass

Parameters:

iD - The iD (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

IObject, IFeature

getFeatures

public IFeatureCursor getFeatures(java.lang.Object fids,
                                  boolean recycling)
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IFeatureClass

Get a cursor of Rows given a set of object ids.

Supported Platforms

Windows, Solaris, Linux

Remarks

GetFeatures will return an IFeatureCursor which contains all the features in the feature class with the given Object IDs (OID). This method can be used to loop through a particular set of features that you know the OIDs for.

Calling the GetFeatures method in IFeatureClass has the same effect as calling the GetRows method in ITable except that the IFeatureClass method returns the IFeatureCursor interface on the returned cursor.

Specified by:

getFeatures in interface IFeatureClass

Parameters:

fids - A Variant (in)

recycling - The recycling (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IFeature, IFeatureCursor

getFeatureClassID

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

Description copied from interface: IFeatureClass

The unique ID for the Feature Class.

Supported Platforms

Windows, Solaris, Linux

Remarks

This read-only property will return the unique identifier for this feature class. All feature classes inside Geodatabases have a unique ID. Coverage and Shapefile feature classes do not, so IFeatureClass::FeatureClassID will always return -1 for Coverage and Shapefile feature classes. Since IFeatureClass inherits from IObjectClass, you can also get the feature class ID from IObjectClass:: ObjectClassID.

Specified by:

getFeatureClassID in interface IFeatureClass

Returns:

The fID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IObjectClass

createFeatureBuffer

public IFeatureBuffer createFeatureBuffer()
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IFeatureClass

Create a feature buffer that can be used with an insert cursor.

Supported Platforms

Windows, Solaris, Linux

Remarks

The CreateFeatureBuffer method creates a feature buffer and returns the IFeatureBuffer interface. This can be used to create new features in the feature class with an insert cursor. Like creating a feature with IFeatureClass::CreateFeature, the field values for the new feature must be initialized to some value before it can be stored in the database. All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.

Calling the CreateFeatureBuffer method in IFeatureClass has the same effect as calling the CreateRowBuffer interface in ITable except that the IFeatureClass methods return an IFeatureBuffer interface on the created row buffer.

Specified by:

createFeatureBuffer in interface IFeatureClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IFeature, IFeatureCursor, IFeatureBuffer

featureCount

public int featureCount(IQueryFilter queryFilter)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IFeatureClass

The number of features selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Remarks

FeatureCount returns the number of features that satisfy some attribute and/or spatial query as specified by an IQueryFilter object. If Nothing is supplied for the IQueryFilter, then FeatureCount returns the total number of features in the feature class.

In Java, rather than passing Nothing to get the total number of features, you should pass null.

Specified by:

featureCount in interface IFeatureClass

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Returns:

The numFeatures

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

IQueryFilter

search

public IFeatureCursor search(IQueryFilter filter,
                             boolean recycling)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IFeatureClass

Returns an object cursor that can be used to fetch feature objects selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Remarks

Search will return an IFeatureCursor with all of the features that satisfy some attribute and/or spatial query as specified by an IQueryFilter object. If Nothing is given as the IQueryFilter, then the feature cursor will have all of the features from the feature class.

The recycling parameter controls row object allocation behavior. Recycling cursors rehydrate a single feature object on each fetch and can be used to optimize read-only access, for example, when drawing. It is illegal to maintain a reference on a feature object returned by a recycling cursor across multiple calls to NextFeature on the cursor. Feature objects returned by a recycling cursor should not be modified. Non-recycling cursors return a separate feature object on each fetch. The features returned by a non-recycling cursor may be modified and stored with polymorphic behavior. The Geodatabase guarantees "unique instance semantics" on non-recycling feature objects fetched during an edit session. If the feature object to be retrieved by a call to search has already been instantiated and is being referenced by the calling application, then a reference to the existing feature object is returned.

Feature cursors returned from the Search method cannot be used to update the features in the cursor. The feature cursor returned from the Update method should be used to update those features.

Non-recycling feature cursors returned from the Search method *MUST* be used when copying features from the cursor into an insert cursor of another class. This is because a recycling cursor reuses the same geometry and under some circumstances all of the features inserted into the insert cursor may have the same geometry. Using a non-recycling cursor ensures that each geometry is unique.

Specified by:

search in interface IFeatureClass

Parameters:

filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

recycling - The recycling (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

IQueryFilter, IFeatureCursor

IFeatureClass_update

public IFeatureCursor IFeatureClass_update(IQueryFilter filter,
                                           boolean recycling)
                                    throws java.io.IOException,
                                           AutomationException

Description copied from interface: IFeatureClass

Returns a cursor that can be used to update features selected by the specified query.

Specified by:

IFeatureClass_update in interface IFeatureClass

Parameters:

filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

recycling - The recycling (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

IFeatureClass_insert

public IFeatureCursor IFeatureClass_insert(boolean useBuffering)
                                    throws java.io.IOException,
                                           AutomationException

Description copied from interface: IFeatureClass

Returns a cursor that can be used to insert new features.

Specified by:

IFeatureClass_insert in interface IFeatureClass

Parameters:

useBuffering - The useBuffering (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

select

public ISelectionSet select(IQueryFilter queryFilter,
                            int selType,
                            int selOption,
                            IWorkspace selectionContainer)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IFeatureClass

Returns a selection That contains the object ids selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Remarks

Select will return an ISelectionSet with all of the features that satisfy some attribute and/or spatial query as specified by an IQueryFilter object. If Nothing is given as the IQueryFilter, then the selection will have all of the features from the feature class.

Calling the Select method in IFeatureClass has the same effect as calling the corresponding method in ITable.

When calling Select the selectionContainer parameter is no longer required. Null (C#, VB.Net) or Nothing (VB6) should be supplied it its place.

(Note: Supplying a workspace object for the selectionContainer parameter that is read-only will fail since Select will write the results of the selection to the workspace.)

Specified by:

select in interface IFeatureClass

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

selType - A com.esri.arcgis.geodatabase.esriSelectionType constant (in)

selOption - A com.esri.arcgis.geodatabase.esriSelectionOption constant (in)

selectionContainer - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

ISelectionSet, IQueryFilter