com.esri.arcgis.trackinganalyst
Class TemporalFeatureLayer

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.TemporalFeatureLayer
All Implemented Interfaces:
IAttributeTable, IDataLayer, IDataLayer2, IDisplayTable, IDynamicLayer, IFeatureLayer, IFeatureLayer2, IFeatureLayerDefinition, IFeatureSelection, IFind, IIdentify, IIdentify2, ILayer, ILayer2, ILayerDrawingProperties, ILayerExtensions, ILayerFields, ILayerGeneralProperties, ILayerInfo, ILayerPosition, ILayerPropertySheet, ILegendInfo, ITableSelection, IDisplayAdmin, IMapLevel, IClass, IDataset, IGeoDataset, ITable, ITableFields, ICustomGlobeLayer, com.esri.arcgis.interop.RemoteObjRef, IPropertySupport, ITemporalLayer, ITemporalSearch, ITimeRegionalSettings, ITimeZone, ITrackingGlobeLayerLeaderLines, ITrackingLayerLabels, Serializable

public class TemporalFeatureLayer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITemporalLayer, ITemporalSearch, ITimeRegionalSettings, ILayer, ILayer2, ILegendInfo, ILayerInfo, ITrackingLayerLabels, IIdentify, IFeatureSelection, IFeatureLayerDefinition, IGeoDataset, IIdentify2, ITableSelection, IFind, IDisplayTable, IFeatureLayer, IFeatureLayer2, IPropertySupport, ILayerFields, ITableFields, IAttributeTable, ITable, IClass, ILayerExtensions, IDisplayAdmin, ILayerDrawingProperties, IDataset, ILayerPosition, IMapLevel, IDataLayer, IDataLayer2, ITimeZone, ILayerPropertySheet, ILayerGeneralProperties, IDynamicLayer, ICustomGlobeLayer, ITrackingGlobeLayerLeaderLines

Defines the coclass IDL parameters and attributes of the TemporalFeatureLayer COM object.

Description

This object extends ESRI's feature layer by adding another interface and changing the selection and drawing behavior to accommodate feature classes with temporal characteristics. In addition it supports some new drawing phases that allow efficient drawing of dynamically changing data or temporal attribution. The Temporal Feature Layer is capable of using any feature class, existing ESRI feature classes or real-time feature classes. This object makes a temporal index of the feature class in memory and uses this temporal index to obtain features for displaying, identification, {TBD}, etc… In addition it enables the user to control whether or not to cache these features and how much to cache about the temporal period of interest. All ESRI feature layers allow caching of the display drawn in one of the systems display cache and this object is no different. This enable us to cache the display and if there are not any changes then we don't have to re-render the features thus reducing the processing it takes to re-draw the feature class.

This object extends the ESRI drawing phase concept by introducing support for a new phase that enable just the changes to be drawn. This phase effectively just re-draws the features that have changed temporal symbology due to a change in the temporal reference property, features that should no longer be drawn are drawn with a neutral color determined by the temporal renderer. The temporal renderer effectively performs the drawing however the information about symbol changes are stored in the Temporal Records, one of this object's internal objects.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

See Also:
Serialized Form

Constructor Summary
TemporalFeatureLayer()
          Constructs a TemporalFeatureLayer using ArcGIS Engine.
TemporalFeatureLayer(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TemporalFeatureLayer theTemporalFeatureLayer = (TemporalFeatureLayer) obj;
 
Method Summary
 void add(IFeature feature)
          Adds a feature to the selection set.
 void addExtension(Object ext)
          Adds a new extension.
 void addField(IField field)
          Adds a field to this object class.
 void addILayerEventsListener(ILayerEvents theListener)
          addILayerEventsListener.
 void addIndex(IIndex index)
          Adds an index to this object class.
 void addRow(IRow row)
          Adds a row to the selection set (honoring the current combination method).
 boolean applies(Object pUnk)
          Indicates if the receiver can apply the given object at any given time.
 Object apply(Object newObject)
          Applies the given property to the receiver and returns the old object.
 boolean canApply(Object pUnk)
          Indicates if the receiver can apply the given object at that particular moment.
 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.
 void clear()
          Clears the selection.
 boolean connect(IName pOptRepairName)
          Connects the layer to its data source.
 IDataset copy(String copyName, IWorkspace copyWorkspace)
          Copies this dataset to a new dataset with the specified name.
 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.
 IFeatureLayer createSelectionLayer(String layerName, boolean useCurrentSelection, String joinTableNames, String expression)
          Creates a new feature layer from the existing layer based on the current selection and the specified query expression.
 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 disconnect()
          Disconnects the data from the layer.
 void draw(int drawPhase, IDisplay display, ITrackCancel trackCancel)
          Draws the layer to the specified display for the given draw phase.
 void drawDynamicLayer(int dynamicDrawPhase, IDisplay display, IDynamicDisplay dynamicDisplay)
          Draws the layer to the specified display for the given draw phase.
 void drawImmediate(IGlobeViewer pGlobeViewer)
          For custom OpenGL layers, perform immediate drawing.
 boolean equals(Object o)
          Compare this object with another
 void expandRegionForSymbols(IDisplay display, IGeometry region)
          Expands the given geometry by an amount that will include the layer's symbology for the given display.
 IArray find(String search, boolean contains, Object fields, ITrackCancel trackCancel)
          Finds the specified search string in the given attribute fields.
 int findField(String fieldName)
          Returns the index of the field with the specified name.
 IActionCollection getActionCollection()
          The collection of action objects for this temporal layer.
 String getAMDesignator()
          String for the AM designator.
 IEnvelope getAreaOfInterest()
          The default area of interest for the layer.
 ITable getAttributeTable()
          The attribute table.
 String getBrowseName()
          The browse name of the dataset.
 double getBufferDistance()
          Buffer distance used for the selection.
 String getCategory()
          The category of the dataset.
static String getClsid()
          getClsid.
 IUID getCLSID()
          The GUID for the COM Class (CoClass) corresponding to instances of this object class.
 int getCombinationMethod()
          Combination method for the selection.
 Object getCurrent(Object pUnk)
          The object currently being used.
 String getCurrentZone()
          The current Time Zone.
 IName getDataSourceName()
          Name of the data object for the layer.
 String getDataSourceType()
          Data source type.
 String getDateStyleFormat()
          Date style used when parsing the date portion of a time string in the temporal column.
 String getDefinitionExpression()
          Definition query expression for the existing layer.
 ISelectionSet getDefinitionSelectionSet()
          The selection set that defines the subset of features in a selection layer.
 String getDisplayField()
          Primary display field.
 ISelectionSet getDisplaySelectionSet()
          The selected set of rows from the display table.
 ITable getDisplayTable()
          The display table.
 int getDrawType()
          The custom draw method.
 int getDynamicRecompileRate()
          Recompile Rate is the interval in milliseconds by which the dynamic layer draw method will be called, with the compiled draw phase.
 IColor getElevatedLinesColor()
          Specifies the color of the elevated lines.
 double getElevatedLinesLength()
          Indicates the length of the elevated lines.
 int getElevatedLinesLengthUnits()
          Indicates the units for the length of the elevated line.
 IColor getElevatedLinesPointColor()
          Specifies the color of the point located at the base of the elevated lines.
 double getElevatedLinesPointWidth()
          Indicates the width of the point located at the base of the elevated lines.
 int getElevatedLinesStyle()
          Indicates the style of the elevated lines, and whether or not to elevate the symbols so they don't sink into the globe.
 double getElevatedLinesWidth()
          Indicates the width of the elevated lines in pixels.
 String getEventIDFieldName()
          Indicates the field containing the EventID information for the data.
 IUID getEXTCLSID()
          The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.
 Object getExtension()
          The extension for this object class.
 Object getExtension(int index)
          The extension at the specified index.
 int getExtensionCount()
          Number of extensions.
 IPropertySet getExtensionProperties()
          The extension properties for this object class.
 IEnvelope getExtent()
          The extent of the GeoDataset.
 int getFeatureCacheWindow()
          Determines the number of features to cache if the CacheFeatures property is true.
 IFeatureClass getFeatureClass()
          The layer's feature class.
 IField getField(int index)
          The field at the specified index.
 int getFieldCount()
          The number of fields.
 IFieldInfo getFieldInfo(int index)
          Extended field information for the field at the specified index.
 IFields getFields()
          The fields collection for this object class.
 String getFindDisplayField()
          The display field.
 Object getFindFields()
          The attribute fields.
 IName getFullName()
          The associated name object.
 IIndexes getIndexes()
          The indexes collection for this object class.
 String getLabelFieldName()
          Name of the field whose contents will be used as the tracking label for the layer.
 int getLanguageLocaleID()
          Language ID used to parse dates from string values.
 int getLargeImage()
          Large image that represents the layer.
 int getLargeSelectedImage()
          Large image that represents the layer when it is selected.
 double getLastMaximumScale()
          Last maximum scale setting used by layer.
 double getLastMinimumScale()
          Last minimum scale setting used by layer.
 double getLayerWeight()
          Default layer position.
 IColor getLeaderLinesColor()
          Specifies the color of the leader line.
 double getLeaderLinesWidth()
          Indicates the width of the leader lines in pixels.
 ILegendGroup getLegendGroup(int index)
          Legend group at the specified index.
 int getLegendGroupCount()
          Number of legend groups contained by the object.
 ILegendItem getLegendItem()
          Optional.
 int getMapLevel()
          Current map level for drawing multi-level symbols.
 double getMaximumScale()
          Maximum scale (representative fraction) at which the layer will display.
 double getMinimumCellSize()
          For rasterized types, defines highest resolution.
 double getMinimumScale()
          Minimum scale (representative fraction) at which the layer will display.
 String getName()
          Layer name.
 double getOffsetAngle()
          Indicates angle of offset for labels as they draw next to events on the map display.
 String getOIDFieldName()
          The name of the field corresponding to the OID.
 short getPixelOffset()
          Indicates amount of offset between feature and label as they draw to the map display.
 String getPMDesignator()
          String for the PM designator.
 IPropertySet getPropertySet()
          The set of properties for the dataset.
 IRelationshipClass getRelationshipClass()
          The current relationship class used to display related fields.
 String getRelativeBase()
          Base path used when storing relative path names.
 int getRelativeTimeColor()
          Indicates a relative color differential based on temporal class characteristics.
 ITemporalOperator getRelativeTimeOperator()
          The relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer.
 IFeatureRenderer getRenderer()
          Controls the temporal renderer for the layer.
 IRow getRow(int oID)
          The row from the database with the specified object ID.
 ICursor getRows(Object oids, boolean recycling)
          The cursor of rows based on a set of object ids.
 IColor getSelectionColor()
          Selection color.
 ISelectionSet getSelectionSet()
          The selected set of features.
 ISymbol getSelectionSymbol()
          Selection symbol.
 int getShapeType()
          The layer's shape type.
 int getSmallImage()
          Small image that represents the layer.
 int getSmallSelectedImage()
          Small image that represents the layer when it is selected.
 ISpatialReference getSpatialReference()
          The spatial reference of the GeoDataset.
 IEnumDataset getSubsets()
          Datasets contained within this dataset.
 int getSupportedDrawPhases()
          Supported draw phases.
 double getSymbologyScalingFactor()
          The symbol scale factor for the custom rasterized type.
 String getTemporalFieldName()
          Identifies the temporal field, which must be a field type with data that can be converted to a date value.
 ITemporalLegendGroup getTemporalLegendGroup()
          Group of temporal legend classes that define the temporal intervals and symbology used by the temporal renderer.
 ITemporalReference getTemporalReference()
          Defines the reference in time used to draw, identify, or perform other layer-based activities.
 ITextSymbol getTextSymbol()
          Indicates settings for text symbol appearance as it appears as a label on the map display.
 void getTile(int tilesize, int face, int level, int row, int col, byte[][] pData)
          Gets a rasterized data tile for the given globe tesselation coordinates.
 String getTimeStyleFormat()
          Time formatting style used to parse the time portion of a time string in the temporal column.
 String getTimeZoneXML()
          The XML representation of a TimeZone.
 String getTipText(double x, double y, double tolerance)
          Map tip text at the specified location.
 int getType()
          The type of the Dataset.
 IWorkspace getWorkspace()
          The workspace containing this dataset.
 Object getZoneList()
          List of time zones.
 int hashCode()
          the hashcode for this object
 void hit(int hitObjectID, IHit3D pHit3D)
          The layer is hit by a picking operation.
 IArray identify(IGeometry pGeom)
          Identifies objects at the specified location.
 IArray identify(IGeometry pGeom, ITrackCancel pTrackCancel)
          Identifies objects at the specified location.
 String ILayerGeneralProperties_getLayerDescription()
          Description for the layer.
 ICursor insert(boolean useBuffering)
          Returns a cursor that can be used to insert new Rows.
 boolean inWorkspace(IWorkspace workspace)
          Returns TRUE if the layer is in the specified workspace.
 boolean isAdjustForDaylightSavings()
          Indicates whether or not to Adjust For Daylight Savings.
 boolean isCached()
          Indicates if the layer needs its own display cache.
 boolean isCacheFeatures()
          Controls whether Features are cached in the renderer's feature memory or are read from the feature class.
 boolean isDataSourceSupported(IName name)
          Indicates if the specified data object name is supported by the layer.
 boolean isDisplayFutureEvents()
          Indicates whether or not to display future events for a real-time data layer.
 boolean isDisplayOnlyLastKnownEvent()
          Indicates whether to display only the last known temporal event or all events in a layer.
 boolean isDrawingPropsDirty()
          Indicates if the layer drawing properties are dirty.
 boolean isDrawLeaderLines()
          Indicates whether to draw leader lines from the symbol to the surface.
 boolean isDynamicLayerDirty(int dynamicDrawPhase)
          Indicates if the dynamic layer has changed since last drawn for the specified draw phase.
 boolean isElevatedLinesPointUseSymbolColor()
          Indicates whether the color of the point located at the base of the elevated lines will be colored according to the elevated lines point color property or according to the symbolized feature it points to.
 boolean isElevatedLinesUseSymbolColor()
          Indicates whether the elevated line will be colored according to the elevated lines color property or according to the symbolized feature it points to.
 boolean isHandlesLocalOrigin()
          The option to use a local coordinate system origin for high precision drawing.
 boolean isHasOID()
          Indicates if the class has an object identity (OID) field.
 boolean isLabelFeatures()
          Indicates whether or not feature labels will appear as events draw to the map display.
 boolean isLeaderLinesUseSymbolColor()
          Indicates whether the leader line will be colored according to the leader lines color property or according to the symbolized feature it points to.
 boolean isScaleRangeReadOnly()
          Indicates if the minimum and maximum scale range values are read-only.
 boolean isScaleSymbols()
          Indicates if symbols are scaled for the layer.
 boolean isSelectable()
          Indicates if layer is selectable.
 boolean isSetSelectionSymbol()
          Indicates if the selected set of features is drawn using the SelectionSymbol.
 boolean isShowTips()
          Indicates if the layer shows map tips.
 boolean isSmoothElevatedLinesPoint()
          Indicates whether to smooth the point located at the base of the elevated lines.
 boolean isSymbolsAreGraduated()
          Indicates if symbols are graduated.
 boolean isUseCache()
          The option to use Globe's disk caching.
 boolean isUsesFilter()
          Indicates if the current object draws using a filter.
 boolean isValid()
          Indicates if the layer is currently valid.
 boolean isVisible()
          Indicates if the layer is currently visible.
 ICursor ITable_search(IQueryFilter queryFilter, boolean recycling)
          An object cursor that can be used to fetch row objects selected by the specified query.
 ICursor lastKnownFeatures(Object varStartingTime, Object varEndingTime)
          Searches for last known features in the dataset.
 IFeatureIDSet lastKnownOIDs(Object varStartingTime, Object varEndingTime)
          Searches for the last known OIDs in the dataset.
 void processActions(boolean bvarResetActions)
          Apply the actions, contained in the action collection, to this temporal layer.
 void queryTemporalExtent(Object[] pvarStartTime, Object[] pvarEndTime)
          Obtain the start and end temporal values of the temporal layer's features.
 void removeExtension(int index)
          Removes the specified extension.
 void removeILayerEventsListener(ILayerEvents theListener)
          removeILayerEventsListener.
 void rename(String name)
          Renames this Dataset.
 int rowCount(IQueryFilter queryFilter)
          The number of Rows selected by the specified query.
 IFeatureCursor search(IQueryFilter queryFilter, boolean recycling)
          Creates a cursor based upon the search criteria.
 ICursor searchDisplayTable(IQueryFilter pQueryFilter, boolean recycling)
          Creates a cursor from the display table based upon the search criteria.
 ISelectionSet select(IQueryFilter queryFilter, int selType, int selOption, IWorkspace selectionContainer)
          A selection that contains the object ids selected by the specified query.
 ISelectionSet selectDisplayTable(IQueryFilter pQueryFilter, int selType, int selOption, IWorkspace pSelWorkspace)
          Creates a selection set from the display table based upon the search criteria.
 void selectFeatures(IQueryFilter filter, int method, boolean justOne)
          Selects features based upon the specifed criteria and combination method.
 void selectionChanged()
          Fires the features layer update event.
 void selectRows(IQueryFilter filter, int method, boolean justOne)
          Selects rows based upon the specified criteria and combination method.
 void setActionCollectionByRef(IActionCollection pVal)
          The collection of action objects for this temporal layer.
 void setAdjustForDaylightSavings(boolean pVal)
          Indicates whether or not to Adjust For Daylight Savings.
 void setAMDesignator(String pbstrAMDesignator)
          String for the AM designator.
 void setAreaOfInterest(IEnvelope aoi)
          The default area of interest for the layer.
 void setBrowseName(String name)
          The browse name of the dataset.
 void setBufferDistance(double distance)
          Buffer distance used for the selection.
 void setCached(boolean cached)
          Indicates if the layer needs its own display cache.
 void setCacheFeatures(boolean pbAreFeaturesCached)
          Controls whether Features are cached in the renderer's feature memory or are read from the feature class.
 void setCombinationMethod(int method)
          Combination method for the selection.
 void setCurrentZone(String pbstrCurrentZone)
          The current Time Zone.
 void setDataSourceName(IName name)
          Name of the data object for the layer.
 void setDataSourceType(String text)
          Data source type.
 void setDateStyleFormat(String pbstrDateStyleFormat)
          Date style used when parsing the date portion of a time string in the temporal column.
 void setDefinitionExpression(String expression)
          Definition query expression for the existing layer.
 void setDisplayField(String fieldName)
          Primary display field.
 void setDisplayFutureEvents(boolean pbvarFutureEvents)
          Indicates whether or not to display future events for a real-time data layer.
 void setDisplayOnlyLastKnownEvent(boolean pbvarLastKnownEvent)
          Indicates whether to display only the last known temporal event or all events in a layer.
 void setDrawingPropsDirty(boolean dirty)
          Indicates if the layer drawing properties are dirty.
 void setDrawLeaderLines(boolean draw)
          Indicates whether to draw leader lines from the symbol to the surface.
 void setDynamicLayerDirty(int dynamicDrawPhase, boolean dirty)
          Indicates if the dynamic layer has changed since last drawn for the specified draw phase.
 void setElevatedLinesColor(IColor color)
          Specifies the color of the elevated lines.
 void setElevatedLinesLength(double length)
          Indicates the length of the elevated lines.
 void setElevatedLinesLengthUnits(int lengthUnits)
          Indicates the units for the length of the elevated line.
 void setElevatedLinesPointColor(IColor color)
          Specifies the color of the point located at the base of the elevated lines.
 void setElevatedLinesPointUseSymbolColor(boolean useSymbolColor)
          Indicates whether the color of the point located at the base of the elevated lines will be colored according to the elevated lines point color property or according to the symbolized feature it points to.
 void setElevatedLinesPointWidth(double width)
          Indicates the width of the point located at the base of the elevated lines.
 void setElevatedLinesStyle(int style)
          Indicates the style of the elevated lines, and whether or not to elevate the symbols so they don't sink into the globe.
 void setElevatedLinesUseSymbolColor(boolean useSymbolColor)
          Indicates whether the elevated line will be colored according to the elevated lines color property or according to the symbolized feature it points to.
 void setElevatedLinesWidth(double width)
          Indicates the width of the elevated lines in pixels.
 void setFeatureCacheWindow(int pnPercent)
          Determines the number of features to cache if the CacheFeatures property is true.
 void setFeatureClassByRef(IFeatureClass fclass)
          The layer's feature class.
 void setLabelFeatures(boolean pbvarLabelFeatures)
          Indicates whether or not feature labels will appear as events draw to the map display.
 void setLabelFieldName(String pbstrFieldName)
          Name of the field whose contents will be used as the tracking label for the layer.
 void setLanguageLocaleID(int plLanguageLocaleID)
          Language ID used to parse dates from string values.
 void setLayerDescription(String text)
          Description for the layer.
 void setLayerWeight(double layerWeight)
          Default layer position.
 void setLeaderLinesColor(IColor color)
          Specifies the color of the leader line.
 void setLeaderLinesUseSymbolColor(boolean useSymbolColor)
          Indicates whether the leader line will be colored according to the leader lines color property or according to the symbolized feature it points to.
 void setLeaderLinesWidth(double width)
          Indicates the width of the leader lines in pixels.
 void setLocalOrigin(_WKSPointZ rhs1)
          The local coordinate system origin for high precision drawing.
 void setMapLevel(int mapLevel)
          Current map level for drawing multi-level symbols.
 void setMaximumScale(double maxScale)
          Maximum scale (representative fraction) at which the layer will display.
 void setMinimumScale(double minScale)
          Minimum scale (representative fraction) at which the layer will display.
 void setName(String name)
          Layer name.
 void setOffsetAngle(double pdOffsetAngle)
          Indicates angle of offset for labels as they draw next to events on the map display.
 void setPixelOffset(short pnPixelOffset)
          Indicates amount of offset between feature and label as they draw to the map display.
 void setPMDesignator(String pbstrPMDesignator)
          String for the PM designator.
 void setRelationshipClassByRef(IRelationshipClass relClass)
          The current relationship class used to display related fields.
 void setRelativeBase(String basePath)
          Base path used when storing relative path names.
 void setRelativeTimeColor(int pVal)
          Indicates a relative color differential based on temporal class characteristics.
 void setRelativeTimeOperator(ITemporalOperator pVal)
          The relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer.
 void setRendererByRef(IFeatureRenderer renderer)
          Controls the temporal renderer for the layer.
 void setScale(double rhs1)
          The current scale of the display.
 void setScaleSymbols(boolean scale)
          Indicates if symbols are scaled for the layer.
 void setSelectable(boolean value)
          Indicates if layer is selectable.
 void setSelectionColorByRef(IColor color)
          Selection color.
 void setSelectionSetByRef(ISelectionSet selectionSet)
          The selected set of features.
 void setSelectionSymbolByRef(ISymbol symbol)
          Selection symbol.
 void setSetSelectionSymbol(boolean setSymbol)
          Indicates if the selected set of features is drawn using the SelectionSymbol.
 void setShowTips(boolean show)
          Indicates if the layer shows map tips.
 void setSmoothElevatedLinesPoint(boolean smooth)
          Indicates whether to smooth the point located at the base of the elevated lines.
 void setSpatialReferenceByRef(ISpatialReference rhs1)
          Spatial reference for the layer.
 void setSymbolsAreGraduated(boolean symbolsAreGraduated)
          Indicates if symbols are graduated.
 void setTemporalLegendGroupByRef(ITemporalLegendGroup ppiTemporalLegendGroup)
          Group of temporal legend classes that define the temporal intervals and symbology used by the temporal renderer.
 void setTemporalReferenceByRef(ITemporalReference ppiTemporalReference)
          Defines the reference in time used to draw, identify, or perform other layer-based activities.
 void setTextSymbolByRef(ITextSymbol ppiTextSymbol)
          Indicates settings for text symbol appearance as it appears as a label on the map display.
 void setTimeStyleFormat(String pbstrTimeStyleFormat)
          Time formatting style used to parse the time portion of a time string in the temporal column.
 void setTimeZoneXML(String pbstrXML)
          The XML representation of a TimeZone.
 void setVisible(boolean visible)
          Indicates if the layer is currently visible.
 boolean showPropertySheet()
          Show the property sheet.
 void suspendIndexing(boolean bvarSuspend)
          This method suspends or resumes indexing on a temporal layer.
 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
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

TemporalFeatureLayer

public TemporalFeatureLayer()
                     throws IOException,
                            UnknownHostException
Constructs a TemporalFeatureLayer using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

TemporalFeatureLayer

public TemporalFeatureLayer(Object obj)
                     throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TemporalFeatureLayer theTemporalFeatureLayer = (TemporalFeatureLayer) obj;

Construct a TemporalFeatureLayer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TemporalFeatureLayer.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

addILayerEventsListener

public void addILayerEventsListener(ILayerEvents theListener)
                             throws IOException
addILayerEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.carto.ILayerEvents interface.
Throws:
IOException - If there are communications problems.

removeILayerEventsListener

public void removeILayerEventsListener(ILayerEvents theListener)
                                throws IOException
removeILayerEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.carto.ILayerEvents interface.
Throws:
IOException - If there are communications problems.

getName

public String getName()
               throws IOException,
                      AutomationException
Layer name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getName in interface ILayer
Specified by:
getName in interface ILayer2
Specified by:
getName in interface IDataset
Specified by:
getName in interface ITemporalLayer
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException
Layer name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setName in interface ILayer
Specified by:
setName in interface ILayer2
Specified by:
setName in interface ITemporalLayer
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws IOException,
                       AutomationException
Indicates if the layer is currently valid.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isValid in interface ILayer
Specified by:
isValid in interface ILayer2
Specified by:
isValid in interface ITemporalLayer
Returns:
The valid
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws IOException,
                                   AutomationException
The default area of interest for the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getAreaOfInterest in interface ILayer
Specified by:
getAreaOfInterest in interface ILayer2
Specified by:
getAreaOfInterest in interface ITemporalLayer
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumScale

public double getMinimumScale()
                       throws IOException,
                              AutomationException
Minimum scale (representative fraction) at which the layer will display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getMinimumScale in interface ILayer
Specified by:
getMinimumScale in interface ILayer2
Specified by:
getMinimumScale in interface ITemporalLayer
Returns:
The minScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimumScale

public void setMinimumScale(double minScale)
                     throws IOException,
                            AutomationException
Minimum scale (representative fraction) at which the layer will display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setMinimumScale in interface ILayer
Specified by:
setMinimumScale in interface ILayer2
Specified by:
setMinimumScale in interface ITemporalLayer
Parameters:
minScale - The minScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumScale

public double getMaximumScale()
                       throws IOException,
                              AutomationException
Maximum scale (representative fraction) at which the layer will display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getMaximumScale in interface ILayer
Specified by:
getMaximumScale in interface ILayer2
Specified by:
getMaximumScale in interface ITemporalLayer
Returns:
The maxScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumScale

public void setMaximumScale(double maxScale)
                     throws IOException,
                            AutomationException
Maximum scale (representative fraction) at which the layer will display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setMaximumScale in interface ILayer
Specified by:
setMaximumScale in interface ILayer2
Specified by:
setMaximumScale in interface ITemporalLayer
Parameters:
maxScale - The maxScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException
Indicates if the layer is currently visible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isVisible in interface ILayer
Specified by:
isVisible in interface ILayer2
Specified by:
isVisible in interface ITemporalLayer
Returns:
The visible
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException
Indicates if the layer is currently visible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setVisible in interface ILayer
Specified by:
setVisible in interface ILayer2
Specified by:
setVisible in interface ITemporalLayer
Parameters:
visible - The visible (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowTips

public boolean isShowTips()
                   throws IOException,
                          AutomationException
Indicates if the layer shows map tips.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isShowTips in interface ILayer
Specified by:
isShowTips in interface ILayer2
Specified by:
isShowTips in interface ITemporalLayer
Returns:
The show
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowTips

public void setShowTips(boolean show)
                 throws IOException,
                        AutomationException
Indicates if the layer shows map tips.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setShowTips in interface ILayer
Specified by:
setShowTips in interface ILayer2
Specified by:
setShowTips in interface ITemporalLayer
Parameters:
show - The show (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTipText

public String getTipText(double x,
                         double y,
                         double tolerance)
                  throws IOException,
                         AutomationException
Map tip text at the specified location.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getTipText in interface ILayer
Specified by:
getTipText in interface ILayer2
Specified by:
getTipText in interface ITemporalLayer
Parameters:
x - The x (in)
y - The y (in)
tolerance - The tolerance (in)
Returns:
The text
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCached

public boolean isCached()
                 throws IOException,
                        AutomationException
Indicates if the layer needs its own display cache.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isCached in interface ILayer
Specified by:
isCached in interface ILayer2
Specified by:
isCached in interface ITemporalLayer
Returns:
The cached
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCached

public void setCached(boolean cached)
               throws IOException,
                      AutomationException
Indicates if the layer needs its own display cache.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setCached in interface ILayer
Specified by:
setCached in interface ILayer2
Specified by:
setCached in interface ITemporalLayer
Parameters:
cached - The cached (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSupportedDrawPhases

public int getSupportedDrawPhases()
                           throws IOException,
                                  AutomationException
Supported draw phases.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getSupportedDrawPhases in interface ILayer
Specified by:
getSupportedDrawPhases in interface ILayer2
Specified by:
getSupportedDrawPhases in interface ITemporalLayer
Returns:
The drawPhases
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws IOException,
                                     AutomationException
Spatial reference for the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setSpatialReferenceByRef in interface ILayer
Specified by:
setSpatialReferenceByRef in interface ILayer2
Specified by:
setSpatialReferenceByRef in interface ITemporalLayer
Parameters:
rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

public void draw(int drawPhase,
                 IDisplay display,
                 ITrackCancel trackCancel)
          throws IOException,
                 AutomationException
Draws the layer to the specified display for the given draw phase.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
draw in interface ILayer
Specified by:
draw in interface ILayer2
Specified by:
draw in interface ITemporalLayer
Parameters:
drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTemporalReference

public ITemporalReference getTemporalReference()
                                        throws IOException,
                                               AutomationException
Defines the reference in time used to draw, identify, or perform other layer-based activities.

Description

The Temporal Reference Property is a Temporal Reference Object that defines the reference in time that is used to draw, identify, or perform other layer activities on this layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getTemporalReference in interface ITemporalLayer
Returns:
A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTemporalReferenceByRef

public void setTemporalReferenceByRef(ITemporalReference ppiTemporalReference)
                               throws IOException,
                                      AutomationException
Defines the reference in time used to draw, identify, or perform other layer-based activities.

Description

The Temporal Reference Property is a Temporal Reference Object that defines the reference in time that is used to draw, identify, or perform other layer activities on this layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setTemporalReferenceByRef in interface ITemporalLayer
Parameters:
ppiTemporalReference - A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTemporalLegendGroup

public ITemporalLegendGroup getTemporalLegendGroup()
                                            throws IOException,
                                                   AutomationException
Group of temporal legend classes that define the temporal intervals and symbology used by the temporal renderer.

Description

This property is a group of temporal legend classes that define the temporal intervals and symbology that the temporal renderer uses. This legend group collectively defines the temporal period that is used to draw features.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getTemporalLegendGroup in interface ITemporalLayer
Returns:
A reference to a com.esri.arcgis.trackinganalyst.ITemporalLegendGroup
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTemporalLegendGroupByRef

public void setTemporalLegendGroupByRef(ITemporalLegendGroup ppiTemporalLegendGroup)
                                 throws IOException,
                                        AutomationException
Group of temporal legend classes that define the temporal intervals and symbology used by the temporal renderer.

Description

This property is a group of temporal legend classes that define the temporal intervals and symbology that the temporal renderer uses. This legend group collectively defines the temporal period that is used to draw features.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setTemporalLegendGroupByRef in interface ITemporalLayer
Parameters:
ppiTemporalLegendGroup - A reference to a com.esri.arcgis.trackinganalyst.ITemporalLegendGroup (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCacheFeatures

public void setCacheFeatures(boolean pbAreFeaturesCached)
                      throws IOException,
                             AutomationException
Controls whether Features are cached in the renderer's feature memory or are read from the feature class.

Description

This property controls whether features are cached in the renderer's feature memory or are read from the feature class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setCacheFeatures in interface ITemporalLayer
Parameters:
pbAreFeaturesCached - The pbAreFeaturesCached (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCacheFeatures

public boolean isCacheFeatures()
                        throws IOException,
                               AutomationException
Controls whether Features are cached in the renderer's feature memory or are read from the feature class.

Description

This property controls whether features are cached in the renderer's feature memory or are read from the feature class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isCacheFeatures in interface ITemporalLayer
Returns:
The pbAreFeaturesCached
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureCacheWindow

public int getFeatureCacheWindow()
                          throws IOException,
                                 AutomationException
Determines the number of features to cache if the CacheFeatures property is true.

Description

Reserved for future use.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getFeatureCacheWindow in interface ITemporalLayer
Returns:
The pnPercent
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureCacheWindow

public void setFeatureCacheWindow(int pnPercent)
                           throws IOException,
                                  AutomationException
Determines the number of features to cache if the CacheFeatures property is true.

Description

Reserved for future use

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setFeatureCacheWindow in interface ITemporalLayer
Parameters:
pnPercent - The pnPercent (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRendererByRef

public void setRendererByRef(IFeatureRenderer renderer)
                      throws IOException,
                             AutomationException
Controls the temporal renderer for the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setRendererByRef in interface ITemporalLayer
Parameters:
renderer - A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRenderer

public IFeatureRenderer getRenderer()
                             throws IOException,
                                    AutomationException
Controls the temporal renderer for the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getRenderer in interface ITemporalLayer
Returns:
A reference to a com.esri.arcgis.carto.IFeatureRenderer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTemporalFieldName

public String getTemporalFieldName()
                            throws IOException,
                                   AutomationException
Identifies the temporal field, which must be a field type with data that can be converted to a date value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getTemporalFieldName in interface ITemporalLayer
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDisplayOnlyLastKnownEvent

public boolean isDisplayOnlyLastKnownEvent()
                                    throws IOException,
                                           AutomationException
Indicates whether to display only the last known temporal event or all events in a layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isDisplayOnlyLastKnownEvent in interface ITemporalLayer
Returns:
The pbvarLastKnownEvent
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayOnlyLastKnownEvent

public void setDisplayOnlyLastKnownEvent(boolean pbvarLastKnownEvent)
                                  throws IOException,
                                         AutomationException
Indicates whether to display only the last known temporal event or all events in a layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setDisplayOnlyLastKnownEvent in interface ITemporalLayer
Parameters:
pbvarLastKnownEvent - The pbvarLastKnownEvent (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDisplayFutureEvents

public boolean isDisplayFutureEvents()
                              throws IOException,
                                     AutomationException
Indicates whether or not to display future events for a real-time data layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isDisplayFutureEvents in interface ITemporalLayer
Returns:
The pbvarFutureEvents
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayFutureEvents

public void setDisplayFutureEvents(boolean pbvarFutureEvents)
                            throws IOException,
                                   AutomationException
Indicates whether or not to display future events for a real-time data layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setDisplayFutureEvents in interface ITemporalLayer
Parameters:
pbvarFutureEvents - The pbvarFutureEvents (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActionCollection

public IActionCollection getActionCollection()
                                      throws IOException,
                                             AutomationException
The collection of action objects for this temporal layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getActionCollection in interface ITemporalLayer
Returns:
A reference to a com.esri.arcgis.trackinganalyst.IActionCollection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setActionCollectionByRef

public void setActionCollectionByRef(IActionCollection pVal)
                              throws IOException,
                                     AutomationException
The collection of action objects for this temporal layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setActionCollectionByRef in interface ITemporalLayer
Parameters:
pVal - A reference to a com.esri.arcgis.trackinganalyst.IActionCollection (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

processActions

public void processActions(boolean bvarResetActions)
                    throws IOException,
                           AutomationException
Apply the actions, contained in the action collection, to this temporal layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
processActions in interface ITemporalLayer
Parameters:
bvarResetActions - The bvarResetActions (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRelativeTimeColor

public int getRelativeTimeColor()
                         throws IOException,
                                AutomationException
Indicates a relative color differential based on temporal class characteristics.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getRelativeTimeColor in interface ITemporalLayer
Returns:
The pVal (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelativeTimeColor

public void setRelativeTimeColor(int pVal)
                          throws IOException,
                                 AutomationException
Indicates a relative color differential based on temporal class characteristics.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setRelativeTimeColor in interface ITemporalLayer
Parameters:
pVal - The pVal (A COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRelativeTimeOperator

public ITemporalOperator getRelativeTimeOperator()
                                          throws IOException,
                                                 AutomationException
The relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getRelativeTimeOperator in interface ITemporalLayer
Returns:
A reference to a com.esri.arcgis.trackinganalyst.ITemporalOperator
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelativeTimeOperator

public void setRelativeTimeOperator(ITemporalOperator pVal)
                             throws IOException,
                                    AutomationException
The relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setRelativeTimeOperator in interface ITemporalLayer
Parameters:
pVal - A reference to a com.esri.arcgis.trackinganalyst.ITemporalOperator (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryTemporalExtent

public void queryTemporalExtent(Object[] pvarStartTime,
                                Object[] pvarEndTime)
                         throws IOException,
                                AutomationException
Obtain the start and end temporal values of the temporal layer's features.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
queryTemporalExtent in interface ITemporalLayer
Specified by:
queryTemporalExtent in interface ITemporalSearch
Parameters:
pvarStartTime - A Variant (in/out: use single element array)
pvarEndTime - A Variant (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEventIDFieldName

public String getEventIDFieldName()
                           throws IOException,
                                  AutomationException
Indicates the field containing the EventID information for the data.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getEventIDFieldName in interface ITemporalLayer
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

suspendIndexing

public void suspendIndexing(boolean bvarSuspend)
                     throws IOException,
                            AutomationException
This method suspends or resumes indexing on a temporal layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
suspendIndexing in interface ITemporalLayer
Parameters:
bvarSuspend - The bvarSuspend (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

lastKnownOIDs

public IFeatureIDSet lastKnownOIDs(Object varStartingTime,
                                   Object varEndingTime)
                            throws IOException,
                                   AutomationException
Searches for the last known OIDs in the dataset.

Description

Returns a FeatureIDSet containing the most recent OID for each track. If a start and/or end time are specified then features occuring outside of the time span are not factored into the search. Passing NULL for the start time and end time will cause all data in the temporal extent to be evaluated.

Remarks

The start and end time automation compliant date types. In C++ you can use any type that converts to a VT_DATE type, in VB a Date type, and in C# a DateTime type.

Getting the LastKnownOIDs is faster than getting the LastKnownFeatures so it is advisable to use this method where possible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
lastKnownOIDs in interface ITemporalSearch
Parameters:
varStartingTime - A Variant (in)
varEndingTime - A Variant (in)
Returns:
A reference to a com.esri.arcgis.carto.IFeatureIDSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

lastKnownFeatures

public ICursor lastKnownFeatures(Object varStartingTime,
                                 Object varEndingTime)
                          throws IOException,
                                 AutomationException
Searches for last known features in the dataset.

Description

Returns an ICursor containing the most recent feature for each track. If a start and/or end time are specified then features occuring outside of the time span are not factored into the search. Passing NULL for the start time and end time will cause all data in the temporal extent to be evaluated.

Remarks

The start and end time automation compliant date types. In C++ you can use any type that converts to a VT_DATE type, in VB a Date type, and in C# a DateTime type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
lastKnownFeatures in interface ITemporalSearch
Parameters:
varStartingTime - A Variant (in)
varEndingTime - A Variant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLanguageLocaleID

public int getLanguageLocaleID()
                        throws IOException,
                               AutomationException
Language ID used to parse dates from string values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getLanguageLocaleID in interface ITimeRegionalSettings
Returns:
The plLanguageLocaleID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLanguageLocaleID

public void setLanguageLocaleID(int plLanguageLocaleID)
                         throws IOException,
                                AutomationException
Language ID used to parse dates from string values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setLanguageLocaleID in interface ITimeRegionalSettings
Parameters:
plLanguageLocaleID - The plLanguageLocaleID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeStyleFormat

public String getTimeStyleFormat()
                          throws IOException,
                                 AutomationException
Time formatting style used to parse the time portion of a time string in the temporal column.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getTimeStyleFormat in interface ITimeRegionalSettings
Returns:
The pbstrTimeStyleFormat
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeStyleFormat

public void setTimeStyleFormat(String pbstrTimeStyleFormat)
                        throws IOException,
                               AutomationException
Time formatting style used to parse the time portion of a time string in the temporal column.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setTimeStyleFormat in interface ITimeRegionalSettings
Parameters:
pbstrTimeStyleFormat - The pbstrTimeStyleFormat (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDateStyleFormat

public String getDateStyleFormat()
                          throws IOException,
                                 AutomationException
Date style used when parsing the date portion of a time string in the temporal column.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getDateStyleFormat in interface ITimeRegionalSettings
Returns:
The pbstrDateStyleFormat
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDateStyleFormat

public void setDateStyleFormat(String pbstrDateStyleFormat)
                        throws IOException,
                               AutomationException
Date style used when parsing the date portion of a time string in the temporal column.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setDateStyleFormat in interface ITimeRegionalSettings
Parameters:
pbstrDateStyleFormat - The pbstrDateStyleFormat (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAMDesignator

public String getAMDesignator()
                       throws IOException,
                              AutomationException
String for the AM designator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getAMDesignator in interface ITimeRegionalSettings
Returns:
The pbstrAMDesignator
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAMDesignator

public void setAMDesignator(String pbstrAMDesignator)
                     throws IOException,
                            AutomationException
String for the AM designator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setAMDesignator in interface ITimeRegionalSettings
Parameters:
pbstrAMDesignator - The pbstrAMDesignator (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPMDesignator

public String getPMDesignator()
                       throws IOException,
                              AutomationException
String for the PM designator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getPMDesignator in interface ITimeRegionalSettings
Returns:
The pbstrPMDesignator
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPMDesignator

public void setPMDesignator(String pbstrPMDesignator)
                     throws IOException,
                            AutomationException
String for the PM designator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setPMDesignator in interface ITimeRegionalSettings
Parameters:
pbstrPMDesignator - The pbstrPMDesignator (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isScaleRangeReadOnly

public boolean isScaleRangeReadOnly()
                             throws IOException,
                                    AutomationException
Indicates if the minimum and maximum scale range values are read-only.

Remarks

Some layer types do not support a writeable MinimumScale or MaximumScale. Use this property to determine whether or not a layer supports this.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isScaleRangeReadOnly in interface ILayer2
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAreaOfInterest

public void setAreaOfInterest(IEnvelope aoi)
                       throws IOException,
                              AutomationException
The default area of interest for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAreaOfInterest in interface ILayer2
Parameters:
aoi - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLegendGroupCount

public int getLegendGroupCount()
                        throws IOException,
                               AutomationException
Number of legend groups contained by the object.

Remarks

The number of legend groups is determined by the implementation of the renderer, consequently this property is read only. For example, SimpleRenderer has one group, while a BiUniqueValueRenderer has any number of groups.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLegendGroupCount in interface ILegendInfo
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws IOException,
                                   AutomationException
Legend group at the specified index.

Product Availability

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

Specified by:
getLegendGroup in interface ILegendInfo
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.carto.ILegendGroup
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws IOException,
                                 AutomationException
Optional. Defines legend formatting for layer rendered with this object.

Remarks

Layer or renderer legend information is further formatted for display in ArcMap legends. A renderer can override this formatting by returning a LegendItem for this property. ESRI renderers typically do not return anything for this property. With this configuration, legend formatting becomes a user or developer choice on the legend object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLegendItem in interface ILegendInfo
Returns:
A reference to a com.esri.arcgis.carto.ILegendItem
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws IOException,
                                     AutomationException
Indicates if symbols are graduated.

Description

Indicates whether the symbols used for a layer or renderer's legend vary by size.

Remarks

For example the proportional symbol renderer returns True for this property.

You can use this property to distinguish between a layer symbolized with graduated color or graduated symbol type layer symbology. Both of these symbolizations use a ClassBreaksRenderer, but only a graduated symbol symbolization will return True for this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSymbolsAreGraduated in interface ILegendInfo
Returns:
The symbolsAreGraduated
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws IOException,
                                   AutomationException
Indicates if symbols are graduated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSymbolsAreGraduated in interface ILegendInfo
Parameters:
symbolsAreGraduated - The symbolsAreGraduated (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws IOException,
                         AutomationException
Small image that represents the layer.

Description

The icon used to represent the layer in ArcCatalog's 'List' and 'Details' views.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSmallImage in interface ILayerInfo
Returns:
The hBitmap (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallSelectedImage

public int getSmallSelectedImage()
                          throws IOException,
                                 AutomationException
Small image that represents the layer when it is selected.

Description

The icon used to represent the layer when it is selected in ArcCatalog's 'List' and 'Details' views.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSmallSelectedImage in interface ILayerInfo
Returns:
The hBitmap (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws IOException,
                         AutomationException
Large image that represents the layer.

Description

The icon used to represent the layer in ArcCatalog's 'Large Icon' view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLargeImage in interface ILayerInfo
Returns:
The hBitmap (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeSelectedImage

public int getLargeSelectedImage()
                          throws IOException,
                                 AutomationException
Large image that represents the layer when it is selected.

Description

The icon used to represent the layer when it is selected in ArcCatalog's 'Large Icon' view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLargeSelectedImage in interface ILayerInfo
Returns:
The hBitmap (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelFieldName

public void setLabelFieldName(String pbstrFieldName)
                       throws IOException,
                              AutomationException
Name of the field whose contents will be used as the tracking label for the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setLabelFieldName in interface ITrackingLayerLabels
Parameters:
pbstrFieldName - The pbstrFieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelFieldName

public String getLabelFieldName()
                         throws IOException,
                                AutomationException
Name of the field whose contents will be used as the tracking label for the layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getLabelFieldName in interface ITrackingLayerLabels
Returns:
The pbstrFieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelFeatures

public void setLabelFeatures(boolean pbvarLabelFeatures)
                      throws IOException,
                             AutomationException
Indicates whether or not feature labels will appear as events draw to the map display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setLabelFeatures in interface ITrackingLayerLabels
Parameters:
pbvarLabelFeatures - The pbvarLabelFeatures (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLabelFeatures

public boolean isLabelFeatures()
                        throws IOException,
                               AutomationException
Indicates whether or not feature labels will appear as events draw to the map display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isLabelFeatures in interface ITrackingLayerLabels
Returns:
The pbvarLabelFeatures
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPixelOffset

public short getPixelOffset()
                     throws IOException,
                            AutomationException
Indicates amount of offset between feature and label as they draw to the map display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getPixelOffset in interface ITrackingLayerLabels
Returns:
The pnPixelOffset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPixelOffset

public void setPixelOffset(short pnPixelOffset)
                    throws IOException,
                           AutomationException
Indicates amount of offset between feature and label as they draw to the map display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setPixelOffset in interface ITrackingLayerLabels
Parameters:
pnPixelOffset - The pnPixelOffset (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOffsetAngle

public double getOffsetAngle()
                      throws IOException,
                             AutomationException
Indicates angle of offset for labels as they draw next to events on the map display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getOffsetAngle in interface ITrackingLayerLabels
Returns:
The pdOffsetAngle
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOffsetAngle

public void setOffsetAngle(double pdOffsetAngle)
                    throws IOException,
                           AutomationException
Indicates angle of offset for labels as they draw next to events on the map display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setOffsetAngle in interface ITrackingLayerLabels
Parameters:
pdOffsetAngle - The pdOffsetAngle (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextSymbol

public ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException
Indicates settings for text symbol appearance as it appears as a label on the map display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getTextSymbol in interface ITrackingLayerLabels
Returns:
A reference to a com.esri.arcgis.display.ITextSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextSymbolByRef

public void setTextSymbolByRef(ITextSymbol ppiTextSymbol)
                        throws IOException,
                               AutomationException
Indicates settings for text symbol appearance as it appears as a label on the map display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setTextSymbolByRef in interface ITrackingLayerLabels
Parameters:
ppiTextSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom)
                throws IOException,
                       AutomationException
Identifies objects at the specified location.

Remarks

When the IIdentify interface is on a map layer, the Identify method returns an array of FeatureIdentifyObject objects.

On a FeatureIdentifyObject, you can do a QI to the IIdentifyObj interface to get more information about the identified feature. The IIdentifyObj interface returns the window handle, layer, and name of the feature; it has methods to flash the feature in the display and to display a context menu at the Identify location.

This method performs an identify operation with the provided geometry. When identifying layers, typically a small envelope is passed in rather than a point to account for differences in the precision of the display and the feature geometry.


Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
identify in interface IIdentify
Parameters:
pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws IOException,
                                     AutomationException
The selected set of features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSelectionSet in interface IFeatureSelection
Specified by:
getSelectionSet in interface ITableSelection
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet selectionSet)
                          throws IOException,
                                 AutomationException
The selected set of features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSelectionSetByRef in interface IFeatureSelection
Specified by:
setSelectionSetByRef in interface ITableSelection
Parameters:
selectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCombinationMethod

public int getCombinationMethod()
                         throws IOException,
                                AutomationException
Combination method for the selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCombinationMethod in interface IFeatureSelection
Returns:
A com.esri.arcgis.carto.esriSelectionResultEnum constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCombinationMethod

public void setCombinationMethod(int method)
                          throws IOException,
                                 AutomationException
Combination method for the selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCombinationMethod in interface IFeatureSelection
Parameters:
method - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBufferDistance

public double getBufferDistance()
                         throws IOException,
                                AutomationException
Buffer distance used for the selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBufferDistance in interface IFeatureSelection
Returns:
The distance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBufferDistance

public void setBufferDistance(double distance)
                       throws IOException,
                              AutomationException
Buffer distance used for the selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBufferDistance in interface IFeatureSelection
Parameters:
distance - The distance (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSetSelectionSymbol

public boolean isSetSelectionSymbol()
                             throws IOException,
                                    AutomationException
Indicates if the selected set of features is drawn using the SelectionSymbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSetSelectionSymbol in interface IFeatureSelection
Returns:
The setSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSetSelectionSymbol

public void setSetSelectionSymbol(boolean setSymbol)
                           throws IOException,
                                  AutomationException
Indicates if the selected set of features is drawn using the SelectionSymbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSetSelectionSymbol in interface IFeatureSelection
Parameters:
setSymbol - The setSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectionColor

public IColor getSelectionColor()
                         throws IOException,
                                AutomationException
Selection color. (used when SetSelectionSymbol = FALSE).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSelectionColor in interface IFeatureSelection
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectionColorByRef

public void setSelectionColorByRef(IColor color)
                            throws IOException,
                                   AutomationException
Selection color. (used when SetSelectionSymbol = FALSE).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSelectionColorByRef in interface IFeatureSelection
Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectionSymbol

public ISymbol getSelectionSymbol()
                           throws IOException,
                                  AutomationException
Selection symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSelectionSymbol in interface IFeatureSelection
Returns:
A reference to a com.esri.arcgis.display.ISymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectionSymbolByRef

public void setSelectionSymbolByRef(ISymbol symbol)
                             throws IOException,
                                    AutomationException
Selection symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSelectionSymbolByRef in interface IFeatureSelection
Parameters:
symbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

public void add(IFeature feature)
         throws IOException,
                AutomationException
Adds a feature to the selection set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
add in interface IFeatureSelection
Parameters:
feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

selectFeatures

public void selectFeatures(IQueryFilter filter,
                           int method,
                           boolean justOne)
                    throws IOException,
                           AutomationException
Selects features based upon the specifed criteria and combination method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
selectFeatures in interface IFeatureSelection
Parameters:
filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
method - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)
justOne - The justOne (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws IOException,
                  AutomationException
Clears the selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
clear in interface IFeatureSelection
Specified by:
clear in interface ITableSelection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

selectionChanged

public void selectionChanged()
                      throws IOException,
                             AutomationException
Fires the features layer update event. Required when SelectionSet changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
selectionChanged in interface IFeatureSelection
Specified by:
selectionChanged in interface ITableSelection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefinitionExpression

public String getDefinitionExpression()
                               throws IOException,
                                      AutomationException
Definition query expression for the existing layer.

Description

Use the DefinitionExpression property to read or set the definition query for an existing layer just like you would in the Definition Query tab of the layer's properties dialog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefinitionExpression in interface IFeatureLayerDefinition
Returns:
The expression
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefinitionExpression

public void setDefinitionExpression(String expression)
                             throws IOException,
                                    AutomationException
Definition query expression for the existing layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDefinitionExpression in interface IFeatureLayerDefinition
Parameters:
expression - The expression (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefinitionSelectionSet

public ISelectionSet getDefinitionSelectionSet()
                                        throws IOException,
                                               AutomationException
The selection set that defines the subset of features in a selection layer.

Remarks

You can use the DefintionSelectionSet property to get the selection set that was used to define the new layer created by the IFeatureLayerDefintion::CreateSelectionLayer method. Note, before calling CreateSelectionLayer, the selection set returned by DefintionSelectionSet will be Nothing. Therefore, you can only use this property after you have called the CreateSelectionLayer method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefinitionSelectionSet in interface IFeatureLayerDefinition
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createSelectionLayer

public IFeatureLayer createSelectionLayer(String layerName,
                                          boolean useCurrentSelection,
                                          String joinTableNames,
                                          String expression)
                                   throws IOException,
                                          AutomationException
Creates a new feature layer from the existing layer based on the current selection and the specified query expression.

Description

CreateSelectionLayer creates a new FeatureLayer from an existing FeatureLayer.
LayerName defines the new layer's name.
Set useCurrentSelection = TRUE here if you want to use the currently selected features on the existing layer.
joinTableNames may contain the name of related table(s) separated by commas. The existing join(s) will then be passed on to the new layer.
The DefinitionExpression parameter can be used to set a definition expression on the newly created layer but currently this will be defined at the feature class rather than at the layer level and will not show up in the UI. If you want to set a definition query on the newly created layer, it is best to use IFeatureLayerDefinition again to set the definition query after the layer has been created.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
createSelectionLayer in interface IFeatureLayerDefinition
Parameters:
layerName - The layerName (in)
useCurrentSelection - The useCurrentSelection (in)
joinTableNames - The joinTableNames (in)
expression - The expression (in)
Returns:
A reference to a com.esri.arcgis.carto.IFeatureLayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRelationshipClass

public IRelationshipClass getRelationshipClass()
                                        throws IOException,
                                               AutomationException
The current relationship class used to display related fields.

Remarks

RelClass must be a defined relationship class on the base feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRelationshipClass in interface IFeatureLayerDefinition
Returns:
A reference to a com.esri.arcgis.geodatabase.IRelationshipClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelationshipClassByRef

public void setRelationshipClassByRef(IRelationshipClass relClass)
                               throws IOException,
                                      AutomationException
The current relationship class used to display related fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRelationshipClassByRef in interface IFeatureLayerDefinition
Parameters:
relClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws 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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws 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.

The red box represents the IGeoDataset extent

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.

The red box represents the IGeoDataset extent after some of the features have been deleted

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.

The red box represents the IGeoDataset extent after it has been updated

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom,
                       ITrackCancel pTrackCancel)
                throws IOException,
                       AutomationException
Identifies objects at the specified location.

Remarks

When the IIdentify interface is on a map layer, the Identify method returns an array of FeatureIdentifyObject objects.

On a FeatureIdentifyObject, you can do a QI to the IIdentifyObj interface to get more information about the identified feature. The IIdentifyObj interface returns the window handle, layer, and name of the feature; it has methods to flash the feature in the display and to display a context menu at the Identify location.

This method performs an identify operation with the provided geometry. When identifying layers, typically a small envelope is passed in rather than a point to account for differences in the precision of the display and the feature geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
identify in interface IIdentify2
Parameters:
pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setScale

public void setScale(double rhs1)
              throws IOException,
                     AutomationException
The current scale of the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setScale in interface IIdentify2
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addRow

public void addRow(IRow row)
            throws IOException,
                   AutomationException
Adds a row to the selection set (honoring the current combination method).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
addRow in interface ITableSelection
Parameters:
row - A reference to a com.esri.arcgis.geodatabase.IRow (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

selectRows

public void selectRows(IQueryFilter filter,
                       int method,
                       boolean justOne)
                throws IOException,
                       AutomationException
Selects rows based upon the specified criteria and combination method.

Description

The justOne parameter tells the search to stop once it has found one feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
selectRows in interface ITableSelection
Parameters:
filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
method - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)
justOne - The justOne (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

find

public IArray find(String search,
                   boolean contains,
                   Object fields,
                   ITrackCancel trackCancel)
            throws IOException,
                   AutomationException
Finds the specified search string in the given attribute fields.

Remarks

This method returns an reference to an Array of FeatureFindData objects. To search, pass in a reference to an Fields object along with the search string and a boolean option to return features that have attributes that contain the string. If Contains = False, only objects with an attribute that consists of the entire search string will be returned.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
find in interface IFind
Parameters:
search - The search (in)
contains - The contains (in)
fields - A Variant (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFindFields

public Object getFindFields()
                     throws IOException,
                            AutomationException
The attribute fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFindFields in interface IFind
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFindDisplayField

public String getFindDisplayField()
                           throws IOException,
                                  AutomationException
The display field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFindDisplayField in interface IFind
Returns:
The field
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayTable

public ITable getDisplayTable()
                       throws IOException,
                              AutomationException
The display table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDisplayTable in interface IDisplayTable
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

searchDisplayTable

public ICursor searchDisplayTable(IQueryFilter pQueryFilter,
                                  boolean recycling)
                           throws IOException,
                                  AutomationException
Creates a cursor from the display table based upon the search criteria.

Description

QueryFilter specifies an IQueryFilterObject to be used for the search.

Recycling specifies whether the resulting cursor is recycling or non-recycling. Use True for recycling cursor and False for a non-recycling cursor.

Remarks

If there is a definition query set on the layer or table, the SearchDisplayTable method will work on the subset of rows that meet the definition criteria. Otherwise, it will search the whole table.

SearchDisplayTable will return an ICursor with all of the rows that satisfy some attribute and/or spatial query as specified by an IQueryFilter object. If Nothing is given as the IQueryFilter, then the cursor will have all of the rows from the table.

This SearchDisplayTable method will also work on joined fields if you qualify the field names. For example, if you want to search a field called "Pop1990" from a joined table called "Demog", you should used "Demog.Pop1990" for the field name in the query filter used in the search method.

The Recycling parameter controls row object allocation behavior. Recycling cursors rehydrate a single row object on each fetch and can be used to optimize read-only access, for example, when drawing. It is illegal to maintain a reference on a row object returned by a recycling cursor across multiple calls to NextRow on the cursor. Row objects returned by a recycling cursor should not be modified.

Non-recycling cursors return a separate row object on each fetch. The objects returned by a non-recycling cursor may be modified and stored with polymorphic behavior. The geodatabase guarantees 'unique instance semantics' on non-recycling feature objects fetched during an edit session.

Recycling cursors should be used only for drawing and read-only access to object state. Use non-recycling search cursors to fetch objects that are to be updated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
searchDisplayTable in interface IDisplayTable
Parameters:
pQueryFilter - 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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

selectDisplayTable

public ISelectionSet selectDisplayTable(IQueryFilter pQueryFilter,
                                        int selType,
                                        int selOption,
                                        IWorkspace pSelWorkspace)
                                 throws IOException,
                                        AutomationException
Creates a selection set from the display table based upon the search criteria.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
selectDisplayTable in interface IDisplayTable
Parameters:
pQueryFilter - 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)
pSelWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplaySelectionSet

public ISelectionSet getDisplaySelectionSet()
                                     throws IOException,
                                            AutomationException
The selected set of rows from the display table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDisplaySelectionSet in interface IDisplayTable
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureClass

public IFeatureClass getFeatureClass()
                              throws IOException,
                                     AutomationException
The layer's feature class.

Description

The FeatureClass data source for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFeatureClass in interface IFeatureLayer
Specified by:
getFeatureClass in interface IFeatureLayer2
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureClassByRef

public void setFeatureClassByRef(IFeatureClass fclass)
                          throws IOException,
                                 AutomationException
The layer's feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFeatureClassByRef in interface IFeatureLayer
Specified by:
setFeatureClassByRef in interface IFeatureLayer2
Parameters:
fclass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataSourceType

public String getDataSourceType()
                         throws IOException,
                                AutomationException
Data source type.

Description

Describes the type of data referenced by the feature layer. In ArcMap and ArcCatalog this description appears on the layer's properties dialog on the Source tab after "Data Type:"

Remarks

By default, the DataSourceType for a layer matches the value returned by IDataset::Category when you access the layer's feature class through IDataset. You can set a layer's DataSourceType to any string.

Here is a list of default values for DataSourceType for common feature layer types:

Layer Type Value
Personal Geodatabase "Personal Geodatabase Feature Class"
SDE "SDE Feature Class"
Shapefile "Shapefile Feature Class"
ArcInfo or PC ArcInfo Coverage (annotation) "Annotation Feature Class"
ArcInfo or PC ArcInfo Coverage (point) "Point Feature Class"
ArcInfo or PC ArcInfo Coverage (line) "Arc Feature Class"
ArcInfo or PC ArcInfo Coverage (polygon) "Polygon Feature Class"
Edge "StreetMap Feature Class"
CAD (annotation) "CAD Annotation Feature Class"
CAD (point) "CAD Point Feature Class"
CAD (line) "CAD Polyline Feature Class"
CAD (polygon) "CAD Polygon Feature Class"

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDataSourceType in interface IFeatureLayer
Specified by:
getDataSourceType in interface IFeatureLayer2
Returns:
The text
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataSourceType

public void setDataSourceType(String text)
                       throws IOException,
                              AutomationException
Data source type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDataSourceType in interface IFeatureLayer
Specified by:
setDataSourceType in interface IFeatureLayer2
Parameters:
text - The text (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayField

public String getDisplayField()
                       throws IOException,
                              AutomationException
Primary display field.

Description

The name of the layer's primary display field.

Remarks

Usually this field name contains the string "name", or is the first string field found in the layer's attributes. This field is used to show map tips for the layer. The value of this property must match the name of one of the fields in the layer's FeatureClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDisplayField in interface IFeatureLayer
Specified by:
getDisplayField in interface IFeatureLayer2
Returns:
The fieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayField

public void setDisplayField(String fieldName)
                     throws IOException,
                            AutomationException
Primary display field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDisplayField in interface IFeatureLayer
Specified by:
setDisplayField in interface IFeatureLayer2
Parameters:
fieldName - The fieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSelectable

public boolean isSelectable()
                     throws IOException,
                            AutomationException
Indicates if layer is selectable.

Description

Indicates whether the layer's features are selectable.

Remarks

The default value for Selectable is False.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSelectable in interface IFeatureLayer
Specified by:
isSelectable in interface IFeatureLayer2
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectable

public void setSelectable(boolean value)
                   throws IOException,
                          AutomationException
Indicates if layer is selectable.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSelectable in interface IFeatureLayer
Specified by:
setSelectable in interface IFeatureLayer2
Parameters:
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

search

public IFeatureCursor search(IQueryFilter queryFilter,
                             boolean recycling)
                      throws IOException,
                             AutomationException
Creates a cursor based upon the search criteria.

Description

Use this method to return a read-only cursor of the layer's features.

Remarks

If there is a definition query set on the layer, the Search method will automatically work on the subset of features in the layer that meet the definition criteria. You specify an additional query that will be applied after the layer's definition query by passing valid IQueryFilter object for the QueryFilter parameter.

This Search method will not work on joined fields. If the FeatureLayer has any joins, you should use the IGeoFeatureLayer::SearchDisplayFeatures method instead.

You cannot use the cursor returned by IFeatureLayer::Search to update features, instead use IFeatureClass::Update.

Recycling specifies whether the resulting feature cursor will be recycling or non-recycling. Use True for recycling cursor and False for a non-recycling cursor. See the topic for IFeatureClass::Search for more information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
search in interface IFeatureLayer
Specified by:
search in interface IFeatureLayer2
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.IFeatureCursor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isScaleSymbols

public boolean isScaleSymbols()
                       throws IOException,
                              AutomationException
Indicates if symbols are scaled for the layer.

Description

Indicates whether the symbols for this layer will respect the reference scale of the map containing the layer. Set this property to True for your layer and set a map reference scale to have your layer symbology scale as you zoom in and out.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isScaleSymbols in interface IFeatureLayer
Specified by:
isScaleSymbols in interface IFeatureLayer2
Returns:
The scale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setScaleSymbols

public void setScaleSymbols(boolean scale)
                     throws IOException,
                            AutomationException
Indicates if symbols are scaled for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setScaleSymbols in interface IFeatureLayer
Specified by:
setScaleSymbols in interface IFeatureLayer2
Parameters:
scale - The scale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShapeType

public int getShapeType()
                 throws IOException,
                        AutomationException
The layer's shape type.

Remarks

Returns the basic geometry type of the layer's underlying feature class. See IFeatureClass::ShapeType for more information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getShapeType in interface IFeatureLayer2
Returns:
A com.esri.arcgis.geometry.esriGeometryType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

expandRegionForSymbols

public void expandRegionForSymbols(IDisplay display,
                                   IGeometry region)
                            throws IOException,
                                   AutomationException
Expands the given geometry by an amount that will include the layer's symbology for the given display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
expandRegionForSymbols in interface IFeatureLayer2
Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
region - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(Object pUnk)
                throws IOException,
                       AutomationException
Indicates if the receiver can apply the given object at any given time.

Remarks

Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
applies in interface IPropertySupport
Parameters:
pUnk - A reference to another Object (IUnknown) (in)
Returns:
The applies
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(Object pUnk)
                 throws IOException,
                        AutomationException
Indicates if the receiver can apply the given object at that particular moment.

Remarks

CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
canApply in interface IPropertySupport
Parameters:
pUnk - A reference to another Object (IUnknown) (in)
Returns:
The canApply
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrent

public Object getCurrent(Object pUnk)
                  throws IOException,
                         AutomationException
The object currently being used.

Product Availability

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

Specified by:
getCurrent in interface IPropertySupport
Parameters:
pUnk - A reference to another Object (IUnknown) (in)
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

apply

public Object apply(Object newObject)
             throws IOException,
                    AutomationException
Applies the given property to the receiver and returns the old object.

Remarks

Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.

Use the Applies and CanApply methods to determine if an Apply can be used on an object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
apply in interface IPropertySupport
Parameters:
newObject - A reference to another Object (IUnknown) (in)
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldCount

public int getFieldCount()
                  throws IOException,
                         AutomationException
The number of fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFieldCount in interface ILayerFields
Specified by:
getFieldCount in interface ITableFields
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getField

public IField getField(int index)
                throws IOException,
                       AutomationException
The field at the specified index.

Product Availability

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

Specified by:
getField in interface ILayerFields
Specified by:
getField in interface ITableFields
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldInfo

public IFieldInfo getFieldInfo(int index)
                        throws IOException,
                               AutomationException
Extended field information for the field at the specified index.

Product Availability

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

Specified by:
getFieldInfo in interface ILayerFields
Specified by:
getFieldInfo in interface ITableFields
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFieldInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findField

public int findField(String fieldName)
              throws IOException,
                     AutomationException
Returns the index of the field with the specified name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
findField in interface ILayerFields
Specified by:
findField in interface IClass
Specified by:
findField in interface ITableFields
Parameters:
fieldName - The fieldName (in)
Returns:
The index
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttributeTable

public ITable getAttributeTable()
                         throws IOException,
                                AutomationException
The attribute table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAttributeTable in interface IAttributeTable
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createRow

public IRow createRow()
               throws IOException,
                      AutomationException
Creates a row in the database with a system assigned object ID and null property values.

Remarks

The CreateRow method creates a new row in the underlying database with a system assigned object id value. A row object representing the created row is returned to the caller. The row object returned has the system assigned object ID as the value of the OIDField. All other fields are initialized to null values if they can be made null and to built-in default values appropriate to the type of the field if they cannot be made null.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
createRow in interface ITable
Returns:
A reference to a com.esri.arcgis.geodatabase.IRow
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRow

public IRow getRow(int oID)
            throws IOException,
                   AutomationException
The row from the database with the specified object ID.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRow in interface ITable
Parameters:
oID - The oID (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRow
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRows

public ICursor getRows(Object oids,
                       boolean recycling)
                throws IOException,
                       AutomationException
The cursor of rows based on a set of object ids.

Remarks

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

The oids parameter should be passed an integer array. For example:

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

// Get a recycling cursor for the OID array.

int[] oids = new int[] { 10844, 10853, 10871 };

ICursor cursor = table.getRows(oids, true);

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createRowBuffer

public IRowBuffer createRowBuffer()
                           throws IOException,
                                  AutomationException
Creates a row buffer that can be used with an insert cursor.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
createRowBuffer in interface ITable
Returns:
A reference to a com.esri.arcgis.geodatabase.IRowBuffer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateSearchedRows

public void updateSearchedRows(IQueryFilter queryFilter,
                               IRowBuffer buffer)
                        throws IOException,
                               AutomationException
Update the Rows in the database selected by the specified query.

Description

This method will edit the rows matching the query filter's constraints. The values in each row will be replaced with the corresponding field's value in the provided row buffer. The fields being edited should be specified in the query filter's SubFields property. If the row buffer contains null values, and the SubFields property is not properly set, the row's values will be overwritten with the row buffer's null values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteSearchedRows

public void deleteSearchedRows(IQueryFilter queryFilter)
                        throws IOException,
                               AutomationException
Delete the Rows in the database selected by the specified query.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deleteSearchedRows in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rowCount

public int rowCount(IQueryFilter queryFilter)
             throws IOException,
                    AutomationException
The number of Rows selected by the specified query.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
rowCount in interface ITable
Parameters:
queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Returns:
The numRows
Throws:
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 IOException,
                             AutomationException
An object cursor that can be used to fetch row objects selected by the specified query.

Product Availability

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

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

public ICursor update(IQueryFilter queryFilter,
                      boolean recycling)
               throws IOException,
                      AutomationException
Returns a cursor that can be used to update Rows selected by the specified query.

Remarks

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

When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insert

public ICursor insert(boolean useBuffering)
               throws IOException,
                      AutomationException
Returns a cursor that can be used to insert new Rows.

Remarks

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

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

When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
insert in interface ITable
Parameters:
useBuffering - The useBuffering (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ICursor
Throws:
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 IOException,
                            AutomationException
A selection that contains the object ids selected by the specified query.

Remarks

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

The selType parameter determines the type of selection set that will be created: an ID set, a snapshot, or a hybrid. See the ISelectionSet interface for a comparison of the three types.

When calling Select the selectionContainer parameter is no longer required. A null value should be passed as this parameter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws IOException,
                         AutomationException
The fields collection for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFields in interface IClass
Returns:
A reference to a com.esri.arcgis.geodatabase.IFields
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIndexes

public IIndexes getIndexes()
                    throws IOException,
                           AutomationException
The indexes collection for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getIndexes in interface IClass
Returns:
A reference to a com.esri.arcgis.geodatabase.IIndexes
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addField

public void addField(IField field)
              throws IOException,
                     AutomationException
Adds a field to this object class.

Remarks

Prior to adding a new field to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Attempting to add a new field that does not allow null values will fail, if the class already has data in it. The only solution is to recreate the class with the non-nullable field, then copy the rows from the original class into the new class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
addField in interface IClass
Parameters:
field - A reference to a com.esri.arcgis.geodatabase.IField (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteField

public void deleteField(IField field)
                 throws IOException,
                        AutomationException
Deletes a field from this object class.

Remarks

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

Prior to deleting a field from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Example:

// Assume we have a reference to a FeatureClass (pFC)

      IFields pFields;

      IField pField;



      pFields = pFC.getFields();

      pField = pFields.getField(pFields.findField("MyField"));



      pFC.deleteField(pField);

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deleteField in interface IClass
Parameters:
field - A reference to a com.esri.arcgis.geodatabase.IField (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addIndex

public void addIndex(IIndex index)
              throws IOException,
                     AutomationException
Adds an index to this object class.

Remarks

Prior to adding a new index to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
addIndex in interface IClass
Parameters:
index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteIndex

public void deleteIndex(IIndex index)
                 throws IOException,
                        AutomationException
Deletes an index from this object class.

Remarks

Prior to deleting an index from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deleteIndex in interface IClass
Parameters:
index - A reference to a com.esri.arcgis.geodatabase.IIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasOID

public boolean isHasOID()
                 throws IOException,
                        AutomationException
Indicates if the class has an object identity (OID) field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isHasOID in interface IClass
Returns:
The hasOID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

public String getOIDFieldName()
                       throws IOException,
                              AutomationException
The name of the field corresponding to the OID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOIDFieldName in interface IClass
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCLSID

public IUID getCLSID()
              throws IOException,
                     AutomationException
The GUID for the COM Class (CoClass) corresponding to instances of this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCLSID in interface IClass
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEXTCLSID

public IUID getEXTCLSID()
                 throws IOException,
                        AutomationException
The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getEXTCLSID in interface IClass
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtension

public Object getExtension()
                    throws IOException,
                           AutomationException
The extension for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtension in interface IClass
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensionProperties

public IPropertySet getExtensionProperties()
                                    throws IOException,
                                           AutomationException
The extension properties for this object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtensionProperties in interface IClass
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensionCount

public int getExtensionCount()
                      throws IOException,
                             AutomationException
Number of extensions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtensionCount in interface ILayerExtensions
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtension

public Object getExtension(int index)
                    throws IOException,
                           AutomationException
The extension at the specified index.

Product Availability

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

Specified by:
getExtension in interface ILayerExtensions
Parameters:
index - The index (in)
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addExtension

public void addExtension(Object ext)
                  throws IOException,
                         AutomationException
Adds a new extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
addExtension in interface ILayerExtensions
Parameters:
ext - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeExtension

public void removeExtension(int index)
                     throws IOException,
                            AutomationException
Removes the specified extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
removeExtension in interface ILayerExtensions
Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUsesFilter

public boolean isUsesFilter()
                     throws IOException,
                            AutomationException
Indicates if the current object draws using a filter.

Remarks

The UsesFilter property returns true when the object in question will draw with a filter. Drawing with a filter means means that an object that would normally draw as vector graphics will instead draw as raster. The UsesFilter property is particularly useful for detecting vector map layers that will be rasterized at time of print or export.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isUsesFilter in interface IDisplayAdmin
Returns:
The usesFilter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDrawingPropsDirty

public boolean isDrawingPropsDirty()
                            throws IOException,
                                   AutomationException
Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDrawingPropsDirty in interface ILayerDrawingProperties
Returns:
The dirty
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDrawingPropsDirty

public void setDrawingPropsDirty(boolean dirty)
                          throws IOException,
                                 AutomationException
Indicates if the layer drawing properties are dirty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDrawingPropsDirty in interface ILayerDrawingProperties
Parameters:
dirty - The dirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws IOException,
                         AutomationException
The associated name object.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFullName in interface IDataset
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBrowseName

public String getBrowseName()
                     throws IOException,
                            AutomationException
The browse name of the dataset.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBrowseName in interface IDataset
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(String name)
                   throws IOException,
                          AutomationException
The browse name of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBrowseName in interface IDataset
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException
The type of the Dataset.

Remarks

The Type property returns the an esriDatasetType value indicating the dataset type, such as esriDTTable or esriDTFeatureClass.

Example:


// Assume we have a reference to an IfeatureClass (pFeatureClass) IDataset pDataset = null;
pDataset = new IDatasetProxy(pFeatureClass);
System.out.println(pDataset.getName() + " " + pDataset.getType());
if(pFeatureClass != null){
pDataset = pFeatureClass.getFeatureDataset();
System.out.println(pDataset.getName() + " " + pDataset.getType());
}
pDataset = new IDatasetProxy(pDataset.getWorkspace());
System.out.println(pDataset.getName() + " " +
pDataset.getType());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getType in interface IDataset
Returns:
A com.esri.arcgis.geodatabase.esriDatasetType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException
The category of the dataset.

Remarks

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

The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCategory in interface IDataset
Returns:
The category
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubsets

public IEnumDataset getSubsets()
                        throws IOException,
                               AutomationException
Datasets contained within this dataset.

Description

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

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSubsets in interface IDataset
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWorkspace

public IWorkspace getWorkspace()
                        throws IOException,
                               AutomationException
The workspace containing this dataset.

Description

The Workspace property returns the containing workspace for this dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getWorkspace in interface IDataset
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspace
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException
The set of properties for the dataset.

Description

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

Most datasets do not implement this property and will either raise an error or return a null value if it's called. There are a handful of exceptions that will return property sets; these include the datasets from file geodatabases (as mentioned above) and coverages.

Remarks

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPropertySet in interface IDataset
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canCopy

public boolean canCopy()
                throws IOException,
                       AutomationException
True if this dataset can be copied.

Remarks

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

The CanCopy method is supported by:

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
canCopy in interface IDataset
Returns:
The canCopy
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

copy

public IDataset copy(String copyName,
                     IWorkspace copyWorkspace)
              throws IOException,
                     AutomationException
Copies this dataset to a new dataset with the specified name.

Remarks

IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete()
                  throws IOException,
                         AutomationException
True if this dataset can be deleted.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
canDelete in interface IDataset
Returns:
The canDelete
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws IOException,
                   AutomationException
Deletes this dataset.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
delete in interface IDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canRename

public boolean canRename()
                  throws IOException,
                         AutomationException
True if this dataset can be renamed.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
canRename in interface IDataset
Returns:
The canRename
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rename

public void rename(String name)
            throws IOException,
                   AutomationException
Renames this Dataset.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
rename in interface IDataset
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerWeight

public double getLayerWeight()
                      throws IOException,
                             AutomationException
Default layer position.

Description

The LayerWeight property defines the weight of the layer in the auto arrange order. During auto arrange, the higher weight layers are added to the map first, which means they draw lower in the draw order.


Default weights for layers are these values:
Annotation layers = 97
Points layers = 98
Polyline layers = 99
Polygon Layers = 100

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLayerWeight in interface ILayerPosition
Returns:
The layerWeight
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerWeight

public void setLayerWeight(double layerWeight)
                    throws IOException,
                           AutomationException
Default layer position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLayerWeight in interface ILayerPosition
Parameters:
layerWeight - The layerWeight (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapLevel

public int getMapLevel()
                throws IOException,
                       AutomationException
Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMapLevel in interface IMapLevel
Returns:
The mapLevel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapLevel

public void setMapLevel(int mapLevel)
                 throws IOException,
                        AutomationException
Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMapLevel in interface IMapLevel
Parameters:
mapLevel - The mapLevel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataSourceName

public IName getDataSourceName()
                        throws IOException,
                               AutomationException
Name of the data object for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDataSourceName in interface IDataLayer
Specified by:
getDataSourceName in interface IDataLayer2
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataSourceName

public void setDataSourceName(IName name)
                       throws IOException,
                              AutomationException
Name of the data object for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDataSourceName in interface IDataLayer
Specified by:
setDataSourceName in interface IDataLayer2
Parameters:
name - A reference to a com.esri.arcgis.system.IName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDataSourceSupported

public boolean isDataSourceSupported(IName name)
                              throws IOException,
                                     AutomationException
Indicates if the specified data object name is supported by the layer.

Product Availability

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

Specified by:
isDataSourceSupported in interface IDataLayer
Specified by:
isDataSourceSupported in interface IDataLayer2
Parameters:
name - A reference to a com.esri.arcgis.system.IName (in)
Returns:
The supported
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

connect

public boolean connect(IName pOptRepairName)
                throws IOException,
                       AutomationException
Connects the layer to its data source. An optional name object can be specified to aid in repairing a lost connection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
connect in interface IDataLayer
Specified by:
connect in interface IDataLayer2
Parameters:
pOptRepairName - A reference to a com.esri.arcgis.system.IName (in)
Returns:
The succeeded
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRelativeBase

public String getRelativeBase()
                       throws IOException,
                              AutomationException
Base path used when storing relative path names.

Remarks

The RelativeBase property is used internally when persisting and loading documents with a relative path. When a document has been fully loaded the path is realized to a complete path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRelativeBase in interface IDataLayer
Specified by:
getRelativeBase in interface IDataLayer2
Returns:
The basePath
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelativeBase

public void setRelativeBase(String basePath)
                     throws IOException,
                            AutomationException
Base path used when storing relative path names.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRelativeBase in interface IDataLayer
Specified by:
setRelativeBase in interface IDataLayer2
Parameters:
basePath - The basePath (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

disconnect

public void disconnect()
                throws IOException,
                       AutomationException
Disconnects the data from the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
disconnect in interface IDataLayer2
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

inWorkspace

public boolean inWorkspace(IWorkspace workspace)
                    throws IOException,
                           AutomationException
Returns TRUE if the layer is in the specified workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
inWorkspace in interface IDataLayer2
Parameters:
workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:
The inWorkspace
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentZone

public String getCurrentZone()
                      throws IOException,
                             AutomationException
The current Time Zone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getCurrentZone in interface ITimeZone
Returns:
The pbstrCurrentZone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentZone

public void setCurrentZone(String pbstrCurrentZone)
                    throws IOException,
                           AutomationException
The current Time Zone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setCurrentZone in interface ITimeZone
Parameters:
pbstrCurrentZone - The pbstrCurrentZone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getZoneList

public Object getZoneList()
                   throws IOException,
                          AutomationException
List of time zones.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getZoneList in interface ITimeZone
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAdjustForDaylightSavings

public boolean isAdjustForDaylightSavings()
                                   throws IOException,
                                          AutomationException
Indicates whether or not to Adjust For Daylight Savings.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isAdjustForDaylightSavings in interface ITimeZone
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAdjustForDaylightSavings

public void setAdjustForDaylightSavings(boolean pVal)
                                 throws IOException,
                                        AutomationException
Indicates whether or not to Adjust For Daylight Savings.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setAdjustForDaylightSavings in interface ITimeZone
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeZoneXML

public String getTimeZoneXML()
                      throws IOException,
                             AutomationException
The XML representation of a TimeZone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getTimeZoneXML in interface ITimeZone
Returns:
The pbstrXML
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeZoneXML

public void setTimeZoneXML(String pbstrXML)
                    throws IOException,
                           AutomationException
The XML representation of a TimeZone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setTimeZoneXML in interface ITimeZone
Parameters:
pbstrXML - The pbstrXML (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

showPropertySheet

public boolean showPropertySheet()
                          throws IOException,
                                 AutomationException
Show the property sheet.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
showPropertySheet in interface ILayerPropertySheet
Returns:
The ok
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLastMinimumScale

public double getLastMinimumScale()
                           throws IOException,
                                  AutomationException
Last minimum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLastMinimumScale in interface ILayerGeneralProperties
Returns:
The minScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLastMaximumScale

public double getLastMaximumScale()
                           throws IOException,
                                  AutomationException
Last maximum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLastMaximumScale in interface ILayerGeneralProperties
Returns:
The maxScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

ILayerGeneralProperties_getLayerDescription

public String ILayerGeneralProperties_getLayerDescription()
                                                   throws IOException,
                                                          AutomationException
Description for the layer.

Product Availability

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

Specified by:
ILayerGeneralProperties_getLayerDescription in interface ILayerGeneralProperties
Returns:
The text
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerDescription

public void setLayerDescription(String text)
                         throws IOException,
                                AutomationException
Description for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLayerDescription in interface ILayerGeneralProperties
Parameters:
text - The text (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDynamicLayerDirty

public boolean isDynamicLayerDirty(int dynamicDrawPhase)
                            throws IOException,
                                   AutomationException
Indicates if the dynamic layer has changed since last drawn for the specified draw phase.

Product Availability

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

Specified by:
isDynamicLayerDirty in interface IDynamicLayer
Parameters:
dynamicDrawPhase - A com.esri.arcgis.display.esriDynamicDrawPhase constant (in)
Returns:
The dirty
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDynamicLayerDirty

public void setDynamicLayerDirty(int dynamicDrawPhase,
                                 boolean dirty)
                          throws IOException,
                                 AutomationException
Indicates if the dynamic layer has changed since last drawn for the specified draw phase.

Product Availability

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

Specified by:
setDynamicLayerDirty in interface IDynamicLayer
Parameters:
dynamicDrawPhase - A com.esri.arcgis.display.esriDynamicDrawPhase constant (in)
dirty - The dirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDynamicRecompileRate

public int getDynamicRecompileRate()
                            throws IOException,
                                   AutomationException
Recompile Rate is the interval in milliseconds by which the dynamic layer draw method will be called, with the compiled draw phase.

Description

The DynamicRecompileRate is an interval in milliseconds that is used by the Dynamic Map in order to determine whether the Dynamic Layer’s DrawDynamicLayer method needs to be called with the Compiled Phase, in order to recompile the layer’s drawing commands into the layer’s display list.

Remarks

The DynamicLayer’s DrawDynamicLayer method of the Compiled Phase will be called, when the DynamicLayerDirty of the Compiled Phase is true, and only after the DynamicRecompileRate interval had elapsed. The underlying data-structure of the layer may already been updated, however the display would reflect these changes only after the time interval set by DynamicRecompileRate has elapsed.

Using the compiled rate is very efficient for layers that manage large amount of items where every item gets updated in a relatively low rate. This way, due to the large number of items, there are constant updates streaming in, however the changes will get accumulated and will be applied to the display, according to the DynamicRecompileRate interval. That is good, performance wise, since this method minimizes CPU usage, of iterating through the layer items and generating the draw commands, and minimizes bus traffic of the drawing commands to the graphic card.

Product Availability

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

Specified by:
getDynamicRecompileRate in interface IDynamicLayer
Returns:
The dynamicRecompileRateTimeMS
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawDynamicLayer

public void drawDynamicLayer(int dynamicDrawPhase,
                             IDisplay display,
                             IDynamicDisplay dynamicDisplay)
                      throws IOException,
                             AutomationException
Draws the layer to the specified display for the given draw phase.

Remarks

Use this method to generate the Layer’s draw commands that correspond to the Dynamic Draw Phase.

Make sure to generate the draw commands at the desired Draw Phase. It is recommended for a Dynamic Layer to generate draw commands (and therefore be drawn) in one of the Dynamic Draw Phases, but not both. For example, if the layer is to be drawn only in the Immediate Phase, the method should inspect the drawing phase and only generate draw commands if enum esriDynamicDrawPhase is set to esriDDPImmediate.

Use the Dynamic Display API, and/or OpenGL API in order to generate the draw commands. In the context of the DrawDynamicLayer method, the OpenGL Rendering Context is active and is setup by the Dynamic Map.

Note: The Dynamic Display and OpenGL API's can safely be used only in the context of the IDynamicLayer.DrawDynamicLayer method and IDynamicMapEvents BeforeDynamicDraw\AfterDynamicDraw events. Any attempt to use them in any other context will result in unexpected behavior.

Product Availability

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

Specified by:
drawDynamicLayer in interface IDynamicLayer
Parameters:
dynamicDrawPhase - A com.esri.arcgis.display.esriDynamicDrawPhase constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
dynamicDisplay - A reference to a com.esri.arcgis.display.IDynamicDisplay (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDrawType

public int getDrawType()
                throws IOException,
                       AutomationException
The custom draw method.

Product Availability

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

Specified by:
getDrawType in interface ICustomGlobeLayer
Returns:
A com.esri.arcgis.globecore.esriGlobeCustomDrawType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseCache

public boolean isUseCache()
                   throws IOException,
                          AutomationException
The option to use Globe's disk caching.

Product Availability

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

Specified by:
isUseCache in interface ICustomGlobeLayer
Returns:
The pbUseCache
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumCellSize

public double getMinimumCellSize()
                          throws IOException,
                                 AutomationException
For rasterized types, defines highest resolution. Zero value indicates that globe-generated default value should be used.

Product Availability

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

Specified by:
getMinimumCellSize in interface ICustomGlobeLayer
Returns:
The pMinCellSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbologyScalingFactor

public double getSymbologyScalingFactor()
                                 throws IOException,
                                        AutomationException
The symbol scale factor for the custom rasterized type.

Product Availability

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

Specified by:
getSymbologyScalingFactor in interface ICustomGlobeLayer
Returns:
The pMetersPerPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTile

public void getTile(int tilesize,
                    int face,
                    int level,
                    int row,
                    int col,
                    byte[][] pData)
             throws IOException,
                    AutomationException
Gets a rasterized data tile for the given globe tesselation coordinates.

Product Availability

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

Specified by:
getTile in interface ICustomGlobeLayer
Parameters:
tilesize - The tilesize (in)
face - The face (in)
level - The level (in)
row - The row (in)
col - The col (in)
pData - An unsigned byte (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawImmediate

public void drawImmediate(IGlobeViewer pGlobeViewer)
                   throws IOException,
                          AutomationException
For custom OpenGL layers, perform immediate drawing.

Product Availability

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

Specified by:
drawImmediate in interface ICustomGlobeLayer
Parameters:
pGlobeViewer - A reference to a com.esri.arcgis.globecore.IGlobeViewer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hit

public void hit(int hitObjectID,
                IHit3D pHit3D)
         throws IOException,
                AutomationException
The layer is hit by a picking operation.

Product Availability

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

Specified by:
hit in interface ICustomGlobeLayer
Parameters:
hitObjectID - The hitObjectID (in)
pHit3D - A reference to a com.esri.arcgis.analyst3d.IHit3D (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHandlesLocalOrigin

public boolean isHandlesLocalOrigin()
                             throws IOException,
                                    AutomationException
The option to use a local coordinate system origin for high precision drawing.

Product Availability

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

Specified by:
isHandlesLocalOrigin in interface ICustomGlobeLayer
Returns:
The pbHandlesLocalOrigin
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLocalOrigin

public void setLocalOrigin(_WKSPointZ rhs1)
                    throws IOException,
                           AutomationException
The local coordinate system origin for high precision drawing.

Product Availability

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

Specified by:
setLocalOrigin in interface ICustomGlobeLayer
Parameters:
rhs1 - A Structure: com.esri.arcgis.system._WKSPointZ (A com.esri.arcgis.system._WKSPointZ COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDrawLeaderLines

public boolean isDrawLeaderLines()
                          throws IOException,
                                 AutomationException
Indicates whether to draw leader lines from the symbol to the surface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isDrawLeaderLines in interface ITrackingGlobeLayerLeaderLines
Returns:
The draw
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDrawLeaderLines

public void setDrawLeaderLines(boolean draw)
                        throws IOException,
                               AutomationException
Indicates whether to draw leader lines from the symbol to the surface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setDrawLeaderLines in interface ITrackingGlobeLayerLeaderLines
Parameters:
draw - The draw (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLeaderLinesUseSymbolColor

public boolean isLeaderLinesUseSymbolColor()
                                    throws IOException,
                                           AutomationException
Indicates whether the leader line will be colored according to the leader lines color property or according to the symbolized feature it points to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isLeaderLinesUseSymbolColor in interface ITrackingGlobeLayerLeaderLines
Returns:
The useSymbolColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLeaderLinesUseSymbolColor

public void setLeaderLinesUseSymbolColor(boolean useSymbolColor)
                                  throws IOException,
                                         AutomationException
Indicates whether the leader line will be colored according to the leader lines color property or according to the symbolized feature it points to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setLeaderLinesUseSymbolColor in interface ITrackingGlobeLayerLeaderLines
Parameters:
useSymbolColor - The useSymbolColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLeaderLinesColor

public IColor getLeaderLinesColor()
                           throws IOException,
                                  AutomationException
Specifies the color of the leader line.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getLeaderLinesColor in interface ITrackingGlobeLayerLeaderLines
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLeaderLinesColor

public void setLeaderLinesColor(IColor color)
                         throws IOException,
                                AutomationException
Specifies the color of the leader line.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setLeaderLinesColor in interface ITrackingGlobeLayerLeaderLines
Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElevatedLinesStyle

public int getElevatedLinesStyle()
                          throws IOException,
                                 AutomationException
Indicates the style of the elevated lines, and whether or not to elevate the symbols so they don't sink into the globe.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getElevatedLinesStyle in interface ITrackingGlobeLayerLeaderLines
Returns:
A com.esri.arcgis.trackinganalyst.esriTrackingElevatedLineStyle constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElevatedLinesStyle

public void setElevatedLinesStyle(int style)
                           throws IOException,
                                  AutomationException
Indicates the style of the elevated lines, and whether or not to elevate the symbols so they don't sink into the globe.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setElevatedLinesStyle in interface ITrackingGlobeLayerLeaderLines
Parameters:
style - A com.esri.arcgis.trackinganalyst.esriTrackingElevatedLineStyle constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isElevatedLinesUseSymbolColor

public boolean isElevatedLinesUseSymbolColor()
                                      throws IOException,
                                             AutomationException
Indicates whether the elevated line will be colored according to the elevated lines color property or according to the symbolized feature it points to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isElevatedLinesUseSymbolColor in interface ITrackingGlobeLayerLeaderLines
Returns:
The useSymbolColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElevatedLinesUseSymbolColor

public void setElevatedLinesUseSymbolColor(boolean useSymbolColor)
                                    throws IOException,
                                           AutomationException
Indicates whether the elevated line will be colored according to the elevated lines color property or according to the symbolized feature it points to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setElevatedLinesUseSymbolColor in interface ITrackingGlobeLayerLeaderLines
Parameters:
useSymbolColor - The useSymbolColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isElevatedLinesPointUseSymbolColor

public boolean isElevatedLinesPointUseSymbolColor()
                                           throws IOException,
                                                  AutomationException
Indicates whether the color of the point located at the base of the elevated lines will be colored according to the elevated lines point color property or according to the symbolized feature it points to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isElevatedLinesPointUseSymbolColor in interface ITrackingGlobeLayerLeaderLines
Returns:
The useSymbolColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElevatedLinesPointUseSymbolColor

public void setElevatedLinesPointUseSymbolColor(boolean useSymbolColor)
                                         throws IOException,
                                                AutomationException
Indicates whether the color of the point located at the base of the elevated lines will be colored according to the elevated lines point color property or according to the symbolized feature it points to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setElevatedLinesPointUseSymbolColor in interface ITrackingGlobeLayerLeaderLines
Parameters:
useSymbolColor - The useSymbolColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElevatedLinesColor

public IColor getElevatedLinesColor()
                             throws IOException,
                                    AutomationException
Specifies the color of the elevated lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getElevatedLinesColor in interface ITrackingGlobeLayerLeaderLines
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElevatedLinesColor

public void setElevatedLinesColor(IColor color)
                           throws IOException,
                                  AutomationException
Specifies the color of the elevated lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setElevatedLinesColor in interface ITrackingGlobeLayerLeaderLines
Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElevatedLinesLength

public double getElevatedLinesLength()
                              throws IOException,
                                     AutomationException
Indicates the length of the elevated lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getElevatedLinesLength in interface ITrackingGlobeLayerLeaderLines
Returns:
The length
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElevatedLinesLength

public void setElevatedLinesLength(double length)
                            throws IOException,
                                   AutomationException
Indicates the length of the elevated lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setElevatedLinesLength in interface ITrackingGlobeLayerLeaderLines
Parameters:
length - The length (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElevatedLinesLengthUnits

public int getElevatedLinesLengthUnits()
                                throws IOException,
                                       AutomationException
Indicates the units for the length of the elevated line.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getElevatedLinesLengthUnits in interface ITrackingGlobeLayerLeaderLines
Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElevatedLinesLengthUnits

public void setElevatedLinesLengthUnits(int lengthUnits)
                                 throws IOException,
                                        AutomationException
Indicates the units for the length of the elevated line.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setElevatedLinesLengthUnits in interface ITrackingGlobeLayerLeaderLines
Parameters:
lengthUnits - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElevatedLinesWidth

public double getElevatedLinesWidth()
                             throws IOException,
                                    AutomationException
Indicates the width of the elevated lines in pixels.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getElevatedLinesWidth in interface ITrackingGlobeLayerLeaderLines
Returns:
The width
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElevatedLinesWidth

public void setElevatedLinesWidth(double width)
                           throws IOException,
                                  AutomationException
Indicates the width of the elevated lines in pixels.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setElevatedLinesWidth in interface ITrackingGlobeLayerLeaderLines
Parameters:
width - The width (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLeaderLinesWidth

public double getLeaderLinesWidth()
                           throws IOException,
                                  AutomationException
Indicates the width of the leader lines in pixels.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getLeaderLinesWidth in interface ITrackingGlobeLayerLeaderLines
Returns:
The width
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLeaderLinesWidth

public void setLeaderLinesWidth(double width)
                         throws IOException,
                                AutomationException
Indicates the width of the leader lines in pixels.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setLeaderLinesWidth in interface ITrackingGlobeLayerLeaderLines
Parameters:
width - The width (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElevatedLinesPointWidth

public double getElevatedLinesPointWidth()
                                  throws IOException,
                                         AutomationException
Indicates the width of the point located at the base of the elevated lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getElevatedLinesPointWidth in interface ITrackingGlobeLayerLeaderLines
Returns:
The width
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElevatedLinesPointWidth

public void setElevatedLinesPointWidth(double width)
                                throws IOException,
                                       AutomationException
Indicates the width of the point located at the base of the elevated lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setElevatedLinesPointWidth in interface ITrackingGlobeLayerLeaderLines
Parameters:
width - The width (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSmoothElevatedLinesPoint

public boolean isSmoothElevatedLinesPoint()
                                   throws IOException,
                                          AutomationException
Indicates whether to smooth the point located at the base of the elevated lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
isSmoothElevatedLinesPoint in interface ITrackingGlobeLayerLeaderLines
Returns:
The smooth
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSmoothElevatedLinesPoint

public void setSmoothElevatedLinesPoint(boolean smooth)
                                 throws IOException,
                                        AutomationException
Indicates whether to smooth the point located at the base of the elevated lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setSmoothElevatedLinesPoint in interface ITrackingGlobeLayerLeaderLines
Parameters:
smooth - The smooth (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElevatedLinesPointColor

public IColor getElevatedLinesPointColor()
                                  throws IOException,
                                         AutomationException
Specifies the color of the point located at the base of the elevated lines.

Remarks

When the elevated lines point color property is set to NULL (0), the point color will follow the elevated lines color property.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getElevatedLinesPointColor in interface ITrackingGlobeLayerLeaderLines
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElevatedLinesPointColor

public void setElevatedLinesPointColor(IColor color)
                                throws IOException,
                                       AutomationException
Specifies the color of the point located at the base of the elevated lines.

Remarks

When the elevated lines point color property is set to NULL (0), the point color will follow the elevated lines color property.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
setElevatedLinesPointColor in interface ITrackingGlobeLayerLeaderLines
Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.