XYEventSource (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.geodatabase
Class XYEventSource

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

All Implemented Interfaces:: IClass, IDataset, IDatasetEdit, IDatasetEditInfo, IEventSource, IFeatureClass, IGeoDataset, IObjectClass, IObjectClassInfo, IObjectClassInfo2, ISubtypes, ITable, ITableCapabilities, IVirtualTable, IXYEventSource, java.io.Serializable

public class XYEventSource
extends java.lang.Object
implements IDataset, IDatasetEdit, IDatasetEditInfo, IClass, ITable, ITableCapabilities, IObjectClass, ISubtypes, IObjectClassInfo, IObjectClassInfo2, IFeatureClass, IGeoDataset, IEventSource, IXYEventSource, IVirtualTable

XY event source object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Remarks

A table that contains a field with X coordinates and a field with Y coordinates can be used to dynamically create a point feature class. The feature class is dynamic in that the shapes are generated as needed from data in a source table rather than accessed from a physical data source. The source table that contains the coordinates is called the XY event table.

The XYEventSource class generates a dynamic featureclass from an XY event table. A point, based on the coordinates in the fields specified by XYEvent2FieldsProperties, is created for each row in the XY event table.

In order to create an XYEventSource, you must first create an XYEventSourceName. Since XYEventSource inherits from FeatureClass, it implements the same interfaces and can be treated like any other point feature class. It can be added to ArcMap as a point feature layer and even edited directly with the editor.

There may be some limitations imposed by the XY event table, however. For example, you will not be able to directly edit a feature class created from a delimited text file table since the editor doesn't allow text files to be edited directly. Also, you cannot add or move points using the tools in the editor toolbar. To add or move points, you must edit the coordinates or add new records to the table.

See Also:: IXYEventSourceName, IXYEvent2FieldsProperties, Serialized Form

Constructor Summary
`XYEventSource(java.lang.Object obj)` Construct a XYEventSource 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)`
`void`	`addIObjectClassSchemaEventsListener(IObjectClassSchemaEvents theListener)`
`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.
`IClass`	`getAsIClass()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IDataset`	`getAsIDataset()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IDatasetEdit`	`getAsIDatasetEdit()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IDatasetEditInfo`	`getAsIDatasetEditInfo()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IEventSource`	`getAsIEventSource()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IFeatureClass`	`getAsIFeatureClass()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IGeoDataset`	`getAsIGeoDataset()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IObjectClass`	`getAsIObjectClass()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IObjectClassInfo`	`getAsIObjectClassInfo()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IObjectClassInfo2`	`getAsIObjectClassInfo2()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ISubtypes`	`getAsISubtypes()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ITable`	`getAsITable()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ITableCapabilities`	`getAsITableCapabilities()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IVirtualTable`	`getAsIVirtualTable()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IXYEventSource`	`getAsIXYEventSource()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`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.
`IXYEventProperties`	`getEventProperties()` Property object used to define the X, Y and Z location fields.
`ITable`	`getEventTable()` Table used to initialize the XYEventSource.
`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.
`IField`	`getLengthField()` The geometry length field.
`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.
`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`	`refreshExtent()` Resets the extent of the XYEventSource layer.
`void`	`removeIObjectClassEventsListener(IObjectClassEvents theListener)`
`void`	`removeIObjectClassSchemaEventsListener(IObjectClassSchemaEvents theListener)`
`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`	`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

XYEventSource

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

Construct a XYEventSource using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to XYEventSource.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
* XYEventSource o = (XYEventSource)obj; // will not work XYEventSource o = new XYEventSource(obj); // Use this constructor instead * @param obj an object returned from ArcGIS Engine or Server XYEventSource theXYEventSource = (XYEventSource) obj;
Throws:: java.io.IOException - if there are interop problems

Method Detail