com.esri.arcgis.carto
Class IMSSubFeatureLayer

java.lang.Object
  com.esri.arcgis.carto.IMSSubFeatureLayer

All Implemented Interfaces:

IDataLayer, IDisplayString, IDisplayTable, IFeatureGeometryAccess, IFeatureLayer, IFeatureSelection, IHotlinkContainer, IHotlinkExpression, IHotlinkMacro, IHTMLPopupIdentify, IHTMLPopupIdentify2, IHTMLPopupInfo, IHTMLPopupInfo2, IHyperlinkContainer, IIdentify, IIMSSubLayer, ILayer, ILayerDrawingProperties, ILayerFields, ILayerGeneralProperties, ILayerInfo, IPublishLayer, IRelationshipClassCollection, IRelationshipClassCollectionEdit, ISelectionLayerDefinition, IDisplayAdmin, IDisplayFilterManager, IClass, IDataset, IGeoDataset, ITable, ITableFields, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class IMSSubFeatureLayer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IIMSSubLayer, IFeatureLayer, ILayer, IFeatureSelection, IGeoDataset, ILayerFields, ITableFields, IIdentify, IDataLayer, ILayerDrawingProperties, ILayerInfo, IDisplayAdmin, IDisplayFilterManager, IHyperlinkContainer, IHotlinkContainer, IHotlinkMacro, IHotlinkExpression, ITable, IDataset, IRelationshipClassCollection, IRelationshipClassCollectionEdit, IDisplayTable, ISelectionLayerDefinition, IPublishLayer, ILayerGeneralProperties, IFeatureGeometryAccess, IHTMLPopupInfo, IHTMLPopupInfo2, IHTMLPopupIdentify, IHTMLPopupIdentify2, IDisplayString, IPersistStream, IDocumentVersionSupportGEN, java.io.Externalizable

COM Class 'IMSSubFeatureLayer'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'A collection of IMS features as a sublayer of an IMSMapLayer.' 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.carto.IIMSSubLayer

IID, IIDd090aa89_c2f1_11d3_9fef_00c04f6bc6a5, xxDummy

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

IID, IID40a9e885_5533_11d0_98be_00805f7ced21, xxDummy

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

IID, IID9336a280_c9a3_11d1_847e_0000f875b9c6, 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.IDataLayer

IID, IID6ca416b1_e160_11d2_9f4e_00c04f6bc78e, xxDummy

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

IID, IID274419e1_0f5c_11d3_9bfd_00c04f5b951e, 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.IHyperlinkContainer

IID, IIDd1a02a0b_2113_11d3_9f98_00c04f6bc78e, xxDummy

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

IID, IIDd1a02a0c_2113_11d3_9f98_00c04f6bc78e, xxDummy

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

IID, IIDd7ee3484_004d_11d4_9fe7_00c04f6bc78e, xxDummy

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

IID, IID6fb88442_c7d2_4355_92c0_e96a577636d2, 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.geodatabase.IDataset

IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy

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

IID, IID741d6114_fb6b_11d3_adf5_00c04fa33a15, xxDummy

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

IID, IIDb725de95_ff76_11d3_a0b5_00c04f6bc626, 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.ISelectionLayerDefinition

IID, IID863e18bb_9b3e_4eee_ac2d_f891e8ed8fd9, 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.IFeatureGeometryAccess

IID, IIDaddf1b83_7d75_49c6_a587_73a0aba90e99, 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.IDisplayString

IID, IID8d090acb_8c9e_4343_a3cc_f9da9be3c401, 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

Constructor Summary

IMSSubFeatureLayer(java.lang.Object obj)
Construct a IMSSubFeatureLayer 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	addField(IField field) Adds a field to this object class.
void	addHyperlink(IHyperlink link) Adds a hyperlink.
void	addIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener) addIFeatureLayerSelectionEventsListener.
void	addILayerEventsListener(ILayerEvents theListener) addILayerEventsListener.
void	addIndex(IIndex index) Adds an index to this object class.
void	addRelationshipClass(IRelationshipClass relationshipClass) Adds the specified memory relationship class to a standalone table or layer.
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	draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws the layer to the specified display for the given draw phase.
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	executeExpression(IObject pObject) Finds the hyperlink for the given feature based on the current expression properties.
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.
IEnumRelationshipClass	findRelationshipClasses(IObjectClass objectClass, int role) Finds all relationship classes in the collection that reference the given object class in the specified role.
IEnvelope	getAreaOfInterest() The default area of interest for the layer.
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
IUID	getCLSID() The GUID for the COM Class (CoClass) corresponding to instances of this object class.
int	getCombinationMethod() Combination method for the selection.
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	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.
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.
IPropertySet	getExtensionProperties() The extension properties for this object class.
IEnvelope	getExtent() The extent of the GeoDataset.
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.
IName	getFullName() The associated name object.
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.
IHyperlink	getHyperlink(int index) The hyperlink at the specified index.
int	getHyperlinkCount() Number of hyperlinks.
IACLayer	getIMSLayer() The IMS layer.
IIndexes	getIndexes() The indexes collection for this object class.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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.
java.lang.String	getMacroName() Name of macro used for the hotlink.
double	getMaximumScale() Maximum scale (representative fraction) at which the layer will display.
double	getMinimumScale() Minimum scale (representative fraction) at which the layer will display.
java.lang.String	getName() Layer name.
java.lang.String	getOIDFieldName() The name of the field corresponding to the OID.
IPropertySet	getPropertySet() The set of properties for the dataset.
java.lang.String	getPublishingDescription() The layer description reported to the publisher.
IEnumRelationshipClass	getRelationshipClasses() The memory relationship classes.
java.lang.String	getRelativeBase() Base path used when storing relative path names.
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.
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.
IEnumDataset	getSubsets() Datasets contained within this dataset.
int	getSupportedDrawPhases() Supported draw phases.
java.lang.String	getTipText(double x, double y, double tolerance) Map tip text at the specified location.
int	getType() The type of the Dataset.
IWorkspace	getWorkspace() The workspace containing this dataset.
int	hashCode() the hashcode for this object
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.
IHotLinkExpressionProperties	IHotlinkExpression_getExpressionProperties() Properties that describe the hyperlink expression.
java.lang.String	ILayerGeneralProperties_getLayerDescription() Description for the layer.
ICursor	insert(boolean useBuffering) Returns a cursor that can be used to insert new Rows.
boolean	isCached() Indicates if the layer needs its own display cache.
boolean	isCanAccessGeometry() Indicates whether the a feature layer gives access to the geometry of its features.
boolean	isCanIdentify() Indicates if this layer is included in identify.
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	isDrawingPropsDirty() Indicates if the layer drawing properties are dirty.
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	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	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
boolean	isSupportsPublishing() Indicates if the layer supports the publishing process.
boolean	isUsesFilter() Indicates if the current object draws using a filter.
boolean	isValid() Indicates if the layer is currently valid.
boolean	isVisible() Indicates if the layer is currently visible.
ICursor	ITable_search(IQueryFilter queryFilter, boolean recycling) An object cursor that can be used to fetch row objects selected by the specified query.
void	load(IStream pstm) load
void	prepareForPublishing() Prepare the layer for the publishing process.
void	readExternal(java.io.ObjectInput in)
void	release() Release a IMSSubFeatureLayer.
void	removeAllRelationshipClasses() Removes all memory relationship classes from a standalone table or layer.
void	removeHyperlink(int index) Removes the hyperlink at the specified index.
void	removeIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener) removeIFeatureLayerSelectionEventsListener.
void	removeILayerEventsListener(ILayerEvents theListener) removeILayerEventsListener.
void	removeRelationshipClass(IRelationshipClass relationshipClass) Removes the specified memory relationship class from a standalone table or layer.
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.
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	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	setCanIdentify(boolean flag) Indicates if this layer is included in identify.
void	setCombinationMethod(int method) Combination method for the selection.
void	setDataSourceName(IName name) Name of the data object for the layer.
void	setDataSourceType(java.lang.String text) Data source type.
void	setDisplayField(java.lang.String fieldName) Primary display field.
void	setDisplayFilter(IDisplayFilter displayFilter) The display filter.
void	setDrawingPropsDirty(boolean dirty) Indicates if the layer drawing properties are dirty.
void	setExpressionPropertiesByRef(IDisplayExpressionProperties displayExpressionProperties) Properties that describe the display expression.
void	setExpressionPropertiesByRef(IHotLinkExpressionProperties ppHotLinkExpressionProperties) Properties that describe the hyperlink expression.
void	setFeatureClassByRef(IFeatureClass fclass) The layer's feature class.
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	setHyperlinkByRef(int index, IHyperlink link) The hyperlink at the specified index.
void	setLayerDescription(java.lang.String text) Description for the layer.
void	setMacroName(java.lang.String name) Name of macro used for the hotlink.
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	setRelativeBase(java.lang.String basePath) Base path used when storing relative path names.
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	setSpatialReferenceByRef(ISpatialReference rhs1) Spatial reference for the layer.
void	setSymbologyUpdated(boolean rhs1) Indicates if this layers symbology has been updated.
void	setVisible(boolean visible) Indicates if the layer is currently visible.
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

IMSSubFeatureLayer

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

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

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

Throws:

java.io.IOException - if there are interop problems IMSSubFeatureLayer theIMSSubFeatureLayer = (IMSSubFeatureLayer) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

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

Deprecated. Internal use only.

Specified by:

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

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.

addIFeatureLayerSelectionEventsListener

public void addIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener)
                                             throws java.io.IOException

addIFeatureLayerSelectionEventsListener. Listen to events generated by this class.

Parameters:

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

Throws:

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

removeIFeatureLayerSelectionEventsListener

public void removeIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener)
                                                throws java.io.IOException

removeIFeatureLayerSelectionEventsListener. Stop listening to events generated by this class.

Parameters:

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

Throws:

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

release

public void release()

Release a IMSSubFeatureLayer.

Specified by:

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

isCanIdentify

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

Indicates if this layer is included in identify.

Specified by:

isCanIdentify in interface IIMSSubLayer

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCanIdentify

public void setCanIdentify(boolean flag)
                    throws java.io.IOException,
                           AutomationException

Indicates if this layer is included in identify.

Specified by:

setCanIdentify in interface IIMSSubLayer

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIMSLayer

public IACLayer getIMSLayer()
                     throws java.io.IOException,
                            AutomationException

The IMS layer.

Specified by:

getIMSLayer in interface IIMSSubLayer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbologyUpdated

public void setSymbologyUpdated(boolean rhs1)
                         throws java.io.IOException,
                                AutomationException

Indicates if this layers symbology has been updated.

Specified by:

setSymbologyUpdated in interface IIMSSubLayer

Parameters:

rhs1 - The rhs1 (in)

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

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

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

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

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

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

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

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

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

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

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

Parameters:

scale - The scale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

Layer name.

Description

Remarks

Use this property to associate a string with a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface ILayer

Specified by:

getName in interface IDataset

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

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

Layer name.

Description

Use the Name property to associate a string with the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface ILayer

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.

Remarks

The valid property indicates if the layer is currently valid. Layers that reference feature classes are valid when they hold a reference to a valid feature class. The property does not however validate the integrity of the feature classes reference to the database. Therefore, in rare situations if a datasource is removed after a layer is initialized, the layer will report itself as valid but query attempts to the data source will error due to the lack of underlying data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isValid in interface ILayer

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.

Remarks

Returns the spatial-referenced extent of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAreaOfInterest in interface ILayer

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.

Remarks

Specifies the minimum scale at which the layer will be displayed. This means that if you zoom out beyond this scale, the layer will not display. For example, specify 1000 to have the layer not display when zoomed out beyond 1:1000.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinimumScale in interface ILayer

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.

Description

MinimumScale property specifies the minimum scale at which the layer will be displayed. Assign a Double value to set this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinimumScale in interface ILayer

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.

Remarks

Specifies the maximum scale at which the layer will be displayed. This means that if you zoom in beyond this scale, the layer will not display. For example, specify 500 to have the layer not display when zoomed in beyond 1:500.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaximumScale in interface ILayer

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.

Description

MaximumScale property specifies the maximum scale at which the layer will be displayed. Assign a Double value to set this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaximumScale in interface ILayer

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVisible in interface ILayer

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.

Description

Use Visible property to set the visibility of the layer. When assigned False, the layer is invisible in the current view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVisible in interface ILayer

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.

Remarks

Indicates whether or not map tips are shown for the layer. If set to True, then map tips will be shown for the layer. You can determine the text that will be shown via TipText. For a FeatureLayer, this text comes from the data for IFeatureLayer::DisplayField.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowTips in interface ILayer

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.

Description

ShowTips is set to True when the layer shows map tips specified in the TipText property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowTips in interface ILayer

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.

Product Availability

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

Specified by:

getTipText in interface ILayer

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.

Remarks

This property indicates whether or not the layer requires its own display cache. If this property is True, then the Map will use a separate display cache for the layer so that it can be refreshed indpendently of other layers.

The Map is responsible for cache management. See IScreenDisplay::AddCache for more information on caches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCached in interface ILayer

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.

Description

Use Cached property to indicate if the layer needs its own cache for display.

Remarks

Informational property. Container is responsible for cache management.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCached in interface ILayer

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.

Remarks

Indicates the draw phases supported by the layer (esriDPGeography, esriDPAnnotation, esriDPSelection, or any combination of the three). The supported draw phases are defined by esriDrawPhase. When multiple draw phases are supported, the sum of the constants is used. For example, if SupportedDrawPhases = 3 then the layer supports drawing in the geography and annotation phases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSupportedDrawPhases in interface ILayer

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.

Remarks

This property is only used for map display, setting this property does not change the spatial reference of the layer's underlying data. The ArcGIS framework uses this property to pass the spatial reference from the map to the layer in order to support on-the-fly projection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSpatialReferenceByRef in interface ILayer

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.

Remarks

This method draws the layer to the Display for the specified DrawPhase. Use the TrackCancel object to allow the drawing of the layer to be interrupted by the user.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface ILayer

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.

getSelectionSet

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

The selected set of features.

Specified by:

getSelectionSet in interface IFeatureSelection

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

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

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

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.

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.

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.

getDataSourceName

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

Name of the data object for the layer.

Specified by:

getDataSourceName in interface IDataLayer

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

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

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

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

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

Parameters:

basePath - The basePath (in)

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.

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.

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.

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.

getHyperlinkCount

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

Number of hyperlinks.

Specified by:

getHyperlinkCount in interface IHyperlinkContainer

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHyperlink

public IHyperlink getHyperlink(int index)
                        throws java.io.IOException,
                               AutomationException

The hyperlink at the specified index.

Specified by:

getHyperlink in interface IHyperlinkContainer

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHyperlinkByRef

public void setHyperlinkByRef(int index,
                              IHyperlink link)
                       throws java.io.IOException,
                              AutomationException

The hyperlink at the specified index.

Specified by:

setHyperlinkByRef in interface IHyperlinkContainer

Parameters:

index - The index (in)

link - A reference to a com.esri.arcgis.carto.IHyperlink (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addHyperlink

public void addHyperlink(IHyperlink link)
                  throws java.io.IOException,
                         AutomationException

Adds a hyperlink.

Specified by:

addHyperlink in interface IHyperlinkContainer

Parameters:

link - A reference to a com.esri.arcgis.carto.IHyperlink (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeHyperlink

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

Removes the hyperlink at the specified index.

Specified by:

removeHyperlink in interface IHyperlinkContainer

Parameters:

index - The index (in)

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.

getMacroName

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

Name of macro used for the hotlink.

Specified by:

getMacroName in interface IHotlinkMacro

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMacroName

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

Name of macro used for the hotlink.

Specified by:

setMacroName in interface IHotlinkMacro

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

IHotlinkExpression_getExpressionProperties

public IHotLinkExpressionProperties IHotlinkExpression_getExpressionProperties()
                                                                        throws java.io.IOException,
                                                                               AutomationException

Properties that describe the hyperlink expression.

Specified by:

IHotlinkExpression_getExpressionProperties in interface IHotlinkExpression

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExpressionPropertiesByRef

public void setExpressionPropertiesByRef(IHotLinkExpressionProperties ppHotLinkExpressionProperties)
                                  throws java.io.IOException,
                                         AutomationException

Properties that describe the hyperlink expression.

Specified by:

setExpressionPropertiesByRef in interface IHotlinkExpression

Parameters:

ppHotLinkExpressionProperties - A reference to a com.esri.arcgis.carto.IHotLinkExpressionProperties (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

executeExpression

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

Finds the hyperlink for the given feature based on the current expression properties.

Specified by:

executeExpression in interface IHotlinkExpression

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.

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.

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.

getRelationshipClasses

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

The memory relationship classes.

Specified by:

getRelationshipClasses in interface IRelationshipClassCollection

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findRelationshipClasses

public IEnumRelationshipClass findRelationshipClasses(IObjectClass objectClass,
                                                      int role)
                                               throws java.io.IOException,
                                                      AutomationException

Finds all relationship classes in the collection that reference the given object class in the specified role.

Specified by:

findRelationshipClasses in interface IRelationshipClassCollection

Parameters:

objectClass - A reference to a com.esri.arcgis.geodatabase.IObjectClass (in)

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addRelationshipClass

public void addRelationshipClass(IRelationshipClass relationshipClass)
                          throws java.io.IOException,
                                 AutomationException

Adds the specified memory relationship class to a standalone table or layer.

Specified by:

addRelationshipClass in interface IRelationshipClassCollectionEdit

Parameters:

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

removeRelationshipClass

public void removeRelationshipClass(IRelationshipClass relationshipClass)
                             throws java.io.IOException,
                                    AutomationException

Removes the specified memory relationship class from a standalone table or layer.

Specified by:

removeRelationshipClass in interface IRelationshipClassCollectionEdit

Parameters:

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

removeAllRelationshipClasses

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

Removes all memory relationship classes from a standalone table or layer.

Specified by:

removeAllRelationshipClasses in interface IRelationshipClassCollectionEdit

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.

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 ISelectionLayerDefinition

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.

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.

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.

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.

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.

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.

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.

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.

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.

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