com.esri.arcgis.location
Class RouteEventSource

java.lang.Object
  com.esri.arcgis.location.RouteEventSource

All Implemented Interfaces:

IClass, IDataset, IDatasetEdit, IDatasetEditInfo, IEventSource, IEventSourceErrors, IFeatureClass, IGeoDataset, IObjectClass, IObjectClassInfo, IObjectClassInfo2, ISubtypes, ITable, ITableCapabilities, IVirtualTable, com.esri.arcgis.interop.RemoteObjRef, IRouteEventSource, java.io.Serializable

public class RouteEventSource
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataset, IDatasetEdit, IDatasetEditInfo, IClass, ITable, ITableCapabilities, IObjectClass, ISubtypes, IObjectClassInfo, IObjectClassInfo2, IFeatureClass, IGeoDataset, IEventSource, IRouteEventSource, IEventSourceErrors, IVirtualTable

COM Class 'RouteEventSource'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriLocation.olb'

Description 'Route event source 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.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.ITable

IID, IIDfcb01cb5_9f0b_11d0_bec7_00805f7c4268, xxDummy

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

IID, IID8b0338b9_3b3d_11d4_9fbb_00c04f6bdf0c, xxDummy

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

IID, IIDaef78514_848f_11d2_aaba_00c04fa37b82, xxDummy

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

IID, IIDd4803ee6_79f4_11d0_97fc_0080c7f79481, xxDummy

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

IID1afcdb31_ac09_11d2_8a1e_006097aff44e

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

IID1afcdb32_ac09_11d2_8a1e_006097aff44e

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

IID, IID59e43823_7f5a_11d4_9fe6_00c04f6bdf06, xxDummy

Fields inherited from interface com.esri.arcgis.location.IRouteEventSource

IID, IID641755f0_b7de_11d3_9f7c_00c04f6bdf06, xxDummy

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

IID, IIDa9eb56e1_7452_11d4_9fe4_00c04f6bdf06, xxDummy

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

IID, IID8006ff00_6a8b_4476_bdef_0765c11b53eb, xxDummy

Constructor Summary

RouteEventSource(java.lang.Object obj)
Construct a RouteEventSource 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	addIObjectClassEventsListener(IObjectClassEvents theListener) addIObjectClassEventsListener.
void	addIObjectClassSchemaEventsListener(IObjectClassSchemaEvents theListener) addIObjectClassSchemaEventsListener.
void	addSubtype(int subtypeCode, java.lang.String subtypeName) Adds the subtype to the set of associated subtypes.
boolean	canBypassEditSession() Indicates if updates to objects can be safely made outside of an edit session.
boolean	canBypassStoreMethod() Indicates if updates to objects can bypass the Store method and OnChange notifications for efficiency.
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.
IFeature	createFeature() Create a new feature, with a system assigned object ID and null property values.
IFeatureBuffer	createFeatureBuffer() Create a feature buffer that can be used with an insert cursor.
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	deleteSearchedRows(IQueryFilter queryFilter) Delete the Rows in the database selected by the specified query.
void	deleteSubtype(int subtypeCode) Deletes the subtype from the set of associated subtypes.
boolean	equals(java.lang.Object o) Compare this object with another
int	featureCount(IQueryFilter queryFilter) The number of features selected by the specified query.
int	findField(java.lang.String name) The index of the field with the specified name.
java.lang.String	getAliasName() The alias name of the object class.
IField	getAreaField() The geometry area field.
java.lang.String	getBrowseName() The browse name of the dataset.
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.
int	getDefaultSubtypeCode() The default subtype associated with the class.
java.lang.Object	getDefaultValue(int subtypeCode, java.lang.String fieldName) The default value for the associated attribute.
IDomain	getDomain(int subtypeCode, java.lang.String fieldName) The domain given the subtype and field.
ICursor	getErrorCursor(IQueryFilter filter) The cursor of the events with locating errors.
IEnumEventError	getErrors() The enumerator of the event source errors.
IRouteEventProperties	getEventProperties() The route event properties.
ITable	getEventTable() The table of containing route events.
double	getExpandDistance() The distance used to expand spatial searches for laterally offset events.
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.
IEnvelope	getExtent() The extent of the GeoDataset.
IFeature	getFeature(int iD) Get the feature with the specified object ID.
int	getFeatureClassID() The unique ID for the Feature Class.
IFeatureDataset	getFeatureDataset() The feature dataset that contains the feature class.
IFeatureCursor	getFeatures(java.lang.Object fids, boolean recycling) Get a cursor of Rows given a set of object ids.
int	getFeatureType() The type of features in this feature class.
IFields	getFields() The fields collection for this object class.
IName	getFullName() The associated name object.
IIndexes	getIndexes() The indexes collection for this object class.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IField	getLengthField() The geometry length field.
int	getLocatingErrorOID(int oID) The locating error associated with an event's OID.
int	getLocatingErrorRow(IRow row) The locating error associated with a row.
java.lang.String	getName() The name of the Dataset.
int	getObjectClassID() The unique ID for the object class.
java.lang.String	getOIDFieldName() The name of the field corresponding to the OID.
IPropertySet	getPropertySet() The set of properties for the dataset.
IEnumRelationshipClass	getRelationshipClasses(int role) The relationship classes in which this object class participates in for the specified role.
IRouteLocator	getRouteLocator() The route locator.
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.
java.lang.String	getShapeFieldName() The name of the default sShape field.
int	getShapeType() The type of the default Shape for the features in this feature class.
ISpatialReference	getSpatialReference() The spatial reference of the GeoDataset.
IEnumDataset	getSubsets() Datasets contained within this dataset.
int	getSubtypeFieldIndex() The subtype field index.
java.lang.String	getSubtypeFieldName() The subtype field name.
java.lang.String	getSubtypeName(int subtypeCode) The subtype name.
IEnumSubtype	getSubtypes() The subtypes associated with the class.
int	getType() The type of the Dataset.
IWorkspace	getWorkspace() The workspace containing this dataset.
int	hashCode() the hashcode for this object
IFeatureCursor	IFeatureClass_insert(boolean useBuffering) Returns a cursor that can be used to insert new features.
IFeatureCursor	IFeatureClass_update(IQueryFilter filter, boolean recycling) Returns a cursor that can be used to update features selected by the specified query.
ICursor	insert(boolean useBuffering) Returns a cursor that can be used to insert new Rows.
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	isHasOID() Indicates if the class has an object identity (OID) field.
boolean	isHasSubtype() Indicates if the table has subtypes.
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 a RouteEventSource.
void	removeIObjectClassEventsListener(IObjectClassEvents theListener) removeIObjectClassEventsListener.
void	removeIObjectClassSchemaEventsListener(IObjectClassSchemaEvents theListener) removeIObjectClassSchemaEventsListener.
void	rename(java.lang.String name) Renames this Dataset.
int	rowCount(IQueryFilter queryFilter) The number of Rows selected by the specified query.
IFeatureCursor	search(IQueryFilter filter, boolean recycling) Returns an object cursor that can be used to fetch feature objects selected by the specified query.
ISelectionSet	select(IQueryFilter queryFilter, int selType, int selOption, IWorkspace selectionContainer) A selection that contains the object ids selected by the specified query.
void	setBrowseName(java.lang.String name) The browse name of the dataset.
void	setDefaultSubtypeCode(int subtypeCode) The default subtype associated with the class.
void	setDefaultValue(int subtypeCode, java.lang.String fieldName, java.lang.Object value) The default value for the associated attribute.
void	setDomainByRef(int subtypeCode, java.lang.String fieldName, IDomain domain) The domain given the subtype and field.
void	setExpandDistance(double distance) The distance used to expand spatial searches for laterally offset events.
void	setSubtypeFieldName(java.lang.String fieldName) The subtype field name.
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

RouteEventSource

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

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

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

Throws:

java.io.IOException - if there are interop problems RouteEventSource theRouteEventSource = (RouteEventSource) 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()

Deprecated. Internal use only.

Specified by:

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

addIObjectClassEventsListener

public void addIObjectClassEventsListener(IObjectClassEvents theListener)
                                   throws java.io.IOException

addIObjectClassEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.geodatabase.IObjectClassEvents interface.

Throws:

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

removeIObjectClassEventsListener

public void removeIObjectClassEventsListener(IObjectClassEvents theListener)
                                      throws java.io.IOException

removeIObjectClassEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.geodatabase.IObjectClassEvents interface.

Throws:

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

addIObjectClassSchemaEventsListener

public void addIObjectClassSchemaEventsListener(IObjectClassSchemaEvents theListener)
                                         throws java.io.IOException

addIObjectClassSchemaEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.geodatabase.IObjectClassSchemaEvents interface.

Throws:

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

removeIObjectClassSchemaEventsListener

public void removeIObjectClassSchemaEventsListener(IObjectClassSchemaEvents theListener)
                                            throws java.io.IOException

removeIObjectClassSchemaEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.geodatabase.IObjectClassSchemaEvents interface.

Throws:

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

release

public void release()

Release a RouteEventSource.

Specified by:

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

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.

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.

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.

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

The row from the database with the specified object ID.

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

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

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

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 IFeatureClass

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.

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.

getObjectClassID

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

The unique ID for the object class.

Specified by:

getObjectClassID in interface IObjectClass

Returns:

The objectClassID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelationshipClasses

public IEnumRelationshipClass getRelationshipClasses(int role)
                                              throws java.io.IOException,
                                                     AutomationException

The relationship classes in which this object class participates in for the specified role.

Specified by:

getRelationshipClasses in interface IObjectClass

Parameters:

role - A com.esri.arcgis.geodatabase.esriRelRole constant (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAliasName

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

The alias name of the object class.

Specified by:

getAliasName in interface IObjectClass

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasSubtype

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

Indicates if the table has subtypes.

Specified by:

isHasSubtype in interface ISubtypes

Returns:

The hasSubtype

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultSubtypeCode

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

The default subtype associated with the class.

Specified by:

getDefaultSubtypeCode in interface ISubtypes

Returns:

The subtypeCode

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultSubtypeCode

public void setDefaultSubtypeCode(int subtypeCode)
                           throws java.io.IOException,
                                  AutomationException

The default subtype associated with the class.

Specified by:

setDefaultSubtypeCode in interface ISubtypes

Parameters:

subtypeCode - The subtypeCode (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultValue

public java.lang.Object getDefaultValue(int subtypeCode,
                                        java.lang.String fieldName)
                                 throws java.io.IOException,
                                        AutomationException

The default value for the associated attribute.

Specified by:

getDefaultValue in interface ISubtypes

Parameters:

subtypeCode - The subtypeCode (in)

fieldName - The fieldName (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultValue

public void setDefaultValue(int subtypeCode,
                            java.lang.String fieldName,
                            java.lang.Object value)
                     throws java.io.IOException,
                            AutomationException

The default value for the associated attribute.

Specified by:

setDefaultValue in interface ISubtypes

Parameters:

subtypeCode - The subtypeCode (in)

fieldName - The fieldName (in)

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDomain

public IDomain getDomain(int subtypeCode,
                         java.lang.String fieldName)
                  throws java.io.IOException,
                         AutomationException

The domain given the subtype and field.

Specified by:

getDomain in interface ISubtypes

Parameters:

subtypeCode - The subtypeCode (in)

fieldName - The fieldName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDomainByRef

public void setDomainByRef(int subtypeCode,
                           java.lang.String fieldName,
                           IDomain domain)
                    throws java.io.IOException,
                           AutomationException

The domain given the subtype and field.

Specified by:

setDomainByRef in interface ISubtypes

Parameters:

subtypeCode - The subtypeCode (in)

fieldName - The fieldName (in)

domain - A reference to a com.esri.arcgis.geodatabase.IDomain (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubtypeFieldName

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

The subtype field name.

Specified by:

getSubtypeFieldName in interface ISubtypes

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubtypeFieldName

public void setSubtypeFieldName(java.lang.String fieldName)
                         throws java.io.IOException,
                                AutomationException

The subtype field name.

Specified by:

setSubtypeFieldName in interface ISubtypes

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubtypeFieldIndex

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

The subtype field index.

Specified by:

getSubtypeFieldIndex in interface ISubtypes

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubtypeName

public java.lang.String getSubtypeName(int subtypeCode)
                                throws java.io.IOException,
                                       AutomationException

The subtype name.

Specified by:

getSubtypeName in interface ISubtypes

Parameters:

subtypeCode - The subtypeCode (in)

Returns:

The subtypeName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubtypes

public IEnumSubtype getSubtypes()
                         throws java.io.IOException,
                                AutomationException

The subtypes associated with the class.

Specified by:

getSubtypes in interface ISubtypes

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addSubtype

public void addSubtype(int subtypeCode,
                       java.lang.String subtypeName)
                throws java.io.IOException,
                       AutomationException

Adds the subtype to the set of associated subtypes.

Specified by:

addSubtype in interface ISubtypes

Parameters:

subtypeCode - The subtypeCode (in)

subtypeName - The subtypeName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteSubtype

public void deleteSubtype(int subtypeCode)
                   throws java.io.IOException,
                          AutomationException

Deletes the subtype from the set of associated subtypes.

Specified by:

deleteSubtype in interface ISubtypes

Parameters:

subtypeCode - The subtypeCode (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canBypassStoreMethod

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

Indicates if updates to objects can bypass the Store method and OnChange notifications for efficiency.

Remarks

CanBypassStoreMethod is a convenience method that returns True if the instances of this object class have no custom behavior associated with creating or updating objects and if the object class does not participate in composite relationship classes or in relationship classes that require object notification. A return value of True implies that insert cursors handed out by the geodatabase will internally bypass the CreateRow and Store mechanisms when creating objects. A return value of False indicates that insert cursors will not bypass custom Store or OnChanged behavior implemented by the custom row object for this class.

By default, this method returns False for custom object classes. The developer of a custom object class can change this behavior by implementing this interface on the class extension associated with the class and returning True for the method.

In addition, a developer can implement this interface on the class extension of a simple class and set this property to False . Doing this will ensure that when features in the class are inserted, updated or deleted by editor tools that use insert and update cursors, such as Planarize, Create Features and the Object Loader do not bypass Store or OnChanged behavior. By default, this property for a simple class is logically True, meaning these tools will not broacast Geodatabase events which in turn are not rebroadcast as editor events (for which a custom editor application may be listening). Set this to False for those classes for which you always want to have these events broadcast. Alternatively, this can be set globally for the entire edit session using the IWorkspaceEditControl interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canBypassStoreMethod in interface IObjectClassInfo

Specified by:

canBypassStoreMethod in interface IObjectClassInfo2

Returns:

The canBypassStore

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canBypassEditSession

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

Indicates if updates to objects can be safely made outside of an edit session.

Remarks

CanBypassEditSession is a convenience method that returns True if the instances of this object class may be created or updated outside of a Geodatabase edit session (an edit session is started by using the StartEditing method on the IWorkspaceEdit or the StartMultiuserEditing method on the IMultiuserWorkspaceEdit interface).

If True , then applications may update the data in this object class using any of the data updating interfaces and methods described here without starting an edit session. In this case applications are responsible for starting host database transactions as appropriate and for discarding cached object states across transaction boundaries when running on an ArcSDE database.

If False, then applications should always make modifications to the data in this object class within an edit session for correct multi-user behavior and for correct management of database state internally cached by the Geodatabase for the objects in this object class.

This method returns False for network feature classes. By default, this method returns True for non-network custom object classes. The developer of a non-network custom object class can change this behavior by implementing this interface on the class extension associated with the class and returning true for the method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canBypassEditSession in interface IObjectClassInfo2

Returns:

The canBypassEditSession

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getShapeType

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

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

Specified by:

getShapeType in interface IFeatureClass

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureType

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

The type of features in this feature class.

Specified by:

getFeatureType in interface IFeatureClass

Returns:

A com.esri.arcgis.geodatabase.esriFeatureType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getShapeFieldName

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

The name of the default sShape field.

Specified by:

getShapeFieldName in interface IFeatureClass

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAreaField

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

The geometry area field.

Specified by:

getAreaField in interface IFeatureClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLengthField

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

The geometry length field.

Specified by:

getLengthField in interface IFeatureClass

Returns:

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

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 that contains the feature class.

Specified by:

getFeatureDataset in interface IFeatureClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createFeature

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

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

Specified by:

createFeature in interface IFeatureClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeature

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

Get the feature with the specified object ID.

Specified by:

getFeature in interface IFeatureClass

Parameters:

iD - The iD (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatures

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

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

Specified by:

getFeatures in interface IFeatureClass

Parameters:

fids - A Variant (in)

recycling - The recycling (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureClassID

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

The unique ID for the Feature Class.

Specified by:

getFeatureClassID in interface IFeatureClass

Returns:

The fID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createFeatureBuffer

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

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

Specified by:

createFeatureBuffer in interface IFeatureClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

featureCount

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

The number of features selected by the specified query.

Specified by:

featureCount in interface IFeatureClass

Parameters:

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

Returns:

The numFeatures

Throws:

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

AutomationException - If the ArcObject component throws an exception.

search

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

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

Specified by:

search in interface IFeatureClass

Parameters:

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

recycling - The recycling (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

IFeatureClass_update

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

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

Specified by:

IFeatureClass_update in interface IFeatureClass

Parameters:

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

recycling - The recycling (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

IFeatureClass_insert

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

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

Specified by:

IFeatureClass_insert in interface IFeatureClass

Parameters:

useBuffering - The useBuffering (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

The spatial reference of the GeoDataset.

Remarks

This property is read only. For layers, when the first layer is added to ArcMap, its spatial reference is read by this property, and the map is set to this spatial reference.

Instances of the esriCarto.GroupLayer class will return null for this property, as a group layer can contain multiple datasets with different spatial references.

Modifications to a spatial reference returned by this property will not be persisted. To modify the spatial reference of a dataset, the IGeoDatasetSchemaEdit and IGeoDatasetSchemaEdit2 interfaces should be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSpatialReference in interface IGeoDataset

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

The extent of the GeoDataset.

Remarks

The IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.

Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.

If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.

If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.

ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtent in interface IGeoDataset

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRouteLocator

public IRouteLocator getRouteLocator()
                              throws java.io.IOException,
                                     AutomationException

The route locator.

Specified by:

getRouteLocator in interface IRouteEventSource

Returns:

A reference to a com.esri.arcgis.location.IRouteLocator

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEventTable

public ITable getEventTable()
                     throws java.io.IOException,
                            AutomationException

The table of containing route events.

Specified by:

getEventTable in interface IRouteEventSource

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEventProperties

public IRouteEventProperties getEventProperties()
                                         throws java.io.IOException,
                                                AutomationException

The route event properties.

Specified by:

getEventProperties in interface IRouteEventSource

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExpandDistance

public void setExpandDistance(double distance)
                       throws java.io.IOException,
                              AutomationException

The distance used to expand spatial searches for laterally offset events.

Specified by:

setExpandDistance in interface IRouteEventSource

Parameters:

distance - The distance (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExpandDistance

public double getExpandDistance()
                         throws java.io.IOException,
                                AutomationException

The distance used to expand spatial searches for laterally offset events.

Specified by:

getExpandDistance in interface IRouteEventSource

Returns:

The distance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getErrors

public IEnumEventError getErrors()
                          throws java.io.IOException,
                                 AutomationException

The enumerator of the event source errors.

Specified by:

getErrors in interface IEventSourceErrors

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getErrorCursor

public ICursor getErrorCursor(IQueryFilter filter)
                       throws java.io.IOException,
                              AutomationException

The cursor of the events with locating errors.

Specified by:

getErrorCursor in interface IEventSourceErrors

Parameters:

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

getLocatingErrorOID

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

The locating error associated with an event's OID.

Specified by:

getLocatingErrorOID in interface IEventSourceErrors

Parameters:

oID - The oID (in)

Returns:

A com.esri.arcgis.geodatabase.esriLocatingError constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLocatingErrorRow

public int getLocatingErrorRow(IRow row)
                        throws java.io.IOException,
                               AutomationException

The locating error associated with a row.

Specified by:

getLocatingErrorRow in interface IEventSourceErrors

Parameters:

row - A reference to a com.esri.arcgis.geodatabase.IRow (in)

Returns:

A com.esri.arcgis.geodatabase.esriLocatingError constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.