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, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class AttributedRelationshipClass
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRelationshipClass, IDataset, IRelationshipClass2, ITable, IClass, ITableCapabilities, IDatasetEdit, IDatasetEditInfo, IRelClassSchemaEdit

COM Class 'AttributedRelationshipClass'. Generated 9/21/2023 10:01:43 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description 'Esri Attributed Relationship Class object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

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

IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy

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

IID, IIDc9c39723_40b6_454f_a7ff_a25491c72256, xxDummy

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

IID22b00693_8895_11d2_8a0d_006097aff44e

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

IID, IIDfcb01cb5_9f0b_11d0_bec7_00805f7c4268, xxDummy

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

IID1afcdb32_ac09_11d2_8a1e_006097aff44e

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

IID, IID8b0338b9_3b3d_11d4_9fbb_00c04f6bdf0c, xxDummy

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

IID, IID448c5d21_9746_11d1_89e2_006097aff44e, xxDummy

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

IID, IID234c31c1_9740_11d1_89e2_006097aff44e, xxDummy

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

IID, IIDbb7071f4_1678_4029_a358_14b5d33ad7cf, xxDummy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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.
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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.String	getName() The name of the Dataset.
int	getNotification() The notification direction for the relationship class.
IRelClassEnumRowPairs	getObjectsMatchingObjectArray(IArray srcObjectArray, IQueryFilter queryFilterAppliedToMatchingObjects, 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 srcObjectSet) Gets rows pairs of objects that are related to the specified origin or destination object set.
IRelClassEnumRowPairs	getObjectsMatchingObjectSetEx(ISet srcObjectSet, IQueryFilter queryFilterAppliedToMatchingObjects, 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(long 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	release() Release this COM object reference
void	rename(java.lang.String name) Renames this Dataset.
long	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

Throws:

java.io.IOException - if there are interop problems AttributedRelationshipClass theAttributedRelationshipClass = (AttributedRelationshipClass) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

getOriginPrimaryKey

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

The relationship origin primary Key.

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

The relationship destination primary Key.

Specified by:

getDestinationPrimaryKey in interface IRelationshipClass

Returns:

The relDestPKey

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOriginForeignKey

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

The relationship origin foreign Key.

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

The relationship destination foreign Key.

Specified by:

getDestinationForeignKey in interface IRelationshipClass

Returns:

The relDestFKey

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelationshipClassID

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

The relationship class ID.

Specified by:

getRelationshipClassID in interface IRelationshipClass

Returns:

The relClassId

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOriginClass

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

The origin object class.

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

The destination object class.

Specified by:

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

getFeatureDataset

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

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

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

The forward path label for the relationship class.

Specified by:

getForwardPathLabel in interface IRelationshipClass

Returns:

The forwardLabel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackwardPathLabel

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

The backward path label for the relationship class.

Specified by:

getBackwardPathLabel in interface IRelationshipClass

Returns:

The backwardLabel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCardinality

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

The cardinality for the relationship class.

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

The notification direction for the relationship class.

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

createRelationship

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

Creates a new relationship between the two specified objects.

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

Get the relationship that associates the two specified 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:

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

AutomationException - If the ArcObject component throws an exception.

deleteRelationship

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

Deletes the relationship that associates the two specified objects.

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:

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

AutomationException - If the ArcObject component throws an exception.

getObjectsRelatedToObject

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

Gets the objects that are related to the specified object.

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:

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

AutomationException - If the ArcObject component throws an exception.

getRelationshipsForObject

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

Get all relationships that apply to a specified object.

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:

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

AutomationException - If the ArcObject component throws an exception.

deleteRelationshipsForObject

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

Deletes all relationships that apply to a specified object.

Specified by:

deleteRelationshipsForObject in interface IRelationshipClass

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getObjectsRelatedToObjectSet

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

getRelationshipsForObjectSet

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

getObjectsMatchingObjectSet

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

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

Specified by:

getObjectsMatchingObjectSet in interface IRelationshipClass

Parameters:

srcObjectSet - 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

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

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

The relationship rules that apply to this relationship class.

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

Adds a relationship rule to this relationship class.

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

Deletes a relationship rule from this relationship class.

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

The name of the Dataset.

Specified by:

getName in interface IDataset

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullName

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

The associated name object.

Specified by:

getFullName in interface IDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBrowseName

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

The browse name of the dataset.

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

The browse name of the dataset.

Specified by:

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

getType

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

The type of the Dataset.

Specified by:

getType in interface IDataset

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCategory

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

The category of the dataset.

Specified by:

getCategory in interface IDataset

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubsets

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

Datasets contained within this dataset.

Specified by:

getSubsets in interface IDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspace

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

The workspace containing 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

The set of properties for the dataset.

Specified by:

getPropertySet in interface IDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canCopy

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

True if this dataset can be copied.

Specified by:

canCopy in interface IDataset

Returns:

The canCopy

Throws:

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

AutomationException - If the ArcObject component throws an exception.

copy

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

canDelete

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

True if this dataset can be deleted.

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

Deletes this dataset.

Specified by:

delete in interface IDataset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canRename

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

True if this dataset can be renamed.

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

Renames this Dataset.

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 srcObjectSet,
                                                           IQueryFilter queryFilterAppliedToMatchingObjects,
                                                           boolean returnAllObjectMatches)
                                                    throws java.io.IOException,
                                                           AutomationException

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

Specified by:

getObjectsMatchingObjectSetEx in interface IRelationshipClass2

Parameters:

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

queryFilterAppliedToMatchingObjects - 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 srcObjectArray,
                                                           IQueryFilter queryFilterAppliedToMatchingObjects,
                                                           boolean returnAllObjectMatches)
                                                    throws java.io.IOException,
                                                           AutomationException

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

Specified by:

getObjectsMatchingObjectArray in interface IRelationshipClass2

Parameters:

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

queryFilterAppliedToMatchingObjects - 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

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

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(long oID)
            throws java.io.IOException,
                   AutomationException

The row from the database with the specified object ID.

Specified by:

getRow in interface ITable

Parameters:

oID - Signed 64-bit int (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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

createRowBuffer

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

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

Specified by:

createRowBuffer in interface ITable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateSearchedRows

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

deleteSearchedRows

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

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

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 long rowCount(IQueryFilter queryFilter)
              throws java.io.IOException,
                     AutomationException

The number of Rows selected by the specified query.

Specified by:

rowCount in interface ITable

Parameters:

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

Returns:

Signed 64-bit int

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

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

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

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

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

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

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

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

The index of the field with the specified name.

Specified by:

findField in interface IClass

Parameters:

name - The name (in)

Returns:

The fieldIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFields

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

The fields collection for this object class.

Specified by:

getFields in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIndexes

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

The indexes collection for this object class.

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

Adds a field to this object class.

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

Deletes a field from this object class.

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

Adds an index to this object class.

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

Deletes an index from this object class.

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

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

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

The name of the field corresponding to the OID.

Specified by:

getOIDFieldName in interface IClass

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCLSID

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

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

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

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

Specified by:

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

getExtension

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

The extension for this object class.

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

The extension properties for this object class.

Specified by:

getExtensionProperties in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanSelect

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

Indicates if the table supports selection.

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

True if the dataset is being edited.

Specified by:

isBeingEdited in interface IDatasetEdit

Returns:

The isBeingEdited

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

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

Specified by:

isCanEdit in interface IDatasetEditInfo

Returns:

The canEdit

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

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

Specified by:

isCanUndo in interface IDatasetEditInfo

Returns:

The canUndo

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

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

Specified by:

isCanRedo in interface IDatasetEditInfo

Returns:

The canUndo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

alterForwardPathLabel

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

Changes the forward path label for this relationship class.

Specified by:

alterForwardPathLabel in interface IRelClassSchemaEdit

Parameters:

forwardLabel - The forwardLabel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

alterBackwardPathLabel

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

Changes the backward path label for this relationship class.

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

Changes the type of this relationship class.

Specified by:

alterIsComposite in interface IRelClassSchemaEdit

Parameters:

isComposite - The isComposite (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.