com.esri.arcgis.geodatabase
Class AttributedRelationshipClass

java.lang.Object
  com.esri.arcgis.geodatabase.AttributedRelationshipClass

All Implemented Interfaces:

IClass, IDataset, IDatasetEdit, IDatasetEditInfo, IRelationshipClass, IRelationshipClass2, IRelClassSchemaEdit, ITable, ITableCapabilities, java.io.Serializable

public class AttributedRelationshipClass

extends java.lang.Object

implements IRelationshipClass, IDataset, IRelationshipClass2, ITable, IClass, ITableCapabilities, IDatasetEdit, IDatasetEditInfo, IRelClassSchemaEdit

AttributedRelationshipClass Object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

AttributedRelationshipClass(java.lang.Object obj)
Construct a AttributedRelationshipClass using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	addField(IField field) Adds a field to this object class.
void	addIndex(IIndex index) Adds an index to this object class.
void	addRelationshipRule(IRule rule) Adds a relationship rule to this relationship class.
void	alterBackwardPathLabel(java.lang.String backwardLabel) Changes the backward path label for this relationship class.
void	alterForwardPathLabel(java.lang.String forwardLabel) Changes the forward path label for this relationship class.
void	alterIsComposite(boolean isComposite) Changes the type of this relationship class.
boolean	canCopy() True if this dataset can be copied.
boolean	canDelete() True if this dataset can be deleted.
boolean	canRename() True if this dataset can be renamed.
IDataset	copy(java.lang.String copyName, IWorkspace copyWorkspace) Copies this dataset to a new dataset with the specified name.
IRelationship	createRelationship(IObject originObject, IObject destinationObject) Creates a new relationship between the two specified objects.
IRow	createRow() Creates a row in the database with a system assigned object ID and null property values.
IRowBuffer	createRowBuffer() Creates a row buffer that can be used with an insert cursor.
void	delete() Deletes this dataset.
void	deleteField(IField field) Deletes a field from this object class.
void	deleteIndex(IIndex index) Deletes an index from this object class.
void	deleteRelationship(IObject originObject, IObject destinationObject) Deletes the relationship that associates the two specified objects.
void	deleteRelationshipRule(IRule rule) Deletes a relationship rule from this relationship class.
void	deleteRelationshipsForObject(IObject anObject) Deletes all relationships that apply to a specified object.
void	deleteRelationshipsForObjectSet(ISet anObjectSet) Deletes all relationships that apply to the specified origin or destination object set.
void	deleteSearchedRows(IQueryFilter queryFilter) Delete the Rows in the database selected by the specified query.
boolean	equals(java.lang.Object o) Compare this object with another
int	findField(java.lang.String name) The index of the field with the specified name.
IClass	getAsIClass() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IDataset	getAsIDataset() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IDatasetEdit	getAsIDatasetEdit() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IDatasetEditInfo	getAsIDatasetEditInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IRelationshipClass	getAsIRelationshipClass() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IRelationshipClass2	getAsIRelationshipClass2() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IRelClassSchemaEdit	getAsIRelClassSchemaEdit() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ITable	getAsITable() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ITableCapabilities	getAsITableCapabilities() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
java.lang.String	getBackwardPathLabel() The backward path label for the relationship class.
java.lang.String	getBrowseName() The browse name of the dataset.
int	getCardinality() The cardinality for the relationship class.
java.lang.String	getCategory() The category of the dataset.
IUID	getCLSID() The GUID for the COM Class (CoClass) corresponding to instances of this object class.
IObjectClass	getDestinationClass() The destination object class.
java.lang.String	getDestinationForeignKey() The relationship destination foreign Key.
java.lang.String	getDestinationPrimaryKey() The relationship destination primary Key.
IUID	getEXTCLSID() The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.
java.lang.Object	getExtension() The extension for this object class.
IPropertySet	getExtensionProperties() The extension properties for this object class.
IFeatureDataset	getFeatureDataset() The feature dataset, if any, to which this relationship class belongs.
IFields	getFields() The fields collection for this object class.
java.lang.String	getForwardPathLabel() The forward path label for the relationship class.
IName	getFullName() The associated name object.
IIndexes	getIndexes() The indexes collection for this object class.
java.lang.String	getName() The name of the Dataset.
int	getNotification() The notification direction for the relationship class.
IRelClassEnumRowPairs	getObjectsMatchingObjectArray(IArray pSrcObjectArray, IQueryFilter pQueryFilterAppliedToMatchingObjects, boolean returnAllObjectMatches) Gets rows pairs of objects that are related to the specified origin or destination object array, that also meet the query filter expression.
IRelClassEnumRowPairs	getObjectsMatchingObjectSet(ISet pSrcObjectSet) Gets rows pairs of objects that are related to the specified origin or destination object set.
IRelClassEnumRowPairs	getObjectsMatchingObjectSetEx(ISet pSrcObjectSet, IQueryFilter pQueryFilterAppliedToMatchingObjects, boolean returnAllObjectMatches) Gets rows pairs of objects that are related to the specified origin or destination object set, that also meet the query filter expression.
ISet	getObjectsRelatedToObject(IObject anObject) Gets the objects that are related to the specified object.
ISet	getObjectsRelatedToObjectSet(ISet anObjectSet) Gets the objects that are related to the specified origin or destination object set.
java.lang.String	getOIDFieldName() The name of the field corresponding to the OID.
IObjectClass	getOriginClass() The origin object class.
java.lang.String	getOriginForeignKey() The relationship origin foreign Key.
java.lang.String	getOriginPrimaryKey() The relationship origin primary Key.
IPropertySet	getPropertySet() The set of properties for the dataset.
IRelationship	getRelationship(IObject originObject, IObject destinationObject) Get the relationship that associates the two specified objects.
int	getRelationshipClassID() The relationship class ID.
IEnumRule	getRelationshipRules() The relationship rules that apply to this relationship class.
IEnumRelationship	getRelationshipsForObject(IObject anObject) Get all relationships that apply to a specified object.
IEnumRelationship	getRelationshipsForObjectSet(ISet anObjectSet) Get all relationships that apply to the specified origin or destination object set.
IRow	getRow(int oID) The row from the database with the specified object ID.
ICursor	getRows(java.lang.Object oids, boolean recycling) The cursor of rows based on a set of object ids.
IEnumDataset	getSubsets() Datasets contained within this dataset.
int	getType() The type of the Dataset.
IWorkspace	getWorkspace() The workspace containing this dataset.
int	hashCode() the hashcode for this object
ICursor	insert(boolean useBuffering) Returns a cursor that can be used to insert new Rows.
boolean	isAttributed() Indicates if the relationships in this relationship class have attributes.
boolean	isBeingEdited() True if the dataset is being edited.
boolean	isCanEdit() True if the dataset supports edit sessions with the ability to discard edits on save.
boolean	isCanRedo() True if the dataset supports edit sessions with the ability to redo undone operations.
boolean	isCanSelect() Indicates if the table supports selection.
boolean	isCanUndo() True if the dataset supports edit sessions with the ability to undo individual edit operations.
boolean	isComposite() Indicates if the relationship class represents a composite relationship in which the origin object class represents the composite object.
boolean	isHasOID() Indicates if the class has an object identity (OID) field.
ICursor	ITable_search(IQueryFilter queryFilter, boolean recycling) An object cursor that can be used to fetch row objects selected by the specified query.
void	rename(java.lang.String name) Renames this Dataset.
int	rowCount(IQueryFilter queryFilter) The number of Rows selected by the specified query.
ISelectionSet	select(IQueryFilter queryFilter, int selType, int selOption, IWorkspace selectionContainer) A selection that contains the object ids selected by the specified query.
void	setBrowseName(java.lang.String name) The browse name of the dataset.
ICursor	update(IQueryFilter queryFilter, boolean recycling) Returns a cursor that can be used to update Rows selected by the specified query.
void	updateSearchedRows(IQueryFilter queryFilter, IRowBuffer buffer) Update the Rows in the database selected by the specified query.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributedRelationshipClass

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

Construct a AttributedRelationshipClass using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AttributedRelationshipClass.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
AttributedRelationshipClass o = (AttributedRelationshipClass)obj; // will not work

AttributedRelationshipClass o = new AttributedRelationshipClass(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server AttributedRelationshipClass theAttributedRelationshipClass = (AttributedRelationshipClass) obj;

Throws:

java.io.IOException - if there are interop problems

Method Detail

getAsIRelationshipClass

public IRelationshipClass getAsIRelationshipClass()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIDataset

public IDataset getAsIDataset()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIRelationshipClass2

public IRelationshipClass2 getAsIRelationshipClass2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsITable

public ITable getAsITable()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIClass

public IClass getAsIClass()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsITableCapabilities

public ITableCapabilities getAsITableCapabilities()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIDatasetEdit

public IDatasetEdit getAsIDatasetEdit()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIDatasetEditInfo

public IDatasetEditInfo getAsIDatasetEditInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIRelClassSchemaEdit

public IRelClassSchemaEdit getAsIRelClassSchemaEdit()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getOriginPrimaryKey

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

Description copied from interface: IRelationshipClass

The relationship origin primary Key.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the OriginPrimaryKey property is used for returning a string containing the name of the origins primary key field.

Specified by:

getOriginPrimaryKey in interface IRelationshipClass

Returns:

The relOrigPKey

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDestinationPrimaryKey

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

Description copied from interface: IRelationshipClass

The relationship destination primary Key.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the DestinationPrimaryKey property is used for returning a string containing the name of the destination primary key field.

Specified by:

getDestinationPrimaryKey in interface IRelationshipClass

Returns:

The relDestPKey

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getOriginForeignKey

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

Description copied from interface: IRelationshipClass

The relationship origin foreign Key.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the OriginForeignKey property is used for returning a string containing the name of the origin foreign key field.

Specified by:

getOriginForeignKey in interface IRelationshipClass

Returns:

The relOrigFKey

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDestinationForeignKey

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

Description copied from interface: IRelationshipClass

The relationship destination foreign Key.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the DestinationForeignKey property is used for returning a string containing the name of the destination foreign key field. This property is null except in the case of attributed relationship classes, in which case it is the name of a field in the relationship table. The values in this field reference values in the field designated as the Destination PrimaryKey.

Specified by:

getDestinationForeignKey in interface IRelationshipClass

Returns:

The relDestFKey

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getRelationshipClassID

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

Description copied from interface: IRelationshipClass

The relationship class ID.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the RelationshipClassID property is used for returning a long variable type, containing the id of the relationship class with regard to the relationship class table. This long integer ID uniquely identifies a relationship class within its geodatabase relative to other relationship classes. It is equivalent to IObjectClass::ObjectClassID except that it applies to relationship classes rather than object classes.

Specified by:

getRelationshipClassID in interface IRelationshipClass

Returns:

The relClassId

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getOriginClass

public IObjectClass getOriginClass()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IRelationshipClass

The origin object class.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the OriginClass property is used for returning an interface to the origin objectclass .

Specified by:

getOriginClass in interface IRelationshipClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDestinationClass

public IObjectClass getDestinationClass()
                                 throws java.io.IOException,
                                        AutomationException

Description copied from interface: IRelationshipClass

The destination object class.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the DestinationClass property is used for returning an interface to the destination objectclass .

Specified by:

getDestinationClass in interface IRelationshipClass

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFeatureDataset

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

Description copied from interface: IRelationshipClass

The feature dataset, if any, to which this relationship class belongs.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the FeatureDataset property is used for returning an interface to the FeatureDataset that this relationship class belongs to, if there is one. If there is not, the variable is set to Nothing.

Specified by:

getFeatureDataset in interface IRelationshipClass

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.

getForwardPathLabel

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

Description copied from interface: IRelationshipClass

The forward path label for the relationship class.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the ForwardPathLabel property is used for returning string variable containing the path label for the forward direction path. An example can be shown by using a relationship between a pump station and its pumps. A forward path label may be something like "Contains". It would be read as a pump station 'Contains' pumps.

Specified by:

getForwardPathLabel in interface IRelationshipClass

Returns:

The forwardLabel

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getBackwardPathLabel

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

Description copied from interface: IRelationshipClass

The backward path label for the relationship class.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the BackwardPathLabel property is used for returning string variable containing the path label for the backward direction path. An example can be shown by using a relationship between a pump station and its pumps. A backward path label may be something like "Contained by". It would be read as a pump is 'Contained by' the pump station.

Specified by:

getBackwardPathLabel in interface IRelationshipClass

Returns:

The backwardLabel

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCardinality

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

Description copied from interface: IRelationshipClass

The cardinality for the relationship class.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the Cardinality property is used for returning a esriRelCardinality enumeration type. It refers to the type of relationship formed between an origin class and a destination class. It can be one of three types (1)esriRelCardinalityOneToOne (1-1), (2)esriRelCardinalityOneToMany (1-N), or (3)esriRelCardinalityManyToMany (M-N).

Specified by:

getCardinality in interface IRelationshipClass

Returns:

A com.esri.arcgis.geodatabase.esriRelCardinality constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNotification

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

Description copied from interface: IRelationshipClass

The notification direction for the relationship class.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the Notification property is used for returning a esriRelNotification enumeration type. A notification occurs when an event, such as a deletion or an edit, happens. It can be one of four types (1) esriReNotificationNone, (2) esriRelNotificationForward, (3) esriRelNotificationBackward, or (4) esriRelNotificationBoth. None means no notification will take place, forward means that notification will happen from the origin to the destination. Backward means notification is from the destination to the origin, and both means notification will happen both ways when an event on the relationship class occurs.

Specified by:

getNotification in interface IRelationshipClass

Returns:

A com.esri.arcgis.geodatabase.esriRelNotification constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAttributed

public boolean isAttributed()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IRelationshipClass

Indicates if the relationships in this relationship class have attributes.

Specified by:

isAttributed in interface IRelationshipClass

Returns:

The isAttributed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isComposite

public boolean isComposite()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IRelationshipClass

Indicates if the relationship class represents a composite relationship in which the origin object class represents the composite object.

Specified by:

isComposite in interface IRelationshipClass

Returns:

The isComposite

Throws:

AutomationException - If the ArcObject component throws an exception.

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

createRelationship

public IRelationship createRelationship(IObject originObject,
                                        IObject destinationObject)
                                 throws java.io.IOException,
                                        AutomationException

Description copied from interface: IRelationshipClass

Creates a new relationship between the two specified objects.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the CreateRelationship method is used for creating a relationship between the origin object and the destination object specified in the function parameters. By default, when a relationship class is created, a relationship is created between the objects with corresponding primary and foreign key values. When subsequently using CreateRelationship, remember that this operation will write a value into the foreign key field. Therefore, in the case of 1:1 and 1:M relationship classes, it is possible that you could overwrite, and therefore delete, an existing relationship.

Specified by:

createRelationship in interface IRelationshipClass

Parameters:

originObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

destinationObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelationship

public IRelationship getRelationship(IObject originObject,
                                     IObject destinationObject)
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IRelationshipClass

Get the relationship that associates the two specified objects.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the GetRelationship method is used for returning a relationship interface to the relationship between the origin object and destination object specified in the function parameters. This can be used to retrieve the relationship between two objects.

Specified by:

getRelationship in interface IRelationshipClass

Parameters:

originObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

destinationObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

deleteRelationship

public void deleteRelationship(IObject originObject,
                               IObject destinationObject)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IRelationshipClass

Deletes the relationship that associates the two specified objects.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the DeleteRelationship method is used for deleting the relationship between the origin object and destination object specified in the function parameters. This will remove the entry for this relationship from the relationship class.

Specified by:

deleteRelationship in interface IRelationshipClass

Parameters:

originObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

destinationObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getObjectsRelatedToObject

public ISet getObjectsRelatedToObject(IObject anObject)
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IRelationshipClass

Gets the objects that are related to the specified object.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the GetObjectsRelatedToObject method is used for returning an ISet interface to the objects related to the object specified in the function parameter. An example of its use would be to retrieve the set of capitals related to a particular state.

Specified by:

getObjectsRelatedToObject in interface IRelationshipClass

Parameters:

anObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getRelationshipsForObject

public IEnumRelationship getRelationshipsForObject(IObject anObject)
                                            throws java.io.IOException,
                                                   AutomationException

Description copied from interface: IRelationshipClass

Get all relationships that apply to a specified object.

Supported Platforms

Windows, Solaris, Linux

Remarks

The GetRelationshipsForObject method is used for returning an IEnumRelationship interface to the relationships of the specified relationship class. An example of its use might be for the state of Arizona, to find all the relationships with its cities, in a 'StatesToCities' relationship class.

Specified by:

getRelationshipsForObject in interface IRelationshipClass

Parameters:

anObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

deleteRelationshipsForObject

public void deleteRelationshipsForObject(IObject anObject)
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IRelationshipClass

Deletes all relationships that apply to a specified object.

Supported Platforms

Windows, Solaris, Linux

Remarks

The DeleteRelationshipsForObject method is used for removing all of the relationships in the relationship class that the specified object belongs to. An example of its use might be for the state of Arizona, to remove all the relationships with its cities, in a 'StatesToCities' relationship class. Note that this method is bi-directional; the specified object could belong to the origin class or destination class.

Specified by:

deleteRelationshipsForObject in interface IRelationshipClass

Parameters:

anObject - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getObjectsRelatedToObjectSet

public ISet getObjectsRelatedToObjectSet(ISet anObjectSet)
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IRelationshipClass

Gets the objects that are related to the specified origin or destination object set.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the GetObjectsRelatedToObjectSet method is used for returning an ISet interface that contains the objects that the objects specified in the function parameter is related to. So for example this could be used to get all cities for all states. Using a set which contained all 50 states as the function parameter you could use this method to get all of the cities related to all of the states.

Specified by:

getObjectsRelatedToObjectSet in interface IRelationshipClass

Parameters:

anObjectSet - A reference to a com.esri.arcgis.system.ISet (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getRelationshipsForObjectSet

public IEnumRelationship getRelationshipsForObjectSet(ISet anObjectSet)
                                               throws java.io.IOException,
                                                      AutomationException

Description copied from interface: IRelationshipClass

Get all relationships that apply to the specified origin or destination object set.

Supported Platforms

Windows, Solaris, Linux

Remarks

The GetRelationshipsForObjectSet method is used for returning an IEnumRelationship interface that contains the relationships that the specified objects are in, for a particular relationship class. An example of its use might be to get all of the relationships that all of the states belong to, for a 'StatesToCapitals' relationship class.

Specified by:

getRelationshipsForObjectSet in interface IRelationshipClass

Parameters:

anObjectSet - A reference to a com.esri.arcgis.system.ISet (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getObjectsMatchingObjectSet

public IRelClassEnumRowPairs getObjectsMatchingObjectSet(ISet pSrcObjectSet)
                                                  throws java.io.IOException,
                                                         AutomationException

Description copied from interface: IRelationshipClass

Gets rows pairs of objects that are related to the specified origin or destination object set.

Supported Platforms

Windows, Solaris, Linux

Remarks

The GetObjectsMatchingObjectSet method is used for returning a combined set of related object pairs, for all the relationships in a particular relationship class that the specified objects participate in.. For example, using a set of states as the funtion parameter, an IRelClassEnumRowPairs interface containing the states and the related capitals will be returned if using that relationship class.

Specified by:

getObjectsMatchingObjectSet in interface IRelationshipClass

Parameters:

pSrcObjectSet - A reference to a com.esri.arcgis.system.ISet (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteRelationshipsForObjectSet

public void deleteRelationshipsForObjectSet(ISet anObjectSet)
                                     throws java.io.IOException,
                                            AutomationException

Description copied from interface: IRelationshipClass

Deletes all relationships that apply to the specified origin or destination object set.

Supported Platforms

Windows, Solaris, Linux

Remarks

The DeleteRelationshipsForObjectSet method is used for removing all relationships in a particular relationship class for the specified set of objects. An example of its use might be to delete the relationships for all of the state objects with respect to a 'StatesToCities' relationship class.

This method works in the same way as the DeleteRelationshipsForObject method, except on a set of objects rather than a single one.

Specified by:

deleteRelationshipsForObjectSet in interface IRelationshipClass

Parameters:

anObjectSet - A reference to a com.esri.arcgis.system.ISet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelationshipRules

public IEnumRule getRelationshipRules()
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IRelationshipClass

The relationship rules that apply to this relationship class.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the RelationshipRules method is used for retrieving all of the relationship rules of this relationshipclass from the geodatabase. Relationship classes can have an associated set of relationship rules. These rules are used to control which object subtypes from the origin class can be related to which object subtypes in the destination class. They can also be used to specify a valid cardinality range for all permissable subtype pairs. An example would be the subtype wood poles may be allowed to have attached between 1 and 3 transformers, however, the subtype steel pole may be allowed to have attached between 1 and 5 transformers. These are referred to as the cardinality range.

Specified by:

getRelationshipRules in interface IRelationshipClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addRelationshipRule

public void addRelationshipRule(IRule rule)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IRelationshipClass

Adds a relationship rule to this relationship class.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the AddRelationshipRule method is used for adding a new relationship rule to the geodatabase. Relationship classes can have an associated set of relationship rules. These rules are used to control which object subtypes from the origin class can be related to which object subtypes in the destination class. They can also be used to specify a valid cardinality range for all permissable subtype pairs. An example would be the subtype wood poles may be allowed to have attached between 1 and 3 transformers, however, the subtype steel pole may be allowed to have attached between 1 and 5 transformers. These are referred to as the cardinality range.

Specified by:

addRelationshipRule in interface IRelationshipClass

Parameters:

rule - A reference to a com.esri.arcgis.geodatabase.IRule (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteRelationshipRule

public void deleteRelationshipRule(IRule rule)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IRelationshipClass

Deletes a relationship rule from this relationship class.

Supported Platforms

Windows, Solaris, Linux

Remarks

When using a relationship class, the DeleteRelationshipRule method is used for deleting a relationship rule from the geodatabase. Relationship classes can have an associated set of relationship rules. These rules are used to control which object subtypes from the origin class can be related to which object subtypes in the destination class. They can also be used to specify a valid cardinality range for all permissable subtype pairs. An example would be the subtype wood poles may be allowed to have attached between 1 and 3 transformers, however, the subtype steel pole may be allowed to have attached between 1 and 5 transformers. These are referred to as the cardinality range.

Specified by:

deleteRelationshipRule in interface IRelationshipClass

Parameters:

rule - A reference to a com.esri.arcgis.geodatabase.IRule (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

Description copied from interface: IDataset

The name of the Dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IDataset

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IDataset

The associated name object.

Supported Platforms

Windows, Solaris, Linux

Remarks

The FullName property returns a Name object for the dataset. The Name object can be persisted and provides a way to get back to the dataset in a future session of the application, via the Open method on the Name object.

Specified by:

getFullName in interface IDataset

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getBrowseName

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

Description copied from interface: IDataset

The browse name of the dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

BrowseName returns file names without their extension. For example, States.shp would appear as States.

Specified by:

getBrowseName in interface IDataset

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IDataset

The browse name of the dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBrowseName in interface IDataset

Parameters:

name - The name (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getType

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

Description copied from interface: IDataset

The type of the Dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Type property returns the enumerated type for the dataset, such as esriDTTable or esriDTFeatureDataset.

Specified by:

getType in interface IDataset

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCategory

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

Description copied from interface: IDataset

The category of the dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

IDataset::Category returns a description of the category of the dataset. The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog. The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".

The description returned from IDataset::Category may change between releases of ArcGIS.

Specified by:

getCategory in interface IDataset

Returns:

The category

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSubsets

public IEnumDataset getSubsets()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IDataset

Datasets contained within this dataset.

Supported Platforms

Windows, Solaris, Linux

Description

The Subsets property returns other Dataset objects contained in this dataset.

Remarks

IDataset::Subsets is not supported for Graph objects such as a Geometric Network. To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.

Specified by:

getSubsets in interface IDataset

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IDataset

The workspace containing this dataset.

Supported Platforms

Windows, Solaris, Linux

Description

The Workspace property returns the containing workspace for this dataset.

Specified by:

getWorkspace in interface IDataset

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.

getPropertySet

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

Description copied from interface: IDataset

The set of properties for the dataset.

Supported Platforms

Windows, Solaris, Linux

Description

The PropertySet property is used to return any additional intrinsic properties (but not metadata properties) that may apply to the dataset. One use of this property is to distinguish between the types of File Geodatabase datafile formats. If called on a Feature Class or Table in a File Geodatabase the Datafile Format property can either be esriFGDBStandardDatafile or esriFGDBCompressedDatafile.

Remarks

Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.

IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.

Specified by:

getPropertySet in interface IDataset

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

canCopy

public boolean canCopy()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IDataset

True if this dataset can be copied.

Supported Platforms

Windows, Solaris, Linux

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

The CanCopy method is supported by:

• CAD Drawings
• Coverages
• DBase Tables
• Info Tables
• Raster Datasets
• SDC datasets
• SDC Network Datasets
• Shapefiles
• Shapefile Network Datasets

Specified by:

canCopy in interface IDataset

Returns:

The canCopy

Throws:

AutomationException - If the ArcObject component throws an exception.

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

copy

public IDataset copy(java.lang.String copyName,
                     IWorkspace copyWorkspace)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IDataset

Copies this dataset to a new dataset with the specified name.

Supported Platforms

Windows, Solaris, Linux

Remarks

IDataset::Copy does not support the copying of Graph objects such as a Geometric Network.

Specified by:

copy in interface IDataset

Parameters:

copyName - The copyName (in)

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

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

GeoDBDataTransfer

canDelete

public boolean canDelete()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IDataset

True if this dataset can be deleted.

Supported Platforms

Windows, Solaris, Linux

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

Specified by:

canDelete in interface IDataset

Returns:

The canDelete

Throws:

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

AutomationException - If the ArcObject component throws an exception.

delete

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

Description copied from interface: IDataset

Deletes this dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.

Specified by:

delete in interface IDataset

Throws:

AutomationException - If the ArcObject component throws an exception.

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

canRename

public boolean canRename()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IDataset

True if this dataset can be renamed.

Supported Platforms

Windows, Solaris, Linux

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

Specified by:

canRename in interface IDataset

Returns:

The canRename

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rename

public void rename(java.lang.String name)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IDataset

Renames this Dataset.

Supported Platforms

Windows, Solaris, Linux

Remarks

IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network. In addition, certain feature classes, such as network feature classes, cannot be renamed.

Specified by:

rename in interface IDataset

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getObjectsMatchingObjectSetEx

public IRelClassEnumRowPairs getObjectsMatchingObjectSetEx(ISet pSrcObjectSet,
                                                           IQueryFilter pQueryFilterAppliedToMatchingObjects,
                                                           boolean returnAllObjectMatches)
                                                    throws java.io.IOException,
                                                           AutomationException

Description copied from interface: IRelationshipClass2

Gets rows pairs of objects that are related to the specified origin or destination object set, that also meet the query filter expression.

Supported Platforms

Windows, Solaris, Linux

Remarks

The returnAllObjectMatches parameter indicates whether the first matching object or if all matching objects are returned. A value of True will return all object matches.

Specified by:

getObjectsMatchingObjectSetEx in interface IRelationshipClass2

Parameters:

pSrcObjectSet - A reference to a com.esri.arcgis.system.ISet (in)

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

returnAllObjectMatches - The returnAllObjectMatches (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getObjectsMatchingObjectArray

public IRelClassEnumRowPairs getObjectsMatchingObjectArray(IArray pSrcObjectArray,
                                                           IQueryFilter pQueryFilterAppliedToMatchingObjects,
                                                           boolean returnAllObjectMatches)
                                                    throws java.io.IOException,
                                                           AutomationException

Description copied from interface: IRelationshipClass2

Gets rows pairs of objects that are related to the specified origin or destination object array, that also meet the query filter expression.

Supported Platforms

Windows, Solaris, Linux

Remarks

The returnAllObjectMatches parameter indicates whether the first matching object or if all matching objects are returned. A value of True will return all object matches.

Specified by:

getObjectsMatchingObjectArray in interface IRelationshipClass2

Parameters:

pSrcObjectArray - A reference to a com.esri.arcgis.system.IArray (in)

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

returnAllObjectMatches - The returnAllObjectMatches (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createRow

public IRow createRow()
               throws java.io.IOException,
                      AutomationException

Description copied from interface: ITable

Creates a row in the database with a system assigned object ID and null property values.

Supported Platforms

Windows, Solaris, Linux

Remarks

The CreateRow method creates a new row in the underlying database with a system assigned object id value. A row object representing the created row is returned to the caller. The row object returned has the system assigned object ID as the value of the OIDField. 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.

The caller is responsible for setting the desired field values into the row and calling the Store method on the row. If the table represents an object class with subtypes, then it is the caller’s responsibility to set the default subtype code into the row and call the InitDefaultValues method on the row before storing, if that is the desired result. For tables without object behavior, insert cursors offer a more efficient way for inserting new rows.

Specified by:

createRow in interface ITable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRow

public IRow getRow(int oID)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: ITable

The row from the database with the specified object ID.

Supported Platforms

Windows, Solaris, Linux

Remarks

The GetRow method returns an existing row object, given its object ID value. The caller can query the returned row object for additional object specific interfaces. The retrieved row may be modified; calling Store on the row object after changing it will trigger messages to related objects and will mark the row for committing to the database.

Specified by:

getRow in interface ITable

Parameters:

oID - The oID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRows

public ICursor getRows(java.lang.Object oids,
                       boolean recycling)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: ITable

The cursor of rows based on a set of object ids.

Supported Platforms

Windows, Solaris, Linux

Remarks

The GetRows method returns a cursor that may be used to retrieve a set of rows specified by the input array of object id values. See the description of the Search method to understand the meaning of the recycling parameter. It is far more efficient to retrieve a set of rows using the GetRows method than it is to retrieve each individual row using the GetRow method. The retrieved rows may be modified; Store should be called on the row objects after changing them.

Specified by:

getRows in interface ITable

Parameters:

oids - A Variant (in)

recycling - The recycling (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

createRowBuffer

public IRowBuffer createRowBuffer()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: ITable

Creates a row buffer that can be used with an insert cursor.

Supported Platforms

Windows, Solaris, Linux

Remarks

The CreateRowBuffer method creates a new row buffer object in memory and returns it to the caller. No row is created in the database. The returned row buffer does not have an object ID value. The caller can set values into the row buffer and use it as an argument to the InsertRow method on an insert cursor; the latter is obtained by calling the Insert method on the Table.

Specified by:

createRowBuffer in interface ITable

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

updateSearchedRows

public void updateSearchedRows(IQueryFilter queryFilter,
                               IRowBuffer buffer)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: ITable

Update the Rows in the database selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Remarks

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.

Specified by:

updateSearchedRows in interface ITable

Parameters:

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

buffer - A reference to a com.esri.arcgis.geodatabase.IRowBuffer (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

deleteSearchedRows

public void deleteSearchedRows(IQueryFilter queryFilter)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: ITable

Delete the Rows in the database selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deleteSearchedRows in interface ITable

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rowCount

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

Description copied from interface: ITable

The number of Rows selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Specified by:

rowCount in interface ITable

Parameters:

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

Returns:

The numRows

Throws:

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

AutomationException - If the ArcObject component throws an exception.

ITable_search

public ICursor ITable_search(IQueryFilter queryFilter,
                             boolean recycling)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: ITable

An object cursor that can be used to fetch row objects selected by the specified query.

Specified by:

ITable_search in interface ITable

Parameters:

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

recycling - The recycling (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

public ICursor update(IQueryFilter queryFilter,
                      boolean recycling)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: ITable

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

Supported Platforms

Windows, Solaris, Linux

Remarks

The Update method returns an ‘update’ cursor that can be used to update or delete rows. It offers somewhat faster performance than multiple calls to Store or Delete on row objects fetched using a non-recycling search cursor for tables storing simple rows and simple features. There is no difference in performance for custom features.

All edits to features that participate in a Topology or Geometric Network must be bracketed within an edit operation.

Specified by:

update in interface ITable

Parameters:

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

recycling - The recycling (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insert

public ICursor insert(boolean useBuffering)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: ITable

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

Supported Platforms

Windows, Solaris, Linux

Remarks

The Insert method returns an ‘insert’ cursor that can be used to bulk insert rows. It offers significantly faster performance than multiple calls to CreateRow and Store for tables storing simple rows and simple features (that is, for tables whose CLSID is esriGeoDatabase.Row, esriGeoDatabase.Object, or esriGeoDatabase.Feature).

Insert cursors on tables containing custom rows and objects use the CreateRow and Store methods to achieve polymorphism, and there is no difference in performance in these cases.

Specified by:

insert in interface ITable

Parameters:

useBuffering - The useBuffering (in)

Returns:

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

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: ITable

A selection that contains the object ids selected by the specified query.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Select method returns a selection set that holds either row ids or row objects from the Table depending on the selection option. Multiple selection sets can be created on the same table. It is up to a client application or object to keep a reference on created selections and use them as appropriate. For example, a FeatureLayer creates and uses selections on a FeatureClass (a type of Table).

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

Specified by:

select in interface ITable

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.

findField

public int findField(java.lang.String name)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IClass

The index of the field with the specified name.

Supported Platforms

Windows, Solaris, Linux

Remarks

If FindField returns -1, the Field could not be found in the Fields collection.

Specified by:

findField in interface IClass

Parameters:

name - The name (in)

Returns:

The fieldIndex

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFields

public IFields getFields()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IClass

The fields collection for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFields in interface IClass

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getIndexes

public IIndexes getIndexes()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IClass

The indexes collection for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getIndexes in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addField

public void addField(IField field)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IClass

Adds a field to this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

addField in interface IClass

Parameters:

field - A reference to a com.esri.arcgis.geodatabase.IField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteField

public void deleteField(IField field)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IClass

Deletes a field from this object class.

Supported Platforms

Windows, Solaris, Linux

Remarks

DeleteField removes the specified field from a table, object class or feature class. Fields that are required by the Geodatabase and cannot be removed include:

• OBJECTID field
• SHAPE and shape dependent fields such as SHAPE_Length
• Enabled, AncillaryRole and Weight field for network feature classes
• Subtype fields. In order to delete a subtype field, it must first be removed as the subtype field, see the help on ISubtypes::SubtypeFieldName

Specified by:

deleteField in interface IClass

Parameters:

field - A reference to a com.esri.arcgis.geodatabase.IField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addIndex

public void addIndex(IIndex index)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IClass

Adds an index to this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

addIndex in interface IClass

Parameters:

index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteIndex

public void deleteIndex(IIndex index)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IClass

Deletes an index from this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deleteIndex in interface IClass

Parameters:

index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasOID

public boolean isHasOID()
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IClass

Indicates if the class has an object identity (OID) field.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isHasOID in interface IClass

Returns:

The hasOID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

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

Description copied from interface: IClass

The name of the field corresponding to the OID.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOIDFieldName in interface IClass

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCLSID

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

Description copied from interface: IClass

The GUID for the COM Class (CoClass) corresponding to instances of this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCLSID in interface IClass

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.

getEXTCLSID

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

Description copied from interface: IClass

The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getEXTCLSID in interface IClass

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getExtension

public java.lang.Object getExtension()
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IClass

The extension for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtension in interface IClass

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtensionProperties

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

Description copied from interface: IClass

The extension properties for this object class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtensionProperties in interface IClass

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isCanSelect

public boolean isCanSelect()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: ITableCapabilities

Indicates if the table supports selection.

Supported Platforms

Windows, Solaris, Linux

Remarks

Use CanSelect to determine if you can open a selection set on the table. A situation where CanSelect will be False is a standalone database table without an OID column.

Specified by:

isCanSelect in interface ITableCapabilities

Returns:

The canSelect

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBeingEdited

public boolean isBeingEdited()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IDatasetEdit

True if the dataset is being edited.

Specified by:

isBeingEdited in interface IDatasetEdit

Returns:

The pIsBeingEdited

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanEdit

public boolean isCanEdit()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IDatasetEditInfo

True if the dataset supports edit sessions with the ability to discard edits on save.

Supported Platforms

Windows, Solaris, Linux

Remarks

This property is to be used within an active edit session, results cannot be guaranteed if called on a dataset outside of an edit session.

Specified by:

isCanEdit in interface IDatasetEditInfo

Returns:

The pCanEdit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanUndo

public boolean isCanUndo()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IDatasetEditInfo

True if the dataset supports edit sessions with the ability to undo individual edit operations.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCanUndo in interface IDatasetEditInfo

Returns:

The pCanUndo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanRedo

public boolean isCanRedo()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IDatasetEditInfo

True if the dataset supports edit sessions with the ability to redo undone operations.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCanRedo in interface IDatasetEditInfo

Returns:

The pCanUndo

Throws:

AutomationException - If the ArcObject component throws an exception.

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

alterForwardPathLabel

public void alterForwardPathLabel(java.lang.String forwardLabel)
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IRelClassSchemaEdit

Changes the forward path label for this relationship class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

alterForwardPathLabel in interface IRelClassSchemaEdit

Parameters:

forwardLabel - The forwardLabel (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

alterBackwardPathLabel

public void alterBackwardPathLabel(java.lang.String backwardLabel)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IRelClassSchemaEdit

Changes the backward path label for this relationship class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

alterBackwardPathLabel in interface IRelClassSchemaEdit

Parameters:

backwardLabel - The backwardLabel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

alterIsComposite

public void alterIsComposite(boolean isComposite)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IRelClassSchemaEdit

Changes the type of this relationship class.

Supported Platforms

Windows, Solaris, Linux

Specified by:

alterIsComposite in interface IRelClassSchemaEdit

Parameters:

isComposite - The isComposite (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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