com.esri.arcgis.trackinganalyst
Class TemporalFeatureLayer

java.lang.Object
  com.esri.arcgis.trackinganalyst.TemporalFeatureLayer

All Implemented Interfaces:

IAttributeTable, IDataLayer, IDataLayer2, IDisplayString, IDisplayTable, IDynamicLayer, IFeatureGeometryAccess, IFeatureLayer, IFeatureLayer2, IFeatureLayerDefinition, IFeatureSelection, IFind, IGeoFeatureLayer, IHotlinkContainer, IHTMLPopupIdentify, IHTMLPopupIdentify2, IHTMLPopupInfo, IHTMLPopupInfo2, IIdentify, IIdentify2, ILayer, ILayer2, ILayerDrawingProperties, ILayerEffects, ILayerExtensions, ILayerFields, ILayerGeneralProperties, ILayerInfo, ILayerPosition, ILayerPropertySheet, ILegendInfo, IPublishLayer, ITableSelection, ITemporalSearch, ITimeData, ITimeData2, ITimeDataDisplay, ITimeDisplayTable, ITimeDisplayTable2, ITimeTableDefinition, IConnectionPointContainer, IDisplayAdmin, IDisplayFilterManager, IMapLevel, IClass, IDataset, IGeoDataset, ITable, ITableCapabilities, ITableFields, ICustomGlobeLayer, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, IPropertySupport, ISupportErrorInfo, ITemporalLayer, ITimeRegionalSettings, ITimeZone, ITrackingGlobeLayerLeaderLines, ITrackingLayerLabels, java.io.Externalizable, java.io.Serializable

public class TemporalFeatureLayer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITemporalLayer, ITemporalSearch, ITimeRegionalSettings, ILayer, ILayer2, ILegendInfo, ILayerInfo, ITrackingLayerLabels, IIdentify, IGeoFeatureLayer, IFeatureSelection, IFeatureLayerDefinition, IGeoDataset, IIdentify2, ITableSelection, IFind, IDisplayTable, IFeatureLayer, IFeatureLayer2, IPersist, IPersistStream, IPropertySupport, ILayerFields, ITableFields, IAttributeTable, ITable, IClass, ILayerExtensions, IDisplayAdmin, ILayerDrawingProperties, IDataset, ILayerPosition, IMapLevel, IDataLayer, IDataLayer2, ITimeZone, ILayerPropertySheet, ILayerGeneralProperties, IDynamicLayer, ICustomGlobeLayer, ITrackingGlobeLayerLeaderLines, IDisplayString, IHTMLPopupInfo, IHTMLPopupInfo2, IHTMLPopupIdentify, IHTMLPopupIdentify2, IHotlinkContainer, IDisplayFilterManager, ILayerEffects, ISupportErrorInfo, IConnectionPointContainer, IFeatureGeometryAccess, ITableCapabilities, IDocumentVersionSupportGEN, ITimeData, ITimeData2, ITimeTableDefinition, ITimeDataDisplay, IPublishLayer, ITimeDisplayTable, ITimeDisplayTable2, java.io.Externalizable

COM Class 'TemporalFeatureLayer'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'Defines the coclass IDL parameters and attributes of the TemporalFeatureLayer COM object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITemporalLayer

IID, IID78c7430c_17cf_11d5_b7cf_00010265adc5, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ITemporalSearch

IID, IIDdf2b7788_6450_4c78_b43f_c80c3c2730cc, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITimeRegionalSettings

IID, IID74bdfe0b_13e2_42b9_b823_0f8ebe1daada, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ILayer2

IID, IID599dee2e_2182_4e54_8a86_725145c9d989, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ILayerInfo

IID, IID274419e1_0f5c_11d3_9bfd_00c04f5b951e, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITrackingLayerLabels

IID, IID10f256e0_f0c9_11d5_b81b_00010265adc5, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IGeoFeatureLayer

IID, IIDe156d7e5_22af_11d3_9f99_00c04f6bc78e, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IFeatureLayer

IID40a9e885_5533_11d0_98be_00805f7ced21

Fields inherited from interface com.esri.arcgis.carto.IFeatureSelection

IID, IID9336a280_c9a3_11d1_847e_0000f875b9c6, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IFeatureLayerDefinition

IID, IID3e1608cf_ff34_11d1_adf1_080009ec732a, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IIdentify2

IID, IID0483dc2f_8726_4640_98cd_5888ff1a4fa4, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ITableSelection

IID, IID2c232271_fbaa_11d3_b9d3_00c0f0567a4a, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IFind

IID, IID9fe681e6_ba4e_4729_8301_8f15a1544140, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IDisplayTable

IID, IIDcce71a6d_6135_46cd_bbed_616a74831b30, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IFeatureLayer2

IID, IID95e82d50_e720_48b5_808d_e45fa9cf1218, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IPropertySupport

IID, IID8a11ad55_2f4f_11d3_9fa0_00c04f6bc6a5, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ILayerFields

IID, IIDa2baae2b_969b_11d2_ae77_080009ec732a, xxDummy

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

IID, IIDe5966b0a_e3d9_11d3_a096_00c04f6bc626, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IAttributeTable

IID, IID07f3186c_af91_4ad6_bf67_11167d0f8f60, xxDummy

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

IID, IIDfcb01cb5_9f0b_11d0_bec7_00805f7c4268, xxDummy

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

IID1afcdb32_ac09_11d2_8a1e_006097aff44e

Fields inherited from interface com.esri.arcgis.carto.ILayerExtensions

IID, IIDbb6a78ca_9c28_4f75_899f_dff65174082c, xxDummy

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

IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ILayerPosition

IID, IIDc0dc8820_e10f_4285_aab1_6c6b685dbb84, xxDummy

Fields inherited from interface com.esri.arcgis.display.IMapLevel

IID, IIDcef72580_c1d9_11d2_9888_0080c7e04196, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IDataLayer

IID, IID6ca416b1_e160_11d2_9f4e_00c04f6bc78e, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IDataLayer2

IID, IIDe9d11f65_6936_4408_b69f_d91552eb9c4a, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITimeZone

IID, IIDfed00c52_876a_4d87_a3cb_491fbecd07c6, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ILayerPropertySheet

IID, IID2eef47a6_9527_4d1a_a452_cdddf4c5e080, xxDummy

Fields inherited from interface com.esri.arcgis.globecore.ICustomGlobeLayer

IID, IID28416400_6965_4df1_9823_48973b44179c, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITrackingGlobeLayerLeaderLines

IID, IID5e66c9b2_9d5f_40d5_8b2e_15a23e982081, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IDisplayString

IID, IID8d090acb_8c9e_4343_a3cc_f9da9be3c401, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IHTMLPopupInfo

IID, IID742678bc_aff5_41da_a523_36a8bd4e2c8b, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IHTMLPopupInfo2

IID, IID8a038cdb_0430_40d9_b8ce_8b055f11d511, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IHTMLPopupIdentify

IID, IID095cdd1a_fe17_4719_9072_15f303f82e69, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IHTMLPopupIdentify2

IID, IID8cc24376_c6e0_4ae0_8561_17fa049aee03, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IHotlinkContainer

IID, IIDd1a02a0c_2113_11d3_9f98_00c04f6bc78e, xxDummy

Fields inherited from interface com.esri.arcgis.display.IDisplayFilterManager

IID, IIDf0815360_19e1_11d3_80c8_0080c79f0371, xxDummy

Fields inherited from interface com.esri.arcgis.display.IDisplayAdmin

IID12e361f0_1907_11d3_80c7_0080c79f0371

Fields inherited from interface com.esri.arcgis.carto.ILayerEffects

IID, IID09998199_1fb8_11d3_ab4e_000000000000, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IFeatureGeometryAccess

IID, IIDaddf1b83_7d75_49c6_a587_73a0aba90e99, xxDummy

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

IID, IID8b0338b9_3b3d_11d4_9fbb_00c04f6bdf0c, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ITimeData2

IID, IID6308f920_d4ef_4e5f_b0fc_7a63ed132b27, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ITimeData

IID008331d0_1225_4fe7_ad19_c3431625d337

Fields inherited from interface com.esri.arcgis.carto.ITimeTableDefinition

IID, IID9f45df65_de39_4a88_b174_b2ad3d3020a8, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ITimeDataDisplay

IID, IIDf12874c3_3358_40a5_8e32_c824dd1d75fa, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IPublishLayer

IID, IID7453c805_9d64_44a6_bf2f_73e477dce18f, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ITimeDisplayTable2

IID, IID64b8b4af_4f12_4f66_b2dc_79476910ee38, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ITimeDisplayTable

IID7a55bbf1_52f0_413b_ac7c_761bd139ae3f

Constructor Summary

TemporalFeatureLayer()
Constructs a TemporalFeatureLayer using ArcGIS Engine.

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

Method Summary

void	add(IFeature feature) Adds a feature to the selection set.
void	addExtension(java.lang.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	addIObjectClassSchemaEventsListener(IObjectClassSchemaEvents theListener) addIObjectClassSchemaEventsListener.
void	addRow(IRow row) Adds a row to the selection set (honoring the current combination method).
boolean	applies(java.lang.Object pUnk) Indicates if the receiver can apply the given object at any given time.
java.lang.Object	apply(java.lang.Object newObject) Applies the given property to the receiver and returns the old object.
boolean	canApply(java.lang.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.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
IDataset	copy(java.lang.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(java.lang.String layerName, boolean useCurrentSelection, java.lang.String joinTableNames, java.lang.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.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.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(java.lang.String search, boolean contains, java.lang.Object fields, ITrackCancel trackCancel) Finds the specified search string in the given attribute fields.
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
java.lang.String	findDisplayString(IObject pObject) Finds the display string for the given feature based on the current expression properties.
int	findField(java.lang.String fieldName) Returns the index of the field with the specified name.
IActionCollection	getActionCollection() The collection of action objects for this temporal layer.
java.lang.String	getAMDesignator() String for the AM designator.
IAnnotateLayerPropertiesCollection	getAnnotationProperties() Annotation properties.
IUID	getAnnotationPropertiesID() The UID used for annotation properties.
IEnvelope	getAreaOfInterest() The default area of interest for the layer.
ITable	getAttributeTable() The attribute table.
short	getBrightness() Layer brightness in percent (-100 - 100).
java.lang.String	getBrowseName() The browse name of the dataset.
double	getBufferDistance() Buffer distance used for the selection.
java.lang.String	getCategory() The category of the dataset.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.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.
short	getContrast() Layer contrast in percent (-100 - 100).
java.lang.Object	getCurrent(java.lang.Object pUnk) The object currently being used.
java.lang.String	getCurrentZone() The current Time Zone.
ITimeExtent	getCustomTimeExtent() Custom time extent during which a layer is visible.
java.lang.String	getDataDetails(java.lang.String bsPadding) Details of the layer's data.
IName	getDataSourceName() Name of the data object for the layer.
java.lang.String	getDataSourceType() Data source type.
java.lang.String	getDateStyleFormat() Date style used when parsing the date portion of a time string in the temporal column.
java.lang.String	getDefinitionExpression() Definition query expression for the existing layer.
ISelectionSet	getDefinitionSelectionSet() The selection set that defines the subset of features in a selection layer.
IFeatureClass	getDisplayFeatureClass() Feature class used for display operations (may include joined fields).
java.lang.String	getDisplayField() Primary display field.
IDisplayFilter	getDisplayFilter() The display filter.
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.
java.lang.String	getEndTimeFieldName() Name of the field that has end time for a row.
java.lang.String	getEventIDFieldName() Indicates the field containing the EventID information for the data.
IFeatureIDSet	getExclusionSet() The set of features that are excluded from drawing.
IDisplayExpressionProperties	getExpressionProperties() Properties that describe the display expression.
IUID	getEXTCLSID() The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.
java.lang.Object	getExtension() The extension for this object class.
java.lang.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.
java.lang.String	getFindDisplayField() The display field.
java.lang.Object	getFindFields() The attribute fields.
IName	getFullName() The associated name object.
ITimeExtent	getFullTimeExtent() Returns the time extent for all the data in the layer.
java.lang.String	getHotlinkField() Field used for hotlinks.
int	getHotlinkType() Hotlink type.
java.lang.String	getHTMLOutput(IFeature pFeature) The content is the XML text for the input feature.
int	getHTMLPresentationStyle() Indicates the content formating style for the HTML Popup tool.
java.lang.String	getHTMLRedirectField() Indicates the fieldname of the layer that contains the HTML redirect URL values.
java.lang.String	getHTMLRedirectFieldPrefix() Indicates the text to precede the HTMLRedirectField value for the redirect URL.
java.lang.String	getHTMLRedirectFieldSuffix() Indicates the text to follow the HTMLRedirectField value for the redirect URL.
java.lang.String	getHTMLXSLStylesheet() Indicates the content of the XSL stylesheet to parse the feature attributes through.
IIndexes	getIndexes() The indexes collection for this object class.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.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.
java.lang.String	getName() Layer name.
double	getOffsetAngle() Indicates angle of offset for labels as they draw next to events on the map display.
java.lang.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.
java.lang.String	getPMDesignator() String for the PM designator.
IPropertySet	getPropertySet() The set of properties for the dataset.
java.lang.String	getPublishingDescription() The layer description reported to the publisher.
IRelationshipClass	getRelationshipClass() The current relationship class used to display related fields.
java.lang.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.
IUID	getRendererPropertyPageClassID() Class id of the property page for the renderer.
IRow	getRow(int oID) The row from the database with the specified object ID.
ICursor	getRows(java.lang.Object oids, boolean recycling) The cursor of rows based on a set of object ids.
IColor	getSelectionColor() Selection color.
ISelectionSet	getSelectionSet() The selected set of features.
ISymbol	getSelectionSymbol() Selection symbol.
int	getShapeType() The layer's shape type.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
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.
java.lang.String	getStartTimeFieldName() Name of the field that has start time for a row.
IEnumDataset	getSubsets() Datasets contained within this dataset.
int	getSupportedDrawPhases() Supported draw phases.
double	getSymbologyScalingFactor() The symbol scale factor for the custom rasterized type.
java.lang.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.
double	getTimeInterval() Returns recommended time interval to be used to animate this layer/ table.
int	getTimeIntervalUnits() Returns recommended time interval units to be used to animate this layer/ table.
double	getTimeOffset() Returns time offset that needs to be applied to the data for drawing.
int	getTimeOffsetUnits() Returns recommended time interval units to be used to animate this layer/ table.
ITimeReference	getTimeReference() Time reference for the contents of the layer.
java.lang.String	getTimeStyleFormat() Time formatting style used to parse the time portion of a time string in the temporal column.
java.lang.String	getTimeValueFormat() Time value format if the field name is of the string format.
java.lang.String	getTimeZoneXML() The XML representation of a TimeZone.
java.lang.String	getTipText(double x, double y, double tolerance) Map tip text at the specified location.
java.lang.String	getTrackIDFieldName() Field that contains the rows that uniquely identifies the object whose time is being tracked.
short	getTransparency() Layer transparency in percent (0-100).
int	getType() The type of the Dataset.
IWorkspace	getWorkspace() The workspace containing this dataset.
java.lang.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.
void	hTMLIdentify(IDisplay pDisplay, IGeometry pGeometry, IPropertySet pOptions, IStringArray[] ppItemNames, IStringArray[] ppItemHTML) The content is the XML text at the specified point.
java.lang.String	hTMLIdentify(IPoint pPoint, double tolerance) The content is the XML text at the specified point.
java.lang.String	hTMLOutput(IFeature pFeature, IPropertySet pOptions) The content is the XML text for the input feature, pOptions is an optional parameter.
java.lang.String	hTMLTipText(IPoint pPoint, double tolerance) The tooltip at the specified point.
IArray	identify(IGeometry pGeom) Identifies objects at the specified location.
IArray	identify(IGeometry pGeom, ITrackCancel pTrackCancel) Identifies objects at the specified location.
java.lang.String	ILayerGeneralProperties_getLayerDescription() Description for the layer.
ICursor	insert(boolean useBuffering) Returns a cursor that can be used to insert new Rows.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
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	isCanAccessGeometry() Indicates whether the a feature layer gives access to the geometry of its features.
boolean	isCanSelect() Indicates if the table supports selection.
boolean	isDataSourceSupported(IName name) Indicates if the specified data object name is supported by the layer.
boolean	isDataValid() Indicates if the data for the layer is currently valid.
void	isDirty() isDirty
boolean	isDisplayAnnotation() Indicates if the layer displays annotation.
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	isHasLiveData() isHasLiveData
boolean	isHasOID() Indicates if the class has an object identity (OID) field.
boolean	isHTMLDownloadAttachmentData() Indicates that all data for attachments will be retrieved.
boolean	isHTMLHideFieldNameColumn() Indicates if Field name column will be output to the HTML Popup tool.
boolean	isHTMLPopupEnabled() Indicates if this layer currently responds to the HTML Popup tool.
boolean	isHTMLUseCodedDomainValues() Indicates whether to use coded values (rather than literal stored values) for feature values.
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	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
boolean	isSupportsBrightnessChange() Indicates if the layer supports brightness changes.
boolean	isSupportsContrastChange() Indicates if the layer supports contrast changes.
boolean	isSupportsInteractive() Indicates if the layer supports interactive effects changes.
boolean	isSupportsPublishing() Indicates if the layer supports the publishing process.
boolean	isSupportsTime() Indicates whether the layer has any time data.
boolean	isSupportsTransparency() Indicates if the layer supports transparency.
boolean	isSymbolsAreGraduated() Indicates if symbols are graduated.
boolean	isTimeDataCumulative() Indicates that features will be animated cumilatively.
boolean	isUseCache() The option to use Globe's disk caching.
boolean	isUsesFilter() Indicates if the current object draws using a filter.
boolean	isUseTime() Indicates whether to use the time for animation purposes.
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(java.lang.Object varStartingTime, java.lang.Object varEndingTime) Searches for last known features in the dataset.
IFeatureIDSet	lastKnownOIDs(java.lang.Object varStartingTime, java.lang.Object varEndingTime) Searches for the last known OIDs in the dataset.
void	load(IStream pstm) load
void	prepareForPublishing() Prepare the layer for the publishing process.
void	prepareTimeQuery(ITimeValue pTimeValue, IQueryFilter[] pFilter) Prepares an input query filter by appending the time expression into the where clause.
void	prepareTimeQueryEx(ITimeValue pTimeValue, int eTimeRelation, IQueryFilter[] pFilter) Prepares an input query filter by appending the time expression into the where clause.
void	prepareTimeQueryFromDisplay(IDisplay pDisplay, IQueryFilter[] pFilter) Prepares an input query filter by appending the time expression into the where clause.
void	processActions(boolean bvarResetActions) Apply the actions, contained in the action collection, to this temporal layer.
void	queryTemporalExtent(java.lang.Object[] pvarStartTime, java.lang.Object[] pvarEndTime) Obtain the start and end temporal values of the temporal layer's features.
void	readExternal(java.io.ObjectInput in)
void	release() Release a TemporalFeatureLayer.
void	removeExtension(int index) Removes the specified extension.
void	removeILayerEventsListener(ILayerEvents theListener) removeILayerEventsListener.
void	removeIObjectClassSchemaEventsListener(IObjectClassSchemaEvents theListener) removeIObjectClassSchemaEventsListener.
void	rename(java.lang.String name) Renames this Dataset.
int	rowCount(IQueryFilter queryFilter) The number of Rows selected by the specified query.
void	save(IStream pstm, int fClearDirty) save
IFeatureCursor	search(IQueryFilter queryFilter, boolean recycling) Creates a cursor based upon the search criteria.
IFeatureCursor	searchDisplayFeatures(IQueryFilter queryFilter, boolean recycling) Creates a cursor from the display feature class 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(java.lang.String pbstrAMDesignator) String for the AM designator.
void	setAnnotationProperties(IAnnotateLayerPropertiesCollection props) Annotation properties.
void	setAnnotationPropertiesIDByRef(IUID uid) The UID used for annotation properties.
void	setAreaOfInterest(IEnvelope aoi) The default area of interest for the layer.
void	setBrightness(short brightnessValue) Layer brightness in percent (-100 - 100).
void	setBrowseName(java.lang.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	setContrast(short contrastValue) Layer contrast in percent (-100 - 100).
void	setCurrentMapLevel(int rhs1) Current map level for drawing symbols.
void	setCurrentZone(java.lang.String pbstrCurrentZone) The current Time Zone.
void	setCustomTimeExtentByRef(ITimeExtent layerVisibiltyTime) Custom time extent during which a layer is visible.
void	setDataSourceName(IName name) Name of the data object for the layer.
void	setDataSourceType(java.lang.String text) Data source type.
void	setDateStyleFormat(java.lang.String pbstrDateStyleFormat) Date style used when parsing the date portion of a time string in the temporal column.
void	setDefinitionExpression(java.lang.String expression) Definition query expression for the existing layer.
void	setDisplayAnnotation(boolean value) Indicates if the layer displays annotation.
void	setDisplayField(java.lang.String fieldName) Primary display field.
void	setDisplayFilter(IDisplayFilter displayFilter) The display filter.
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	setEndTimeFieldName(java.lang.String fieldName) Name of the field that has end time for a row.
void	setExclusionSetByRef(IFeatureIDSet fIDs) The set of features that are excluded from drawing.
void	setExpressionPropertiesByRef(IDisplayExpressionProperties displayExpressionProperties) Properties that describe the display expression.
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	setHasLiveData(boolean useTime) setHasLiveData
void	setHotlinkField(java.lang.String fieldName) Field used for hotlinks.
void	setHotlinkType(int linkType) Hotlink type.
void	setHTMLDownloadAttachmentData(boolean pDownloadAttachmentData) Indicates that all data for attachments will be retrieved.
void	setHTMLHideFieldNameColumn(boolean pHide) Indicates if Field name column will be output to the HTML Popup tool.
void	setHTMLPopupEnabled(boolean pEnabled) Indicates if this layer currently responds to the HTML Popup tool.
void	setHTMLPresentationStyle(int pStyle) Indicates the content formating style for the HTML Popup tool.
void	setHTMLRedirectField(java.lang.String pField) Indicates the fieldname of the layer that contains the HTML redirect URL values.
void	setHTMLRedirectFieldPrefix(java.lang.String pPrefix) Indicates the text to precede the HTMLRedirectField value for the redirect URL.
void	setHTMLRedirectFieldSuffix(java.lang.String pSufix) Indicates the text to follow the HTMLRedirectField value for the redirect URL.
void	setHTMLUseCodedDomainValues(boolean pCodedValues) Indicates whether to use coded values (rather than literal stored values) for feature values.
void	setHTMLXSLStylesheet(java.lang.String pStyleSheet) Indicates the content of the XSL stylesheet to parse the feature attributes through.
void	setLabelFeatures(boolean pbvarLabelFeatures) Indicates whether or not feature labels will appear as events draw to the map display.
void	setLabelFieldName(java.lang.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(java.lang.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(java.lang.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(java.lang.String pbstrPMDesignator) String for the PM designator.
void	setRelationshipClassByRef(IRelationshipClass relClass) The current relationship class used to display related fields.
void	setRelativeBase(java.lang.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	setRendererPropertyPageClassID(IUID cLSID) Class id of the property page for the renderer.
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	setStartTimeFieldName(java.lang.String fieldName) Name of the field that has start time for a row.
void	setSupportsInteractive(boolean supported) Indicates if the layer supports interactive effects changes.
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	setTimeDataCumulative(boolean cumilative) Indicates that features will be animated cumilatively.
void	setTimeInterval(double interval) Returns recommended time interval to be used to animate this layer/ table.
void	setTimeIntervalUnits(int units) Returns recommended time interval units to be used to animate this layer/ table.
void	setTimeOffset(double timeOffset) Returns time offset that needs to be applied to the data for drawing.
void	setTimeOffsetUnits(int units) Returns recommended time interval units to be used to animate this layer/ table.
void	setTimeReferenceByRef(ITimeReference nativeTimeReference) Time reference for the data.
void	setTimeStyleFormat(java.lang.String pbstrTimeStyleFormat) Time formatting style used to parse the time portion of a time string in the temporal column.
void	setTimeValueFormat(java.lang.String format) Time value format if the field name is of the string format.
void	setTimeZoneXML(java.lang.String pbstrXML) The XML representation of a TimeZone.
void	setTrackIDFieldName(java.lang.String fieldName) Field that contains the rows that uniquely identifies the object whose time is being tracked.
void	setTransparency(short alpha) Layer transparency in percent (0-100).
void	setUseTime(boolean useTime) Indicates whether to use the time for animation purposes.
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.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

TemporalFeatureLayer

public TemporalFeatureLayer()
                     throws java.io.IOException,
                            java.net.UnknownHostException

Constructs a TemporalFeatureLayer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TemporalFeatureLayer

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

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:

java.io.IOException - if there are interop problems TemporalFeatureLayer theTemporalFeatureLayer = (TemporalFeatureLayer) obj;

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

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

Deprecated. Internal use only.

Specified by:

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

addILayerEventsListener

public void addILayerEventsListener(ILayerEvents theListener)
                             throws java.io.IOException

addILayerEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.ILayerEvents interface.

Throws:

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

removeILayerEventsListener

public void removeILayerEventsListener(ILayerEvents theListener)
                                throws java.io.IOException

removeILayerEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.ILayerEvents interface.

Throws:

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

addIObjectClassSchemaEventsListener

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

addIObjectClassSchemaEventsListener. Listen to events generated by this class.

Parameters:

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

Throws:

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

removeIObjectClassSchemaEventsListener

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

removeIObjectClassSchemaEventsListener. Stop listening to events generated by this class.

Parameters:

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

Throws:

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

release

public void release()

Release a TemporalFeatureLayer.

Specified by:

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

getName

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

Layer name.

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:

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

AutomationException - If the ArcObject component throws an exception.

setName

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

Layer name.

Specified by:

setName in interface ILayer

Specified by:

setName in interface ILayer2

Specified by:

setName in interface ITemporalLayer

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isValid

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

Indicates if the layer is currently valid.

Specified by:

isValid in interface ILayer

Specified by:

isValid in interface ILayer2

Specified by:

isValid in interface ITemporalLayer

Returns:

The valid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

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

The default area of interest for the layer.

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:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumScale

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

Minimum scale (representative fraction) at which the layer will display.

Specified by:

getMinimumScale in interface ILayer

Specified by:

getMinimumScale in interface ILayer2

Specified by:

getMinimumScale in interface ITemporalLayer

Returns:

The minScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumScale

public void setMinimumScale(double minScale)
                     throws java.io.IOException,
                            AutomationException

Minimum scale (representative fraction) at which the layer will display.

Specified by:

setMinimumScale in interface ILayer

Specified by:

setMinimumScale in interface ILayer2

Specified by:

setMinimumScale in interface ITemporalLayer

Parameters:

minScale - The minScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumScale

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

Maximum scale (representative fraction) at which the layer will display.

Specified by:

getMaximumScale in interface ILayer

Specified by:

getMaximumScale in interface ILayer2

Specified by:

getMaximumScale in interface ITemporalLayer

Returns:

The maxScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumScale

public void setMaximumScale(double maxScale)
                     throws java.io.IOException,
                            AutomationException

Maximum scale (representative fraction) at which the layer will display.

Specified by:

setMaximumScale in interface ILayer

Specified by:

setMaximumScale in interface ILayer2

Specified by:

setMaximumScale in interface ITemporalLayer

Parameters:

maxScale - The maxScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isVisible

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

Indicates if the layer is currently visible.

Specified by:

isVisible in interface ILayer

Specified by:

isVisible in interface ILayer2

Specified by:

isVisible in interface ITemporalLayer

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException

Indicates if the layer is currently visible.

Specified by:

setVisible in interface ILayer

Specified by:

setVisible in interface ILayer2

Specified by:

setVisible in interface ITemporalLayer

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowTips

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

Indicates if the layer shows map tips.

Specified by:

isShowTips in interface ILayer

Specified by:

isShowTips in interface ILayer2

Specified by:

isShowTips in interface ITemporalLayer

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowTips

public void setShowTips(boolean show)
                 throws java.io.IOException,
                        AutomationException

Indicates if the layer shows map tips.

Specified by:

setShowTips in interface ILayer

Specified by:

setShowTips in interface ILayer2

Specified by:

setShowTips in interface ITemporalLayer

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTipText

public java.lang.String getTipText(double x,
                                   double y,
                                   double tolerance)
                            throws java.io.IOException,
                                   AutomationException

Map tip text at the specified location.

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:

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

AutomationException - If the ArcObject component throws an exception.

isCached

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

Indicates if the layer needs its own display cache.

Specified by:

isCached in interface ILayer

Specified by:

isCached in interface ILayer2

Specified by:

isCached in interface ITemporalLayer

Returns:

The cached

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCached

public void setCached(boolean cached)
               throws java.io.IOException,
                      AutomationException

Indicates if the layer needs its own display cache.

Specified by:

setCached in interface ILayer

Specified by:

setCached in interface ILayer2

Specified by:

setCached in interface ITemporalLayer

Parameters:

cached - The cached (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSupportedDrawPhases

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

Supported draw phases.

Specified by:

getSupportedDrawPhases in interface ILayer

Specified by:

getSupportedDrawPhases in interface ILayer2

Specified by:

getSupportedDrawPhases in interface ITemporalLayer

Returns:

The drawPhases

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws java.io.IOException,
                                     AutomationException

Spatial reference for the layer.

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:

java.io.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 java.io.IOException,
                 AutomationException

Draws the layer to the specified display for the given draw phase.

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:

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

AutomationException - If the ArcObject component throws an exception.

getTemporalReference

public ITemporalReference getTemporalReference()
                                        throws java.io.IOException,
                                               AutomationException

Defines the reference in time used to draw, identify, or perform other layer-based activities.

Specified by:

getTemporalReference in interface ITemporalLayer

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTemporalReferenceByRef

public void setTemporalReferenceByRef(ITemporalReference ppiTemporalReference)
                               throws java.io.IOException,
                                      AutomationException

Defines the reference in time used to draw, identify, or perform other layer-based activities.

Specified by:

setTemporalReferenceByRef in interface ITemporalLayer

Parameters:

ppiTemporalReference - A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTemporalLegendGroup

public ITemporalLegendGroup getTemporalLegendGroup()
                                            throws java.io.IOException,
                                                   AutomationException

Group of temporal legend classes that define the temporal intervals and symbology used by the temporal renderer.

Specified by:

getTemporalLegendGroup in interface ITemporalLayer

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ITemporalLegendGroup

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTemporalLegendGroupByRef

public void setTemporalLegendGroupByRef(ITemporalLegendGroup ppiTemporalLegendGroup)
                                 throws java.io.IOException,
                                        AutomationException

Group of temporal legend classes that define the temporal intervals and symbology used by the temporal renderer.

Specified by:

setTemporalLegendGroupByRef in interface ITemporalLayer

Parameters:

ppiTemporalLegendGroup - A reference to a com.esri.arcgis.trackinganalyst.ITemporalLegendGroup (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCacheFeatures

public void setCacheFeatures(boolean pbAreFeaturesCached)
                      throws java.io.IOException,
                             AutomationException

Controls whether Features are cached in the renderer's feature memory or are read from the feature class.

Specified by:

setCacheFeatures in interface ITemporalLayer

Parameters:

pbAreFeaturesCached - The pbAreFeaturesCached (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCacheFeatures

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

Controls whether Features are cached in the renderer's feature memory or are read from the feature class.

Specified by:

isCacheFeatures in interface ITemporalLayer

Returns:

The pbAreFeaturesCached

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureCacheWindow

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

Determines the number of features to cache if the CacheFeatures property is true.

Specified by:

getFeatureCacheWindow in interface ITemporalLayer

Returns:

The pnPercent

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureCacheWindow

public void setFeatureCacheWindow(int pnPercent)
                           throws java.io.IOException,
                                  AutomationException

Determines the number of features to cache if the CacheFeatures property is true.

Specified by:

setFeatureCacheWindow in interface ITemporalLayer

Parameters:

pnPercent - The pnPercent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRendererByRef

public void setRendererByRef(IFeatureRenderer renderer)
                      throws java.io.IOException,
                             AutomationException

Controls the temporal renderer for the layer.

Specified by:

setRendererByRef in interface IGeoFeatureLayer

Specified by:

setRendererByRef in interface ITemporalLayer

Parameters:

renderer - A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRenderer

public IFeatureRenderer getRenderer()
                             throws java.io.IOException,
                                    AutomationException

Controls the temporal renderer for the layer.

Specified by:

getRenderer in interface IGeoFeatureLayer

Specified by:

getRenderer in interface ITemporalLayer

Returns:

A reference to a com.esri.arcgis.carto.IFeatureRenderer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTemporalFieldName

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

Identifies the temporal field, which must be a field type with data that can be converted to a date value.

Specified by:

getTemporalFieldName in interface ITemporalLayer

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDisplayOnlyLastKnownEvent

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

Indicates whether to display only the last known temporal event or all events in a layer.

Specified by:

isDisplayOnlyLastKnownEvent in interface ITemporalLayer

Returns:

The pbvarLastKnownEvent

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayOnlyLastKnownEvent

public void setDisplayOnlyLastKnownEvent(boolean pbvarLastKnownEvent)
                                  throws java.io.IOException,
                                         AutomationException

Indicates whether to display only the last known temporal event or all events in a layer.

Specified by:

setDisplayOnlyLastKnownEvent in interface ITemporalLayer

Parameters:

pbvarLastKnownEvent - The pbvarLastKnownEvent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDisplayFutureEvents

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

Indicates whether or not to display future events for a real-time data layer.

Specified by:

isDisplayFutureEvents in interface ITemporalLayer

Returns:

The pbvarFutureEvents

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayFutureEvents

public void setDisplayFutureEvents(boolean pbvarFutureEvents)
                            throws java.io.IOException,
                                   AutomationException

Indicates whether or not to display future events for a real-time data layer.

Specified by:

setDisplayFutureEvents in interface ITemporalLayer

Parameters:

pbvarFutureEvents - The pbvarFutureEvents (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActionCollection

public IActionCollection getActionCollection()
                                      throws java.io.IOException,
                                             AutomationException

The collection of action objects for this temporal layer.

Specified by:

getActionCollection in interface ITemporalLayer

Returns:

A reference to a com.esri.arcgis.carto.IActionCollection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setActionCollectionByRef

public void setActionCollectionByRef(IActionCollection pVal)
                              throws java.io.IOException,
                                     AutomationException

The collection of action objects for this temporal layer.

Specified by:

setActionCollectionByRef in interface ITemporalLayer

Parameters:

pVal - A reference to a com.esri.arcgis.carto.IActionCollection (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

processActions

public void processActions(boolean bvarResetActions)
                    throws java.io.IOException,
                           AutomationException

Apply the actions, contained in the action collection, to this temporal layer.

Specified by:

processActions in interface ITemporalLayer

Parameters:

bvarResetActions - The bvarResetActions (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelativeTimeColor

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

Indicates a relative color differential based on temporal class characteristics.

Specified by:

getRelativeTimeColor in interface ITemporalLayer

Returns:

The pVal (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelativeTimeColor

public void setRelativeTimeColor(int pVal)
                          throws java.io.IOException,
                                 AutomationException

Indicates a relative color differential based on temporal class characteristics.

Specified by:

setRelativeTimeColor in interface ITemporalLayer

Parameters:

pVal - The pVal (A COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelativeTimeOperator

public ITemporalOperator getRelativeTimeOperator()
                                          throws java.io.IOException,
                                                 AutomationException

The relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer.

Specified by:

getRelativeTimeOperator in interface ITemporalLayer

Returns:

A reference to a com.esri.arcgis.geodatabaseextensions.ITemporalOperator

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelativeTimeOperator

public void setRelativeTimeOperator(ITemporalOperator pVal)
                             throws java.io.IOException,
                                    AutomationException

The relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer.

Specified by:

setRelativeTimeOperator in interface ITemporalLayer

Parameters:

pVal - A reference to a com.esri.arcgis.geodatabaseextensions.ITemporalOperator (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryTemporalExtent

public void queryTemporalExtent(java.lang.Object[] pvarStartTime,
                                java.lang.Object[] pvarEndTime)
                         throws java.io.IOException,
                                AutomationException

Obtain the start and end temporal values of the temporal layer's features.

Specified by:

queryTemporalExtent in interface ITemporalSearch

Specified by:

queryTemporalExtent in interface ITemporalLayer

Parameters:

pvarStartTime - A Variant (in/out: use single element array)

pvarEndTime - A Variant (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEventIDFieldName

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

Indicates the field containing the EventID information for the data.

Specified by:

getEventIDFieldName in interface ITemporalLayer

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

suspendIndexing

public void suspendIndexing(boolean bvarSuspend)
                     throws java.io.IOException,
                            AutomationException

This method suspends or resumes indexing on a temporal layer.

Specified by:

suspendIndexing in interface ITemporalLayer

Parameters:

bvarSuspend - The bvarSuspend (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

lastKnownOIDs

public IFeatureIDSet lastKnownOIDs(java.lang.Object varStartingTime,
                                   java.lang.Object varEndingTime)
                            throws java.io.IOException,
                                   AutomationException

Searches for the last known OIDs in the dataset.

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:

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

AutomationException - If the ArcObject component throws an exception.

lastKnownFeatures

public ICursor lastKnownFeatures(java.lang.Object varStartingTime,
                                 java.lang.Object varEndingTime)
                          throws java.io.IOException,
                                 AutomationException

Searches for last known features in the dataset.

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:

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

AutomationException - If the ArcObject component throws an exception.

getLanguageLocaleID

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

Language ID used to parse dates from string values.

Specified by:

getLanguageLocaleID in interface ITimeRegionalSettings

Returns:

The plLanguageLocaleID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLanguageLocaleID

public void setLanguageLocaleID(int plLanguageLocaleID)
                         throws java.io.IOException,
                                AutomationException

Language ID used to parse dates from string values.

Specified by:

setLanguageLocaleID in interface ITimeRegionalSettings

Parameters:

plLanguageLocaleID - The plLanguageLocaleID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeStyleFormat

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

Time formatting style used to parse the time portion of a time string in the temporal column.

Specified by:

getTimeStyleFormat in interface ITimeRegionalSettings

Returns:

The pbstrTimeStyleFormat

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeStyleFormat

public void setTimeStyleFormat(java.lang.String pbstrTimeStyleFormat)
                        throws java.io.IOException,
                               AutomationException

Time formatting style used to parse the time portion of a time string in the temporal column.

Specified by:

setTimeStyleFormat in interface ITimeRegionalSettings

Parameters:

pbstrTimeStyleFormat - The pbstrTimeStyleFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDateStyleFormat

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

Date style used when parsing the date portion of a time string in the temporal column.

Specified by:

getDateStyleFormat in interface ITimeRegionalSettings

Returns:

The pbstrDateStyleFormat

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDateStyleFormat

public void setDateStyleFormat(java.lang.String pbstrDateStyleFormat)
                        throws java.io.IOException,
                               AutomationException

Date style used when parsing the date portion of a time string in the temporal column.

Specified by:

setDateStyleFormat in interface ITimeRegionalSettings

Parameters:

pbstrDateStyleFormat - The pbstrDateStyleFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAMDesignator

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

String for the AM designator.

Specified by:

getAMDesignator in interface ITimeRegionalSettings

Returns:

The pbstrAMDesignator

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAMDesignator

public void setAMDesignator(java.lang.String pbstrAMDesignator)
                     throws java.io.IOException,
                            AutomationException

String for the AM designator.

Specified by:

setAMDesignator in interface ITimeRegionalSettings

Parameters:

pbstrAMDesignator - The pbstrAMDesignator (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPMDesignator

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

String for the PM designator.

Specified by:

getPMDesignator in interface ITimeRegionalSettings

Returns:

The pbstrPMDesignator

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPMDesignator

public void setPMDesignator(java.lang.String pbstrPMDesignator)
                     throws java.io.IOException,
                            AutomationException

String for the PM designator.

Specified by:

setPMDesignator in interface ITimeRegionalSettings

Parameters:

pbstrPMDesignator - The pbstrPMDesignator (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isScaleRangeReadOnly

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

Indicates if the minimum and maximum scale range values are read-only.

Specified by:

isScaleRangeReadOnly in interface ILayer2

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAreaOfInterest

public void setAreaOfInterest(IEnvelope aoi)
                       throws java.io.IOException,
                              AutomationException

The default area of interest for the layer.

Specified by:

setAreaOfInterest in interface ILayer2

Parameters:

aoi - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLegendGroupCount

public int getLegendGroupCount()
                        throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

getSmallImage

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

Small image that represents the layer.

Specified by:

getSmallImage in interface ILayerInfo

Returns:

The hBitmap (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSmallSelectedImage

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

Small image that represents the layer when it is selected.

Specified by:

getSmallSelectedImage in interface ILayerInfo

Returns:

The hBitmap (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLargeImage

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

Large image that represents the layer.

Specified by:

getLargeImage in interface ILayerInfo

Returns:

The hBitmap (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLargeSelectedImage

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

Large image that represents the layer when it is selected.

Specified by:

getLargeSelectedImage in interface ILayerInfo

Returns:

The hBitmap (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelFieldName

public void setLabelFieldName(java.lang.String pbstrFieldName)
                       throws java.io.IOException,
                              AutomationException

Name of the field whose contents will be used as the tracking label for the layer.

Specified by:

setLabelFieldName in interface ITrackingLayerLabels

Parameters:

pbstrFieldName - The pbstrFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelFieldName

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

Name of the field whose contents will be used as the tracking label for the layer.

Specified by:

getLabelFieldName in interface ITrackingLayerLabels

Returns:

The pbstrFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelFeatures

public void setLabelFeatures(boolean pbvarLabelFeatures)
                      throws java.io.IOException,
                             AutomationException

Indicates whether or not feature labels will appear as events draw to the map display.

Specified by:

setLabelFeatures in interface ITrackingLayerLabels

Parameters:

pbvarLabelFeatures - The pbvarLabelFeatures (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLabelFeatures

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

Indicates whether or not feature labels will appear as events draw to the map display.

Specified by:

isLabelFeatures in interface ITrackingLayerLabels

Returns:

The pbvarLabelFeatures

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelOffset

public short getPixelOffset()
                     throws java.io.IOException,
                            AutomationException

Indicates amount of offset between feature and label as they draw to the map display.

Specified by:

getPixelOffset in interface ITrackingLayerLabels

Returns:

The pnPixelOffset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelOffset

public void setPixelOffset(short pnPixelOffset)
                    throws java.io.IOException,
                           AutomationException

Indicates amount of offset between feature and label as they draw to the map display.

Specified by:

setPixelOffset in interface ITrackingLayerLabels

Parameters:

pnPixelOffset - The pnPixelOffset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOffsetAngle

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

Indicates angle of offset for labels as they draw next to events on the map display.

Specified by:

getOffsetAngle in interface ITrackingLayerLabels

Returns:

The pdOffsetAngle

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOffsetAngle

public void setOffsetAngle(double pdOffsetAngle)
                    throws java.io.IOException,
                           AutomationException

Indicates angle of offset for labels as they draw next to events on the map display.

Specified by:

setOffsetAngle in interface ITrackingLayerLabels

Parameters:

pdOffsetAngle - The pdOffsetAngle (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTextSymbol

public ITextSymbol getTextSymbol()
                          throws java.io.IOException,
                                 AutomationException

Indicates settings for text symbol appearance as it appears as a label on the map display.

Specified by:

getTextSymbol in interface ITrackingLayerLabels

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTextSymbolByRef

public void setTextSymbolByRef(ITextSymbol ppiTextSymbol)
                        throws java.io.IOException,
                               AutomationException

Indicates settings for text symbol appearance as it appears as a label on the map display.

Specified by:

setTextSymbolByRef in interface ITrackingLayerLabels

Parameters:

ppiTextSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom)
                throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

getRendererPropertyPageClassID

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

Class id of the property page for the renderer.

Specified by:

getRendererPropertyPageClassID in interface IGeoFeatureLayer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRendererPropertyPageClassID

public void setRendererPropertyPageClassID(IUID cLSID)
                                    throws java.io.IOException,
                                           AutomationException

Class id of the property page for the renderer.

Specified by:

setRendererPropertyPageClassID in interface IGeoFeatureLayer

Parameters:

cLSID - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDisplayAnnotation

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

Indicates if the layer displays annotation.

Specified by:

isDisplayAnnotation in interface IGeoFeatureLayer

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayAnnotation

public void setDisplayAnnotation(boolean value)
                          throws java.io.IOException,
                                 AutomationException

Indicates if the layer displays annotation.

Specified by:

setDisplayAnnotation in interface IGeoFeatureLayer

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAnnotationPropertiesID

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

The UID used for annotation properties.

Specified by:

getAnnotationPropertiesID in interface IGeoFeatureLayer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAnnotationPropertiesIDByRef

public void setAnnotationPropertiesIDByRef(IUID uid)
                                    throws java.io.IOException,
                                           AutomationException

The UID used for annotation properties.

Specified by:

setAnnotationPropertiesIDByRef in interface IGeoFeatureLayer

Parameters:

uid - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAnnotationProperties

public IAnnotateLayerPropertiesCollection getAnnotationProperties()
                                                           throws java.io.IOException,
                                                                  AutomationException

Annotation properties.

Specified by:

getAnnotationProperties in interface IGeoFeatureLayer

Returns:

A reference to a com.esri.arcgis.carto.IAnnotateLayerPropertiesCollection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAnnotationProperties

public void setAnnotationProperties(IAnnotateLayerPropertiesCollection props)
                             throws java.io.IOException,
                                    AutomationException

Annotation properties.

Specified by:

setAnnotationProperties in interface IGeoFeatureLayer

Parameters:

props - A reference to a com.esri.arcgis.carto.IAnnotateLayerPropertiesCollection (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCurrentMapLevel

public void setCurrentMapLevel(int rhs1)
                        throws java.io.IOException,
                               AutomationException

Current map level for drawing symbols.

Specified by:

setCurrentMapLevel in interface IGeoFeatureLayer

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExclusionSet

public IFeatureIDSet getExclusionSet()
                              throws java.io.IOException,
                                     AutomationException

The set of features that are excluded from drawing.

Specified by:

getExclusionSet in interface IGeoFeatureLayer

Returns:

A reference to a com.esri.arcgis.carto.IFeatureIDSet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExclusionSetByRef

public void setExclusionSetByRef(IFeatureIDSet fIDs)
                          throws java.io.IOException,
                                 AutomationException

The set of features that are excluded from drawing.

Specified by:

setExclusionSetByRef in interface IGeoFeatureLayer

Parameters:

fIDs - A reference to a com.esri.arcgis.carto.IFeatureIDSet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayFeatureClass

public IFeatureClass getDisplayFeatureClass()
                                     throws java.io.IOException,
                                            AutomationException

Feature class used for display operations (may include joined fields).

Specified by:

getDisplayFeatureClass in interface IGeoFeatureLayer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

searchDisplayFeatures

public IFeatureCursor searchDisplayFeatures(IQueryFilter queryFilter,
                                            boolean recycling)
                                     throws java.io.IOException,
                                            AutomationException

Creates a cursor from the display feature class based upon the search criteria.

Specified by:

searchDisplayFeatures in interface IGeoFeatureLayer

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:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureClass

public IFeatureClass getFeatureClass()
                              throws java.io.IOException,
                                     AutomationException

The layer's feature class.

Specified by:

getFeatureClass in interface IFeatureLayer

Specified by:

getFeatureClass in interface IFeatureLayer2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureClassByRef

public void setFeatureClassByRef(IFeatureClass fclass)
                          throws java.io.IOException,
                                 AutomationException

The layer's feature class.

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:

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

AutomationException - If the ArcObject component throws an exception.

getDataSourceType

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

Data source type.

Specified by:

getDataSourceType in interface IFeatureLayer

Specified by:

getDataSourceType in interface IFeatureLayer2

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDataSourceType

public void setDataSourceType(java.lang.String text)
                       throws java.io.IOException,
                              AutomationException

Data source type.

Specified by:

setDataSourceType in interface IFeatureLayer

Specified by:

setDataSourceType in interface IFeatureLayer2

Parameters:

text - The text (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayField

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

Primary display field.

Specified by:

getDisplayField in interface IFeatureLayer

Specified by:

getDisplayField in interface IFeatureLayer2

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayField

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

Primary display field.

Specified by:

setDisplayField in interface IFeatureLayer

Specified by:

setDisplayField in interface IFeatureLayer2

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSelectable

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

Indicates if layer is selectable.

Specified by:

isSelectable in interface IFeatureLayer

Specified by:

isSelectable in interface IFeatureLayer2

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSelectable

public void setSelectable(boolean value)
                   throws java.io.IOException,
                          AutomationException

Indicates if layer is selectable.

Specified by:

setSelectable in interface IFeatureLayer

Specified by:

setSelectable in interface IFeatureLayer2

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

search

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

Creates a cursor based upon the search criteria.

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:

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

AutomationException - If the ArcObject component throws an exception.

isScaleSymbols

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

Indicates if symbols are scaled for the layer.

Specified by:

isScaleSymbols in interface IFeatureLayer

Specified by:

isScaleSymbols in interface IFeatureLayer2

Returns:

The scale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setScaleSymbols

public void setScaleSymbols(boolean scale)
                     throws java.io.IOException,
                            AutomationException

Indicates if symbols are scaled for the layer.

Specified by:

setScaleSymbols in interface IFeatureLayer

Specified by:

setScaleSymbols in interface IFeatureLayer2

Parameters:

scale - The scale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws java.io.IOException,
                                     AutomationException

The selected set of features.

Specified by:

getSelectionSet in interface IFeatureSelection

Specified by:

getSelectionSet in interface ITableSelection

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet selectionSet)
                          throws java.io.IOException,
                                 AutomationException

The selected set of features.

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:

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

AutomationException - If the ArcObject component throws an exception.

getCombinationMethod

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

Combination method for the selection.

Specified by:

getCombinationMethod in interface IFeatureSelection

Returns:

A com.esri.arcgis.carto.esriSelectionResultEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCombinationMethod

public void setCombinationMethod(int method)
                          throws java.io.IOException,
                                 AutomationException

Combination method for the selection.

Specified by:

setCombinationMethod in interface IFeatureSelection

Parameters:

method - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBufferDistance

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

Buffer distance used for the selection.

Specified by:

getBufferDistance in interface IFeatureSelection

Returns:

The distance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBufferDistance

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

Buffer distance used for the selection.

Specified by:

setBufferDistance in interface IFeatureSelection

Parameters:

distance - The distance (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSetSelectionSymbol

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

Indicates if the selected set of features is drawn using the SelectionSymbol.

Specified by:

isSetSelectionSymbol in interface IFeatureSelection

Returns:

The setSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSetSelectionSymbol

public void setSetSelectionSymbol(boolean setSymbol)
                           throws java.io.IOException,
                                  AutomationException

Indicates if the selected set of features is drawn using the SelectionSymbol.

Specified by:

setSetSelectionSymbol in interface IFeatureSelection

Parameters:

setSymbol - The setSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectionColor

public IColor getSelectionColor()
                         throws java.io.IOException,
                                AutomationException

Selection color. (used when SetSelectionSymbol = FALSE).

Specified by:

getSelectionColor in interface IFeatureSelection

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSelectionColorByRef

public void setSelectionColorByRef(IColor color)
                            throws java.io.IOException,
                                   AutomationException

Selection color. (used when SetSelectionSymbol = FALSE).

Specified by:

setSelectionColorByRef in interface IFeatureSelection

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectionSymbol

public ISymbol getSelectionSymbol()
                           throws java.io.IOException,
                                  AutomationException

Selection symbol.

Specified by:

getSelectionSymbol in interface IFeatureSelection

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSelectionSymbolByRef

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

Selection symbol.

Specified by:

setSelectionSymbolByRef in interface IFeatureSelection

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add

public void add(IFeature feature)
         throws java.io.IOException,
                AutomationException

Adds a feature to the selection set.

Specified by:

add in interface IFeatureSelection

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Throws:

java.io.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 java.io.IOException,
                           AutomationException

Selects features based upon the specifed criteria and combination method.

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:

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

AutomationException - If the ArcObject component throws an exception.

clear

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

Clears the selection.

Specified by:

clear in interface IFeatureSelection

Specified by:

clear in interface ITableSelection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectionChanged

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

Fires the features layer update event. Required when SelectionSet changes.

Specified by:

selectionChanged in interface IFeatureSelection

Specified by:

selectionChanged in interface ITableSelection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefinitionExpression

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

Definition query expression for the existing layer.

Specified by:

getDefinitionExpression in interface IFeatureLayerDefinition

Returns:

The expression

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefinitionExpression

public void setDefinitionExpression(java.lang.String expression)
                             throws java.io.IOException,
                                    AutomationException

Definition query expression for the existing layer.

Specified by:

setDefinitionExpression in interface IFeatureLayerDefinition

Parameters:

expression - The expression (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefinitionSelectionSet

public ISelectionSet getDefinitionSelectionSet()
                                        throws java.io.IOException,
                                               AutomationException

The selection set that defines the subset of features in a selection layer.

Specified by:

getDefinitionSelectionSet in interface IFeatureLayerDefinition

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createSelectionLayer

public IFeatureLayer createSelectionLayer(java.lang.String layerName,
                                          boolean useCurrentSelection,
                                          java.lang.String joinTableNames,
                                          java.lang.String expression)
                                   throws java.io.IOException,
                                          AutomationException

Creates a new feature layer from the existing layer based on the current selection and the specified query expression.

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:

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

AutomationException - If the ArcObject component throws an exception.

getRelationshipClass

public IRelationshipClass getRelationshipClass()
                                        throws java.io.IOException,
                                               AutomationException

The current relationship class used to display related fields.

Specified by:

getRelationshipClass in interface IFeatureLayerDefinition

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelationshipClassByRef

public void setRelationshipClassByRef(IRelationshipClass relClass)
                               throws java.io.IOException,
                                      AutomationException

The current relationship class used to display related fields.

Specified by:

setRelationshipClassByRef in interface IFeatureLayerDefinition

Parameters:

relClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

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

The spatial reference of the GeoDataset.

Remarks

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSpatialReference in interface IGeoDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

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

The extent of the GeoDataset.

Remarks

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

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

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtent in interface IGeoDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom,
                       ITrackCancel pTrackCancel)
                throws java.io.IOException,
                       AutomationException

Identifies objects at the specified location.

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:

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

AutomationException - If the ArcObject component throws an exception.

setScale

public void setScale(double rhs1)
              throws java.io.IOException,
                     AutomationException

The current scale of the display.

Specified by:

setScale in interface IIdentify2

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addRow

public void addRow(IRow row)
            throws java.io.IOException,
                   AutomationException

Adds a row to the selection set (honoring the current combination method).

Specified by:

addRow in interface ITableSelection

Parameters:

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

Throws:

java.io.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 java.io.IOException,
                       AutomationException

Selects rows based upon the specified criteria and combination method.

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:

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

AutomationException - If the ArcObject component throws an exception.

find

public IArray find(java.lang.String search,
                   boolean contains,
                   java.lang.Object fields,
                   ITrackCancel trackCancel)
            throws java.io.IOException,
                   AutomationException

Finds the specified search string in the given attribute fields.

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:

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

AutomationException - If the ArcObject component throws an exception.

getFindFields

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

The attribute fields.

Specified by:

getFindFields in interface IFind

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFindDisplayField

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

The display field.

Specified by:

getFindDisplayField in interface IFind

Returns:

The field

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayTable

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

The display table.

Specified by:

getDisplayTable in interface IDisplayTable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

searchDisplayTable

public ICursor searchDisplayTable(IQueryFilter pQueryFilter,
                                  boolean recycling)
                           throws java.io.IOException,
                                  AutomationException

Creates a cursor from the display table based upon the search criteria.

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:

java.io.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 java.io.IOException,
                                        AutomationException

Creates a selection set from the display table based upon the search criteria.

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:

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

AutomationException - If the ArcObject component throws an exception.

getDisplaySelectionSet

public ISelectionSet getDisplaySelectionSet()
                                     throws java.io.IOException,
                                            AutomationException

The selected set of rows from the display table.

Specified by:

getDisplaySelectionSet in interface IDisplayTable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getShapeType

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

The layer's shape type.

Specified by:

getShapeType in interface IFeatureLayer2

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

expandRegionForSymbols

public void expandRegionForSymbols(IDisplay display,
                                   IGeometry region)
                            throws java.io.IOException,
                                   AutomationException

Expands the given geometry by an amount that will include the layer's symbology for the given display.

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:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(java.lang.Object pUnk)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver can apply the given object at any given time.

Specified by:

applies in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

The applies

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(java.lang.Object pUnk)
                 throws java.io.IOException,
                        AutomationException

Indicates if the receiver can apply the given object at that particular moment.

Specified by:

canApply in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

The canApply

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrent

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

The object currently being used.

Specified by:

getCurrent in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

apply

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

Applies the given property to the receiver and returns the old object.

Specified by:

apply in interface IPropertySupport

Parameters:

newObject - A reference to another Object (IUnknown) (in)

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldCount

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

The number of fields.

Specified by:

getFieldCount in interface ILayerFields

Specified by:

getFieldCount in interface ITableFields

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getField

public IField getField(int index)
                throws java.io.IOException,
                       AutomationException

The field at the specified index.

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:

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

AutomationException - If the ArcObject component throws an exception.

getFieldInfo

public IFieldInfo getFieldInfo(int index)
                        throws java.io.IOException,
                               AutomationException

Extended field information for the field at the specified index.

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:

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

AutomationException - If the ArcObject component throws an exception.

findField

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

Returns the index of the field with the specified name.

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:

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

AutomationException - If the ArcObject component throws an exception.

getAttributeTable

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

The attribute table.

Specified by:

getAttributeTable in interface IAttributeTable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createRow

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

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

Specified by:

createRow in interface ITable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRow

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

The row from the database with the specified object ID.

Specified by:

getRow in interface ITable

Parameters:

oID - The oID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRows

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

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

Specified by:

getRows in interface ITable

Parameters:

oids - A Variant (in)

recycling - The recycling (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createRowBuffer

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

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

Specified by:

createRowBuffer in interface ITable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateSearchedRows

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

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

Specified by:

updateSearchedRows in interface ITable

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteSearchedRows

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

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

Specified by:

deleteSearchedRows in interface ITable

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rowCount

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

The number of Rows selected by the specified query.

Specified by:

rowCount in interface ITable

Parameters:

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

Returns:

The numRows

Throws:

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

AutomationException - If the ArcObject component throws an exception.

ITable_search

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

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

Specified by:

ITable_search in interface ITable

Parameters:

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

recycling - The recycling (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

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

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

Specified by:

update in interface ITable

Parameters:

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

recycling - The recycling (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insert

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

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

Specified by:

insert in interface ITable

Parameters:

useBuffering - The useBuffering (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

select

public ISelectionSet select(IQueryFilter queryFilter,
                            int selType,
                            int selOption,
                            IWorkspace selectionContainer)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:

select in interface ITable

Parameters:

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

selType - A com.esri.arcgis.geodatabase.esriSelectionType constant (in)

selOption - A com.esri.arcgis.geodatabase.esriSelectionOption constant (in)

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFields

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

The fields collection for this object class.

Specified by:

getFields in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIndexes

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

The indexes collection for this object class.

Specified by:

getIndexes in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addField

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

Adds a field to this object class.

Specified by:

addField in interface IClass

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteField

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

Deletes a field from this object class.

Specified by:

deleteField in interface IClass

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addIndex

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

Adds an index to this object class.

Specified by:

addIndex in interface IClass

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteIndex

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

Deletes an index from this object class.

Specified by:

deleteIndex in interface IClass

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasOID

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

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

Specified by:

isHasOID in interface IClass

Returns:

The hasOID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

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

The name of the field corresponding to the OID.

Specified by:

getOIDFieldName in interface IClass

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCLSID

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

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

Specified by:

getCLSID in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEXTCLSID

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

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

Specified by:

getEXTCLSID in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtension

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

The extension for this object class.

Specified by:

getExtension in interface IClass

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtensionProperties

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

The extension properties for this object class.

Specified by:

getExtensionProperties in interface IClass

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtensionCount

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

Number of extensions.

Specified by:

getExtensionCount in interface ILayerExtensions

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtension

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

The extension at the specified index.

Specified by:

getExtension in interface ILayerExtensions

Parameters:

index - The index (in)

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addExtension

public void addExtension(java.lang.Object ext)
                  throws java.io.IOException,
                         AutomationException

Adds a new extension.

Specified by:

addExtension in interface ILayerExtensions

Parameters:

ext - A reference to another Object (IUnknown) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeExtension

public void removeExtension(int index)
                     throws java.io.IOException,
                            AutomationException

Removes the specified extension.

Specified by:

removeExtension in interface ILayerExtensions

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUsesFilter

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

Indicates if the current object draws using a filter.

Specified by:

isUsesFilter in interface IDisplayAdmin

Returns:

The usesFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDrawingPropsDirty

public boolean isDrawingPropsDirty()
                            throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

setDrawingPropsDirty

public void setDrawingPropsDirty(boolean dirty)
                          throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

getFullName

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

The associated name object.

Specified by:

getFullName in interface IDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBrowseName

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

The browse name of the dataset.

Specified by:

getBrowseName in interface IDataset

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBrowseName

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

The browse name of the dataset.

Specified by:

setBrowseName in interface IDataset

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

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

The type of the Dataset.

Specified by:

getType in interface IDataset

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCategory

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

The category of the dataset.

Specified by:

getCategory in interface IDataset

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubsets

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

Datasets contained within this dataset.

Specified by:

getSubsets in interface IDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspace

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

The workspace containing this dataset.

Specified by:

getWorkspace in interface IDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPropertySet

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

The set of properties for the dataset.

Specified by:

getPropertySet in interface IDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canCopy

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

True if this dataset can be copied.

Specified by:

canCopy in interface IDataset

Returns:

The canCopy

Throws:

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

AutomationException - If the ArcObject component throws an exception.

copy

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

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

Specified by:

copy in interface IDataset

Parameters:

copyName - The copyName (in)

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canDelete

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

True if this dataset can be deleted.

Specified by:

canDelete in interface IDataset

Returns:

The canDelete

Throws:

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

AutomationException - If the ArcObject component throws an exception.

delete

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

Deletes this dataset.

Specified by:

delete in interface IDataset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canRename

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

True if this dataset can be renamed.

Specified by:

canRename in interface IDataset

Returns:

The canRename

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rename

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

Renames this Dataset.

Specified by:

rename in interface IDataset

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerWeight

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

Default layer position.

Specified by:

getLayerWeight in interface ILayerPosition

Returns:

The layerWeight

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLayerWeight

public void setLayerWeight(double layerWeight)
                    throws java.io.IOException,
                           AutomationException

Default layer position.

Specified by:

setLayerWeight in interface ILayerPosition

Parameters:

layerWeight - The layerWeight (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapLevel

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

Current map level for drawing multi-level symbols.

Specified by:

getMapLevel in interface IMapLevel

Returns:

The mapLevel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapLevel

public void setMapLevel(int mapLevel)
                 throws java.io.IOException,
                        AutomationException

Current map level for drawing multi-level symbols.

Specified by:

setMapLevel in interface IMapLevel

Parameters:

mapLevel - The mapLevel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataSourceName

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

Name of the data object for the layer.

Specified by:

getDataSourceName in interface IDataLayer

Specified by:

getDataSourceName in interface IDataLayer2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDataSourceName

public void setDataSourceName(IName name)
                       throws java.io.IOException,
                              AutomationException

Name of the data object for the layer.

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:

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

AutomationException - If the ArcObject component throws an exception.

isDataSourceSupported

public boolean isDataSourceSupported(IName name)
                              throws java.io.IOException,
                                     AutomationException

Indicates if the specified data object name is supported by the layer.

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:

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

AutomationException - If the ArcObject component throws an exception.

connect

public boolean connect(IName pOptRepairName)
                throws java.io.IOException,
                       AutomationException

Connects the layer to its data source. An optional name object can be specified to aid in repairing a lost connection.

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:

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

AutomationException - If the ArcObject component throws an exception.

getRelativeBase

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

Base path used when storing relative path names.

Specified by:

getRelativeBase in interface IDataLayer

Specified by:

getRelativeBase in interface IDataLayer2

Returns:

The basePath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelativeBase

public void setRelativeBase(java.lang.String basePath)
                     throws java.io.IOException,
                            AutomationException

Base path used when storing relative path names.

Specified by:

setRelativeBase in interface IDataLayer

Specified by:

setRelativeBase in interface IDataLayer2

Parameters:

basePath - The basePath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

disconnect

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

Disconnects the data from the layer.

Specified by:

disconnect in interface IDataLayer2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

inWorkspace

public boolean inWorkspace(IWorkspace workspace)
                    throws java.io.IOException,
                           AutomationException

Returns TRUE if the layer is in the specified workspace.

Specified by:

inWorkspace in interface IDataLayer2

Parameters:

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

Returns:

The inWorkspace

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentZone

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

The current Time Zone.

Specified by:

getCurrentZone in interface ITimeZone

Returns:

The pbstrCurrentZone

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCurrentZone

public void setCurrentZone(java.lang.String pbstrCurrentZone)
                    throws java.io.IOException,
                           AutomationException

The current Time Zone.

Specified by:

setCurrentZone in interface ITimeZone

Parameters:

pbstrCurrentZone - The pbstrCurrentZone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getZoneList

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

List of time zones.

Specified by:

getZoneList in interface ITimeZone

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAdjustForDaylightSavings

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

Indicates whether or not to Adjust For Daylight Savings.

Specified by:

isAdjustForDaylightSavings in interface ITimeZone

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAdjustForDaylightSavings

public void setAdjustForDaylightSavings(boolean pVal)
                                 throws java.io.IOException,
                                        AutomationException

Indicates whether or not to Adjust For Daylight Savings.

Specified by:

setAdjustForDaylightSavings in interface ITimeZone

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeZoneXML

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

The XML representation of a TimeZone.

Specified by:

getTimeZoneXML in interface ITimeZone

Returns:

The pbstrXML

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeZoneXML

public void setTimeZoneXML(java.lang.String pbstrXML)
                    throws java.io.IOException,
                           AutomationException

The XML representation of a TimeZone.

Specified by:

setTimeZoneXML in interface ITimeZone

Parameters:

pbstrXML - The pbstrXML (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

showPropertySheet

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

Show the property sheet.

Specified by:

showPropertySheet in interface ILayerPropertySheet

Returns:

The ok

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLastMinimumScale

public double getLastMinimumScale()
                           throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

getLastMaximumScale

public double getLastMaximumScale()
                           throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

ILayerGeneralProperties_getLayerDescription

public java.lang.String ILayerGeneralProperties_getLayerDescription()
                                                             throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

setLayerDescription

public void setLayerDescription(java.lang.String text)
                         throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

isDynamicLayerDirty

public boolean isDynamicLayerDirty(int dynamicDrawPhase)
                            throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

setDynamicLayerDirty

public void setDynamicLayerDirty(int dynamicDrawPhase,
                                 boolean dirty)
                          throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

getDynamicRecompileRate

public int getDynamicRecompileRate()
                            throws java.io.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:

java.io.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 java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

getDrawType

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

The custom draw method.

Specified by:

getDrawType in interface ICustomGlobeLayer

Returns:

A com.esri.arcgis.globecore.esriGlobeCustomDrawType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseCache

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

The option to use Globe's disk caching.

Specified by:

isUseCache in interface ICustomGlobeLayer

Returns:

The pbUseCache

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumCellSize

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

For rasterized types, defines highest resolution. Zero value indicates that globe-generated default value should be used.

Specified by:

getMinimumCellSize in interface ICustomGlobeLayer

Returns:

The pMinCellSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbologyScalingFactor

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

The symbol scale factor for the custom rasterized type.

Specified by:

getSymbologyScalingFactor in interface ICustomGlobeLayer

Returns:

The pMetersPerPoint

Throws:

java.io.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 java.io.IOException,
                    AutomationException

Gets a rasterized data tile for the given globe tesselation coordinates.

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:

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

AutomationException - If the ArcObject component throws an exception.

drawImmediate

public void drawImmediate(IGlobeViewer pGlobeViewer)
                   throws java.io.IOException,
                          AutomationException

For custom OpenGL layers, perform immediate drawing.

Specified by:

drawImmediate in interface ICustomGlobeLayer

Parameters:

pGlobeViewer - A reference to a com.esri.arcgis.globecore.IGlobeViewer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hit

public void hit(int hitObjectID,
                IHit3D pHit3D)
         throws java.io.IOException,
                AutomationException

The layer is hit by a picking operation.

Specified by:

hit in interface ICustomGlobeLayer

Parameters:

hitObjectID - The hitObjectID (in)

pHit3D - A reference to a com.esri.arcgis.analyst3d.IHit3D (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHandlesLocalOrigin

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

The option to use a local coordinate system origin for high precision drawing.

Specified by:

isHandlesLocalOrigin in interface ICustomGlobeLayer

Returns:

The pbHandlesLocalOrigin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLocalOrigin

public void setLocalOrigin(_WKSPointZ rhs1)
                    throws java.io.IOException,
                           AutomationException

The local coordinate system origin for high precision drawing.

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:

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

AutomationException - If the ArcObject component throws an exception.

isDrawLeaderLines

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

Indicates whether to draw leader lines from the symbol to the surface.

Specified by:

isDrawLeaderLines in interface ITrackingGlobeLayerLeaderLines

Returns:

The draw

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDrawLeaderLines

public void setDrawLeaderLines(boolean draw)
                        throws java.io.IOException,
                               AutomationException

Indicates whether to draw leader lines from the symbol to the surface.

Specified by:

setDrawLeaderLines in interface ITrackingGlobeLayerLeaderLines

Parameters:

draw - The draw (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLeaderLinesUseSymbolColor

public boolean isLeaderLinesUseSymbolColor()
                                    throws java.io.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.

Specified by:

isLeaderLinesUseSymbolColor in interface ITrackingGlobeLayerLeaderLines

Returns:

The useSymbolColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLeaderLinesUseSymbolColor

public void setLeaderLinesUseSymbolColor(boolean useSymbolColor)
                                  throws java.io.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.

Specified by:

setLeaderLinesUseSymbolColor in interface ITrackingGlobeLayerLeaderLines

Parameters:

useSymbolColor - The useSymbolColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLeaderLinesColor

public IColor getLeaderLinesColor()
                           throws java.io.IOException,
                                  AutomationException

Specifies the color of the leader line.

Specified by:

getLeaderLinesColor in interface ITrackingGlobeLayerLeaderLines

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLeaderLinesColor

public void setLeaderLinesColor(IColor color)
                         throws java.io.IOException,
                                AutomationException

Specifies the color of the leader line.

Specified by:

setLeaderLinesColor in interface ITrackingGlobeLayerLeaderLines

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElevatedLinesStyle

public int getElevatedLinesStyle()
                          throws java.io.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.

Specified by:

getElevatedLinesStyle in interface ITrackingGlobeLayerLeaderLines

Returns:

A com.esri.arcgis.trackinganalyst.esriTrackingElevatedLineStyle constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setElevatedLinesStyle

public void setElevatedLinesStyle(int style)
                           throws java.io.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.

Specified by:

setElevatedLinesStyle in interface ITrackingGlobeLayerLeaderLines

Parameters:

style - A com.esri.arcgis.trackinganalyst.esriTrackingElevatedLineStyle constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isElevatedLinesUseSymbolColor

public boolean isElevatedLinesUseSymbolColor()
                                      throws java.io.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.

Specified by:

isElevatedLinesUseSymbolColor in interface ITrackingGlobeLayerLeaderLines

Returns:

The useSymbolColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setElevatedLinesUseSymbolColor

public void setElevatedLinesUseSymbolColor(boolean useSymbolColor)
                                    throws java.io.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.

Specified by:

setElevatedLinesUseSymbolColor in interface ITrackingGlobeLayerLeaderLines

Parameters:

useSymbolColor - The useSymbolColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isElevatedLinesPointUseSymbolColor

public boolean isElevatedLinesPointUseSymbolColor()
                                           throws java.io.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.

Specified by:

isElevatedLinesPointUseSymbolColor in interface ITrackingGlobeLayerLeaderLines

Returns:

The useSymbolColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setElevatedLinesPointUseSymbolColor

public void setElevatedLinesPointUseSymbolColor(boolean useSymbolColor)
                                         throws java.io.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.

Specified by:

setElevatedLinesPointUseSymbolColor in interface ITrackingGlobeLayerLeaderLines

Parameters:

useSymbolColor - The useSymbolColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElevatedLinesColor

public IColor getElevatedLinesColor()
                             throws java.io.IOException,
                                    AutomationException

Specifies the color of the elevated lines.

Specified by:

getElevatedLinesColor in interface ITrackingGlobeLayerLeaderLines

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setElevatedLinesColor

public void setElevatedLinesColor(IColor color)
                           throws java.io.IOException,
                                  AutomationException

Specifies the color of the elevated lines.

Specified by:

setElevatedLinesColor in interface ITrackingGlobeLayerLeaderLines

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElevatedLinesLength

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

Indicates the length of the elevated lines.

Specified by:

getElevatedLinesLength in interface ITrackingGlobeLayerLeaderLines

Returns:

The length

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setElevatedLinesLength

public void setElevatedLinesLength(double length)
                            throws java.io.IOException,
                                   AutomationException

Indicates the length of the elevated lines.

Specified by:

setElevatedLinesLength in interface ITrackingGlobeLayerLeaderLines

Parameters:

length - The length (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElevatedLinesLengthUnits

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

Indicates the units for the length of the elevated line.

Specified by:

getElevatedLinesLengthUnits in interface ITrackingGlobeLayerLeaderLines

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setElevatedLinesLengthUnits

public void setElevatedLinesLengthUnits(int lengthUnits)
                                 throws java.io.IOException,
                                        AutomationException

Indicates the units for the length of the elevated line.

Specified by:

setElevatedLinesLengthUnits in interface ITrackingGlobeLayerLeaderLines

Parameters:

lengthUnits - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElevatedLinesWidth

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

Indicates the width of the elevated lines in pixels.

Specified by:

getElevatedLinesWidth in interface ITrackingGlobeLayerLeaderLines

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setElevatedLinesWidth

public void setElevatedLinesWidth(double width)
                           throws java.io.IOException,
                                  AutomationException

Indicates the width of the elevated lines in pixels.

Specified by:

setElevatedLinesWidth in interface ITrackingGlobeLayerLeaderLines

Parameters:

width - The width (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLeaderLinesWidth

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

Indicates the width of the leader lines in pixels.

Specified by:

getLeaderLinesWidth in interface ITrackingGlobeLayerLeaderLines

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLeaderLinesWidth

public void setLeaderLinesWidth(double width)
                         throws java.io.IOException,
                                AutomationException

Indicates the width of the leader lines in pixels.

Specified by:

setLeaderLinesWidth in interface ITrackingGlobeLayerLeaderLines

Parameters:

width - The width (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElevatedLinesPointWidth

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

Indicates the width of the point located at the base of the elevated lines.

Specified by:

getElevatedLinesPointWidth in interface ITrackingGlobeLayerLeaderLines

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setElevatedLinesPointWidth

public void setElevatedLinesPointWidth(double width)
                                throws java.io.IOException,
                                       AutomationException

Indicates the width of the point located at the base of the elevated lines.

Specified by:

setElevatedLinesPointWidth in interface ITrackingGlobeLayerLeaderLines

Parameters:

width - The width (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSmoothElevatedLinesPoint

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

Indicates whether to smooth the point located at the base of the elevated lines.

Specified by:

isSmoothElevatedLinesPoint in interface ITrackingGlobeLayerLeaderLines

Returns:

The smooth

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSmoothElevatedLinesPoint

public void setSmoothElevatedLinesPoint(boolean smooth)
                                 throws java.io.IOException,
                                        AutomationException

Indicates whether to smooth the point located at the base of the elevated lines.

Specified by:

setSmoothElevatedLinesPoint in interface ITrackingGlobeLayerLeaderLines

Parameters:

smooth - The smooth (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElevatedLinesPointColor

public IColor getElevatedLinesPointColor()
                                  throws java.io.IOException,
                                         AutomationException

Specifies the color of the point located at the base of the elevated lines.

Specified by:

getElevatedLinesPointColor in interface ITrackingGlobeLayerLeaderLines

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setElevatedLinesPointColor

public void setElevatedLinesPointColor(IColor color)
                                throws java.io.IOException,
                                       AutomationException

Specifies the color of the point located at the base of the elevated lines.

Specified by:

setElevatedLinesPointColor in interface ITrackingGlobeLayerLeaderLines

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExpressionProperties

public IDisplayExpressionProperties getExpressionProperties()
                                                     throws java.io.IOException,
                                                            AutomationException

Properties that describe the display expression.

Specified by:

getExpressionProperties in interface IDisplayString

Returns:

A reference to a com.esri.arcgis.carto.IDisplayExpressionProperties

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExpressionPropertiesByRef

public void setExpressionPropertiesByRef(IDisplayExpressionProperties displayExpressionProperties)
                                  throws java.io.IOException,
                                         AutomationException

Properties that describe the display expression.

Specified by:

setExpressionPropertiesByRef in interface IDisplayString

Parameters:

displayExpressionProperties - A reference to a com.esri.arcgis.carto.IDisplayExpressionProperties (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findDisplayString

public java.lang.String findDisplayString(IObject pObject)
                                   throws java.io.IOException,
                                          AutomationException

Finds the display string for the given feature based on the current expression properties.

Specified by:

findDisplayString in interface IDisplayString

Parameters:

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

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHTMLPopupEnabled

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

Indicates if this layer currently responds to the HTML Popup tool.

Specified by:

isHTMLPopupEnabled in interface IHTMLPopupIdentify

Specified by:

isHTMLPopupEnabled in interface IHTMLPopupInfo

Returns:

The pEnabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLPopupEnabled

public void setHTMLPopupEnabled(boolean pEnabled)
                         throws java.io.IOException,
                                AutomationException

Indicates if this layer currently responds to the HTML Popup tool.

Specified by:

setHTMLPopupEnabled in interface IHTMLPopupInfo

Parameters:

pEnabled - The pEnabled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLPresentationStyle

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

Indicates the content formating style for the HTML Popup tool.

Specified by:

getHTMLPresentationStyle in interface IHTMLPopupIdentify

Specified by:

getHTMLPresentationStyle in interface IHTMLPopupInfo

Returns:

A com.esri.arcgis.carto.esriHTMLPopupStyle constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLPresentationStyle

public void setHTMLPresentationStyle(int pStyle)
                              throws java.io.IOException,
                                     AutomationException

Indicates the content formating style for the HTML Popup tool.

Specified by:

setHTMLPresentationStyle in interface IHTMLPopupInfo

Parameters:

pStyle - A com.esri.arcgis.carto.esriHTMLPopupStyle constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHTMLHideFieldNameColumn

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

Indicates if Field name column will be output to the HTML Popup tool.

Specified by:

isHTMLHideFieldNameColumn in interface IHTMLPopupInfo

Returns:

The pHide

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLHideFieldNameColumn

public void setHTMLHideFieldNameColumn(boolean pHide)
                                throws java.io.IOException,
                                       AutomationException

Indicates if Field name column will be output to the HTML Popup tool.

Specified by:

setHTMLHideFieldNameColumn in interface IHTMLPopupInfo

Parameters:

pHide - The pHide (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectField

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

Indicates the fieldname of the layer that contains the HTML redirect URL values.

Specified by:

getHTMLRedirectField in interface IHTMLPopupInfo

Returns:

The pField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectField

public void setHTMLRedirectField(java.lang.String pField)
                          throws java.io.IOException,
                                 AutomationException

Indicates the fieldname of the layer that contains the HTML redirect URL values.

Specified by:

setHTMLRedirectField in interface IHTMLPopupInfo

Parameters:

pField - The pField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectFieldPrefix

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

Indicates the text to precede the HTMLRedirectField value for the redirect URL.

Specified by:

getHTMLRedirectFieldPrefix in interface IHTMLPopupInfo

Returns:

The pPrefix

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectFieldPrefix

public void setHTMLRedirectFieldPrefix(java.lang.String pPrefix)
                                throws java.io.IOException,
                                       AutomationException

Indicates the text to precede the HTMLRedirectField value for the redirect URL.

Specified by:

setHTMLRedirectFieldPrefix in interface IHTMLPopupInfo

Parameters:

pPrefix - The pPrefix (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLRedirectFieldSuffix

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

Indicates the text to follow the HTMLRedirectField value for the redirect URL.

Specified by:

getHTMLRedirectFieldSuffix in interface IHTMLPopupInfo

Returns:

The pSufix

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLRedirectFieldSuffix

public void setHTMLRedirectFieldSuffix(java.lang.String pSufix)
                                throws java.io.IOException,
                                       AutomationException

Indicates the text to follow the HTMLRedirectField value for the redirect URL.

Specified by:

setHTMLRedirectFieldSuffix in interface IHTMLPopupInfo

Parameters:

pSufix - The pSufix (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLXSLStylesheet

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

Indicates the content of the XSL stylesheet to parse the feature attributes through.

Specified by:

getHTMLXSLStylesheet in interface IHTMLPopupInfo

Returns:

The pStyleSheet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLXSLStylesheet

public void setHTMLXSLStylesheet(java.lang.String pStyleSheet)
                          throws java.io.IOException,
                                 AutomationException

Indicates the content of the XSL stylesheet to parse the feature attributes through.

Specified by:

setHTMLXSLStylesheet in interface IHTMLPopupInfo

Parameters:

pStyleSheet - The pStyleSheet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHTMLUseCodedDomainValues

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

Indicates whether to use coded values (rather than literal stored values) for feature values.

Specified by:

isHTMLUseCodedDomainValues in interface IHTMLPopupInfo

Returns:

The pCodedValues

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLUseCodedDomainValues

public void setHTMLUseCodedDomainValues(boolean pCodedValues)
                                 throws java.io.IOException,
                                        AutomationException

Indicates whether to use coded values (rather than literal stored values) for feature values.

Specified by:

setHTMLUseCodedDomainValues in interface IHTMLPopupInfo

Parameters:

pCodedValues - The pCodedValues (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHTMLOutput

public java.lang.String getHTMLOutput(IFeature pFeature)
                               throws java.io.IOException,
                                      AutomationException

The content is the XML text for the input feature.

Specified by:

getHTMLOutput in interface IHTMLPopupInfo

Parameters:

pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Returns:

The pHtml

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHTMLDownloadAttachmentData

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

Indicates that all data for attachments will be retrieved.

Specified by:

isHTMLDownloadAttachmentData in interface IHTMLPopupInfo2

Returns:

The pDownloadAttachmentData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHTMLDownloadAttachmentData

public void setHTMLDownloadAttachmentData(boolean pDownloadAttachmentData)
                                   throws java.io.IOException,
                                          AutomationException

Indicates that all data for attachments will be retrieved.

Specified by:

setHTMLDownloadAttachmentData in interface IHTMLPopupInfo2

Parameters:

pDownloadAttachmentData - The pDownloadAttachmentData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hTMLOutput

public java.lang.String hTMLOutput(IFeature pFeature,
                                   IPropertySet pOptions)
                            throws java.io.IOException,
                                   AutomationException

The content is the XML text for the input feature, pOptions is an optional parameter.

Specified by:

hTMLOutput in interface IHTMLPopupInfo2

Parameters:

pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

pOptions - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

The pHtml

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hTMLIdentify

public java.lang.String hTMLIdentify(IPoint pPoint,
                                     double tolerance)
                              throws java.io.IOException,
                                     AutomationException

The content is the XML text at the specified point.

Specified by:

hTMLIdentify in interface IHTMLPopupIdentify

Parameters:

pPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

tolerance - The tolerance (in)

Returns:

The pHtml

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hTMLTipText

public java.lang.String hTMLTipText(IPoint pPoint,
                                    double tolerance)
                             throws java.io.IOException,
                                    AutomationException

The tooltip at the specified point.

Specified by:

hTMLTipText in interface IHTMLPopupIdentify

Parameters:

pPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

tolerance - The tolerance (in)

Returns:

The pTipText

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hTMLIdentify

public void hTMLIdentify(IDisplay pDisplay,
                         IGeometry pGeometry,
                         IPropertySet pOptions,
                         IStringArray[] ppItemNames,
                         IStringArray[] ppItemHTML)
                  throws java.io.IOException,
                         AutomationException

The content is the XML text at the specified point. tempPath and refPath are optional parameters.

Specified by:

hTMLIdentify in interface IHTMLPopupIdentify2

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

pOptions - A reference to a com.esri.arcgis.system.IPropertySet (in)

ppItemNames - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

ppItemHTML - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHotlinkField

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

Field used for hotlinks.

Specified by:

getHotlinkField in interface IHotlinkContainer

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHotlinkField

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

Field used for hotlinks.

Specified by:

setHotlinkField in interface IHotlinkContainer

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHotlinkType

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

Hotlink type.

Specified by:

getHotlinkType in interface IHotlinkContainer

Returns:

A com.esri.arcgis.carto.esriHyperlinkType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHotlinkType

public void setHotlinkType(int linkType)
                    throws java.io.IOException,
                           AutomationException

Hotlink type.

Specified by:

setHotlinkType in interface IHotlinkContainer

Parameters:

linkType - A com.esri.arcgis.carto.esriHyperlinkType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayFilter

public void setDisplayFilter(IDisplayFilter displayFilter)
                      throws java.io.IOException,
                             AutomationException

The display filter.

Specified by:

setDisplayFilter in interface IDisplayFilterManager

Parameters:

displayFilter - A reference to a com.esri.arcgis.display.IDisplayFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayFilter

public IDisplayFilter getDisplayFilter()
                                throws java.io.IOException,
                                       AutomationException

The display filter.

Specified by:

getDisplayFilter in interface IDisplayFilterManager

Returns:

A reference to a com.esri.arcgis.display.IDisplayFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsTransparency

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

Indicates if the layer supports transparency.

Specified by:

isSupportsTransparency in interface ILayerEffects

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsContrastChange

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

Indicates if the layer supports contrast changes.

Specified by:

isSupportsContrastChange in interface ILayerEffects

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsBrightnessChange

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

Indicates if the layer supports brightness changes.

Specified by:

isSupportsBrightnessChange in interface ILayerEffects

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSupportsInteractive

public void setSupportsInteractive(boolean supported)
                            throws java.io.IOException,
                                   AutomationException

Indicates if the layer supports interactive effects changes.

Specified by:

setSupportsInteractive in interface ILayerEffects

Parameters:

supported - The supported (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsInteractive

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

Indicates if the layer supports interactive effects changes.

Specified by:

isSupportsInteractive in interface ILayerEffects

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTransparency

public short getTransparency()
                      throws java.io.IOException,
                             AutomationException

Layer transparency in percent (0-100).

Specified by:

getTransparency in interface ILayerEffects

Returns:

The alpha

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(short alpha)
                     throws java.io.IOException,
                            AutomationException

Layer transparency in percent (0-100).

Specified by:

setTransparency in interface ILayerEffects

Parameters:

alpha - The alpha (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContrast

public short getContrast()
                  throws java.io.IOException,
                         AutomationException

Layer contrast in percent (-100 - 100).

Specified by:

getContrast in interface ILayerEffects

Returns:

The contrastValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setContrast

public void setContrast(short contrastValue)
                 throws java.io.IOException,
                        AutomationException

Layer contrast in percent (-100 - 100).

Specified by:

setContrast in interface ILayerEffects

Parameters:

contrastValue - The contrastValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBrightness

public short getBrightness()
                    throws java.io.IOException,
                           AutomationException

Layer brightness in percent (-100 - 100).

Specified by:

getBrightness in interface ILayerEffects

Returns:

The brightnessValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBrightness

public void setBrightness(short brightnessValue)
                   throws java.io.IOException,
                          AutomationException

Layer brightness in percent (-100 - 100).

Specified by:

setBrightness in interface ILayerEffects

Parameters:

brightnessValue - The brightnessValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException

findConnectionPoint

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanAccessGeometry

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

Indicates whether the a feature layer gives access to the geometry of its features.

Specified by:

isCanAccessGeometry in interface IFeatureGeometryAccess

Returns:

The canAccess

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanSelect

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

Indicates if the table supports selection.

Specified by:

isCanSelect in interface ITableCapabilities

Returns:

The canSelect

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsTime

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

Indicates whether the layer has any time data.

Specified by:

isSupportsTime in interface ITimeData

Returns:

The hasTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseTime

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

Indicates whether to use the time for animation purposes.

Specified by:

isUseTime in interface ITimeData

Returns:

The useTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseTime

public void setUseTime(boolean useTime)
                throws java.io.IOException,
                       AutomationException

Indicates whether to use the time for animation purposes.

Specified by:

setUseTime in interface ITimeData

Parameters:

useTime - The useTime (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeReference

public ITimeReference getTimeReference()
                                throws java.io.IOException,
                                       AutomationException

Time reference for the contents of the layer.

Specified by:

getTimeReference in interface ITimeData

Specified by:

getTimeReference in interface ITimeTableDefinition

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullTimeExtent

public ITimeExtent getFullTimeExtent()
                              throws java.io.IOException,
                                     AutomationException

Returns the time extent for all the data in the layer.

Specified by:

getFullTimeExtent in interface ITimeData

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasLiveData

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

isHasLiveData

Specified by:

isHasLiveData in interface ITimeData2

Returns:

The useTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHasLiveData

public void setHasLiveData(boolean useTime)
                    throws java.io.IOException,
                           AutomationException

setHasLiveData

Specified by:

setHasLiveData in interface ITimeData2

Parameters:

useTime - The useTime (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStartTimeFieldName

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

Name of the field that has start time for a row.

Specified by:

getStartTimeFieldName in interface ITimeTableDefinition

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStartTimeFieldName

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

Name of the field that has start time for a row.

Specified by:

setStartTimeFieldName in interface ITimeTableDefinition

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEndTimeFieldName

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

Name of the field that has end time for a row.

Specified by:

getEndTimeFieldName in interface ITimeTableDefinition

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEndTimeFieldName

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

Name of the field that has end time for a row.

Specified by:

setEndTimeFieldName in interface ITimeTableDefinition

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeValueFormat

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

Time value format if the field name is of the string format.

Specified by:

getTimeValueFormat in interface ITimeTableDefinition

Returns:

The format

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeValueFormat

public void setTimeValueFormat(java.lang.String format)
                        throws java.io.IOException,
                               AutomationException

Time value format if the field name is of the string format.

Specified by:

setTimeValueFormat in interface ITimeTableDefinition

Parameters:

format - The format (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrackIDFieldName

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

Field that contains the rows that uniquely identifies the object whose time is being tracked.

Specified by:

getTrackIDFieldName in interface ITimeTableDefinition

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTrackIDFieldName

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

Field that contains the rows that uniquely identifies the object whose time is being tracked.

Specified by:

setTrackIDFieldName in interface ITimeTableDefinition

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeReferenceByRef

public void setTimeReferenceByRef(ITimeReference nativeTimeReference)
                           throws java.io.IOException,
                                  AutomationException

Time reference for the data.

Specified by:

setTimeReferenceByRef in interface ITimeTableDefinition

Parameters:

nativeTimeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCustomTimeExtent

public ITimeExtent getCustomTimeExtent()
                                throws java.io.IOException,
                                       AutomationException

Custom time extent during which a layer is visible.

Specified by:

getCustomTimeExtent in interface ITimeTableDefinition

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomTimeExtentByRef

public void setCustomTimeExtentByRef(ITimeExtent layerVisibiltyTime)
                              throws java.io.IOException,
                                     AutomationException

Custom time extent during which a layer is visible.

Specified by:

setCustomTimeExtentByRef in interface ITimeTableDefinition

Parameters:

layerVisibiltyTime - A reference to a com.esri.arcgis.system.ITimeExtent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeDataCumulative

public void setTimeDataCumulative(boolean cumilative)
                           throws java.io.IOException,
                                  AutomationException

Indicates that features will be animated cumilatively.

Specified by:

setTimeDataCumulative in interface ITimeDataDisplay

Parameters:

cumilative - The cumilative (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isTimeDataCumulative

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

Indicates that features will be animated cumilatively.

Specified by:

isTimeDataCumulative in interface ITimeDataDisplay

Returns:

The cumilative

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeInterval

public void setTimeInterval(double interval)
                     throws java.io.IOException,
                            AutomationException

Returns recommended time interval to be used to animate this layer/ table.

Specified by:

setTimeInterval in interface ITimeDataDisplay

Parameters:

interval - The interval (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeInterval

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

Returns recommended time interval to be used to animate this layer/ table.

Specified by:

getTimeInterval in interface ITimeDataDisplay

Returns:

The interval

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeIntervalUnits

public void setTimeIntervalUnits(int units)
                          throws java.io.IOException,
                                 AutomationException

Returns recommended time interval units to be used to animate this layer/ table.

Specified by:

setTimeIntervalUnits in interface ITimeDataDisplay

Parameters:

units - A com.esri.arcgis.system.esriTimeUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeIntervalUnits

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

Returns recommended time interval units to be used to animate this layer/ table.

Specified by:

getTimeIntervalUnits in interface ITimeDataDisplay

Returns:

A com.esri.arcgis.system.esriTimeUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeOffset

public void setTimeOffset(double timeOffset)
                   throws java.io.IOException,
                          AutomationException

Returns time offset that needs to be applied to the data for drawing.

Specified by:

setTimeOffset in interface ITimeDataDisplay

Parameters:

timeOffset - The timeOffset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeOffset

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

Returns time offset that needs to be applied to the data for drawing.

Specified by:

getTimeOffset in interface ITimeDataDisplay

Returns:

The timeOffset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeOffsetUnits

public void setTimeOffsetUnits(int units)
                        throws java.io.IOException,
                               AutomationException

Returns recommended time interval units to be used to animate this layer/ table.

Specified by:

setTimeOffsetUnits in interface ITimeDataDisplay

Parameters:

units - A com.esri.arcgis.system.esriTimeUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeOffsetUnits

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

Returns recommended time interval units to be used to animate this layer/ table.

Specified by:

getTimeOffsetUnits in interface ITimeDataDisplay

Returns:

A com.esri.arcgis.system.esriTimeUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsPublishing

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

Indicates if the layer supports the publishing process.

Specified by:

isSupportsPublishing in interface IPublishLayer

Returns:

The bValid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPublishingDescription

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

The layer description reported to the publisher.

Specified by:

getPublishingDescription in interface IPublishLayer

Returns:

The bsDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDataValid

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

Indicates if the data for the layer is currently valid.

Specified by:

isDataValid in interface IPublishLayer

Returns:

The bDataValid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataDetails

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

Details of the layer's data.

Specified by:

getDataDetails in interface IPublishLayer

Parameters:

bsPadding - The bsPadding (in)

Returns:

The bsDataDetails

Throws:

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

AutomationException - If the ArcObject component throws an exception.

prepareForPublishing

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

Prepare the layer for the publishing process.

Specified by:

prepareForPublishing in interface IPublishLayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

prepareTimeQuery

public void prepareTimeQuery(ITimeValue pTimeValue,
                             IQueryFilter[] pFilter)
                      throws java.io.IOException,
                             AutomationException

Prepares an input query filter by appending the time expression into the where clause.

Specified by:

prepareTimeQuery in interface ITimeDisplayTable

Parameters:

pTimeValue - A reference to a com.esri.arcgis.system.ITimeValue (in)

pFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

prepareTimeQueryEx

public void prepareTimeQueryEx(ITimeValue pTimeValue,
                               int eTimeRelation,
                               IQueryFilter[] pFilter)
                        throws java.io.IOException,
                               AutomationException

Prepares an input query filter by appending the time expression into the where clause.

Specified by:

prepareTimeQueryEx in interface ITimeDisplayTable2

Parameters:

pTimeValue - A reference to a com.esri.arcgis.system.ITimeValue (in)

eTimeRelation - A com.esri.arcgis.system.esriTimeRelation constant (in)

pFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

prepareTimeQueryFromDisplay

public void prepareTimeQueryFromDisplay(IDisplay pDisplay,
                                        IQueryFilter[] pFilter)
                                 throws java.io.IOException,
                                        AutomationException

Prepares an input query filter by appending the time expression into the where clause.

Specified by:

prepareTimeQueryFromDisplay in interface ITimeDisplayTable2

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException