|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.carto.FeatureLayer
public class FeatureLayer
A collection of features and their visual representation.
A FeatureLayer is a layer based on vector geographic data which is typically a geodatabase, coverage, or shapefile feature class.
Constructor Summary | |
---|---|
FeatureLayer()
Constructs a FeatureLayer using ArcGIS Engine. |
|
FeatureLayer(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. FeatureLayer theFeatureLayer = (FeatureLayer) obj; |
Method Summary | |
---|---|
void |
add(IFeature feature)
Adds a feature to the selection set. |
void |
addExtension(Object ext)
Adds a new extension. |
void |
addField(IField field)
Adds a field to this object class. |
void |
addHyperlink(IHyperlink link)
Adds a hyperlink. |
void |
addIDefinitionExpressionEventsListener(IDefinitionExpressionEvents theListener)
addIDefinitionExpressionEventsListener. |
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. |
void |
addRow(IRow row)
Adds a row to the selection set (honoring the current combination method). |
boolean |
applies(Object pUnk)
Indicates if the receiver can apply the given object at any given time. |
Object |
apply(Object newObject)
Applies the given property to the receiver and returns the old object. |
boolean |
canApply(Object pUnk)
Indicates if the receiver can apply the given object at that particular moment. |
boolean |
canCopy()
True if this dataset can be copied. |
boolean |
canDelete()
True if this dataset can be deleted. |
boolean |
canRename()
True if this dataset can be renamed. |
void |
clear()
Clears the selection. |
boolean |
connect(IName pOptRepairName)
Connects the layer to its data source. |
IDataset |
copy(String copyName,
IWorkspace copyWorkspace)
Copies this dataset to a new dataset with the specified name. |
IRow |
createRow()
Creates a row in the database with a system assigned object ID and null property values. |
IRowBuffer |
createRowBuffer()
Creates a row buffer that can be used with an insert cursor. |
IFeatureLayer |
createSelectionLayer(String layerName,
boolean useCurrentSelection,
String joinTableNames,
String expression)
Creates a new feature layer from the existing layer based on the current selection and the specified query expression. |
void |
delete()
Deletes this dataset. |
void |
deleteField(IField field)
Deletes a field from this object class. |
void |
deleteIndex(IIndex index)
Deletes an index from this object class. |
void |
deleteSearchedRows(IQueryFilter queryFilter)
Delete the Rows in the database selected by the specified query. |
void |
disconnect()
Disconnects the data from the layer. |
void |
displayRelationshipClass(IRelationshipClass relClass,
int joinType)
Sets a join based on the specified relationship class and join type. |
void |
draw(int drawPhase,
IDisplay display,
ITrackCancel trackCancel)
Draws the layer to the specified display for the given draw phase. |
void |
enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
enumConnectionPoints |
boolean |
equals(Object o)
Compare this object with another |
String |
executeExpression(IObject pObject)
Finds the hyperlink for the given feature based on the current expression properties. |
void |
expandRegionForSymbols(IDisplay display,
IGeometry region)
Expands the given geometry by an amount that will include the layer's symbology for the given display. |
IArray |
find(String search,
boolean contains,
Object fields,
ITrackCancel trackCancel)
Finds the specified search string in the given attribute fields. |
void |
findConnectionPoint(GUID riid,
IConnectionPoint[] ppCP)
findConnectionPoint |
String |
findDisplayString(IObject pObject)
Finds the display string for the given feature based on the current expression properties. |
int |
findField(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. |
IAnnotateLayerPropertiesCollection |
getAnnotationProperties()
Annotation properties. |
IUID |
getAnnotationPropertiesID()
The UID used for annotation properties. |
IEnvelope |
getAreaOfInterest()
The default area of interest for the layer. |
ITable |
getAttributeTable()
The attribute table. |
short |
getBrightness()
Layer brightness in percent (-100 - 100). |
String |
getBrowseName()
The browse name of the dataset. |
double |
getBufferDistance()
Buffer distance used for the selection. |
String |
getCategory()
The category of the dataset. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
IUID |
getCLSID()
The GUID for the COM Class (CoClass) corresponding to instances of this object class. |
int |
getCombinationMethod()
Combination method for the selection. |
short |
getContrast()
Layer contrast in percent (-100 - 100). |
Object |
getCurrent(Object pUnk)
The object currently being used. |
ITimeExtent |
getCustomTimeExtent()
Custom time extent during which a layer is visible. |
String |
getDataDetails(String bsPadding)
Details of the layer's data. |
IName |
getDataSourceName()
Name of the data object for the layer. |
String |
getDataSourceType()
Data source type. |
String |
getDefinitionExpression()
Definition query expression for the existing layer. |
ISelectionSet |
getDefinitionSelectionSet()
The selection set that defines the subset of features in a selection layer. |
IFeatureClass |
getDisplayFeatureClass()
Feature class used for display operations (may include joined fields). |
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. |
String |
getEndTimeFieldName()
Name of the field that has end time for a row. |
IFeatureIDSet |
getExclusionSet()
The set of features that are excluded from drawing. |
IDisplayExpressionProperties |
getExpressionProperties()
Properties that describe the display expression. |
IUID |
getEXTCLSID()
The GUID for the COM Class (CoClass) corresponding to the class extension for this object class. |
Object |
getExtension()
The extension for this object class. |
Object |
getExtension(int index)
The extension at the specified index. |
int |
getExtensionCount()
Number of extensions. |
IPropertySet |
getExtensionProperties()
The extension properties for this object class. |
IEnvelope |
getExtent()
The extent of the GeoDataset. |
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. |
IFieldInfoSet |
getFieldInfos()
The fields in order. |
IFields |
getFields()
The fields collection for this object class. |
String |
getFindDisplayField()
The display field. |
Object |
getFindFields()
The attribute fields. |
IName |
getFullName()
The associated name object. |
ITimeExtent |
getFullTimeExtent()
Returns the time extent for all the data in the layer. |
String |
getHotlinkField()
Field used for hotlinks. |
int |
getHotlinkType()
Hotlink type. |
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. |
String |
getHTMLRedirectField()
Indicates the fieldname of the layer that contains the HTML redirect URL values. |
String |
getHTMLRedirectFieldPrefix()
Indicates the text to precede the HTMLRedirectField value for the redirect URL. |
String |
getHTMLRedirectFieldSuffix()
Indicates the text to follow the HTMLRedirectField value for the redirect URL. |
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. |
IIndexes |
getIndexes()
The indexes collection for this object class. |
int |
getJoinType()
Join type for the most recent join performed. |
int |
getLargeImage()
Large image that represents the layer. |
int |
getLargeSelectedImage()
Large image that represents the layer when it is selected. |
double |
getLastMaximumScale()
Last maximum scale setting used by layer. |
double |
getLastMinimumScale()
Last minimum scale setting used by layer. |
double |
getLayerWeight()
Default layer position. |
ILegendGroup |
getLegendGroup(int index)
Legend group at the specified index. |
int |
getLegendGroupCount()
Number of legend groups contained by the object. |
ILegendItem |
getLegendItem()
Optional. |
String |
getMacroName()
Name of macro used for the hotlink. |
int |
getMapLevel()
Current map level for drawing multi-level symbols. |
double |
getMaximumScale()
Maximum scale (representative fraction) at which the layer will display. |
double |
getMinimumScale()
Minimum scale (representative fraction) at which the layer will display. |
String |
getName()
Layer name. |
String |
getOIDFieldName()
The name of the field corresponding to the OID. |
IPropertySet |
getPropertySet()
The set of properties for the dataset. |
String |
getPublishingDescription()
The layer description reported to the publisher. |
IRelationshipClass |
getRelationshipClass()
The current relationship class used to display related fields. |
IEnumRelationshipClass |
getRelationshipClasses()
The memory relationship classes. |
String |
getRelativeBase()
Base path used when storing relative path names. |
IFeatureRenderer |
getRenderer()
Renderer used to draw the layer. |
IUID |
getRendererPropertyPageClassID()
Class id of the property page for the renderer. |
IRow |
getRow(int oID)
The row from the database with the specified object ID. |
ICursor |
getRows(Object oids,
boolean recycling)
The cursor of rows based on a set of object ids. |
int |
getSearchOrder()
Flag that specifies the search order used when applying a mixed attribute-spatial query. |
IColor |
getSelectionColor()
Selection color. |
ISelectionSet |
getSelectionSet()
The selected set of features. |
ISymbol |
getSelectionSymbol()
Selection symbol. |
int |
getShapeType()
The layer's shape type. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
int |
getSmallImage()
Small image that represents the layer. |
int |
getSmallSelectedImage()
Small image that represents the layer when it is selected. |
ISpatialReference |
getSpatialReference()
The spatial reference of the GeoDataset. |
String |
getStartTimeFieldName()
Name of the field that has start time for a row. |
IEnumDataset |
getSubsets()
Datasets contained within this dataset. |
int |
getSupportedDrawPhases()
Supported draw phases. |
String |
getTimeDimensionFormat()
Returns the format of the dimension that represents time. |
String |
getTimeDimensionName()
Returns the name of the dimension that represents time. |
double |
getTimeInterval()
Returns recommended time interval to be used to animate this layer/ table. |
int |
getTimeIntervalUnits()
Returns recommended time interval units to be used to animate this layer/ table. |
double |
getTimeOffset()
Returns time offset that needs to be applied to the data for drawing. |
int |
getTimeOffsetUnits()
Returns recommended time interval units to be used to animate this layer/ table. |
ITimeReference |
getTimeReference()
Time reference for the contents of the layer. |
String |
getTimeValueFormat()
Time value format if the field name is of the string format. |
String |
getTipText(double x,
double y,
double tolerance)
Map tip text at the specified location. |
String |
getTrackIDFieldName()
Field that contains the rows that uniquely identifies the object whose time is being tracked. |
short |
getTransparency()
Layer transparency in percent (0-100). |
int |
getType()
The type of the Dataset. |
IWorkspace |
getWorkspace()
The workspace containing this dataset. |
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. |
String |
hTMLIdentify(IPoint pPoint,
double tolerance)
The content is the XML text at the specified point. |
String |
hTMLOutput(IFeature pFeature,
IPropertySet pOptions)
The content is the XML text for the input feature, pOptions is an optional parameter. |
String |
hTMLTipText(IPoint pPoint,
double tolerance)
The tooltip at the specified point. |
IArray |
identify(IGeometry pGeom)
Identifies objects at the specified location. |
IArray |
identify(IGeometry pGeom,
ITrackCancel pTrackCancel)
Identifies objects at the specified location. |
IArray |
identifyEx(IDisplay pDisplay,
IGeometry pGeom,
ITrackCancel pTrackCancel)
Identifies objects at the specified location for the given display. |
IHotLinkExpressionProperties |
IHotlinkExpression_getExpressionProperties()
Properties that describe the hyperlink expression. |
String |
ILayerGeneralProperties_getLayerDescription()
Description for the layer. |
ICursor |
insert(boolean useBuffering)
Returns a cursor that can be used to insert new Rows. |
boolean |
inWorkspace(IWorkspace workspace)
Returns TRUE if the layer is in the specified workspace. |
boolean |
isCached()
Indicates if the layer needs its own display cache. |
boolean |
isCanSelect()
Indicates if the table supports selection. |
boolean |
isDataSourceSupported(IName name)
Indicates if the specified data object name is supported by the layer. |
boolean |
isDataValid()
Indicates if the data for the layer is currently valid. |
void |
isDirty()
isDirty |
boolean |
isDisplayAnnotation()
Indicates if the layer displays annotation. |
boolean |
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 |
isMultiDimensional()
Indicates whether the data is multi-dimensional. |
boolean |
isScaleRangeReadOnly()
Indicates if the minimum and maximum scale range values are read-only. |
boolean |
isScaleSymbols()
Indicates if symbols are scaled for the layer. |
boolean |
isSelectable()
Indicates if layer is selectable. |
boolean |
isSetSelectionSymbol()
Indicates if the selected set of features is drawn using the SelectionSymbol. |
boolean |
isShowTips()
Indicates if the layer shows map tips. |
boolean |
isSupportsBrightnessChange()
Indicates if the layer supports brightness changes. |
boolean |
isSupportsContrastChange()
Indicates if the layer supports contrast changes. |
boolean |
isSupportsInteractive()
Indicates if the layer supports interactive effects changes. |
boolean |
isSupportsPublishing()
Indicates if the layer supports the publishing process. |
boolean |
isSupportsTime()
Indicates whether the layer has any time data. |
boolean |
isSupportsTransparency()
Indicates if the layer supports transparency. |
boolean |
isSymbolsAreGraduated()
Indicates if symbols are graduated. |
boolean |
isTemporary()
Indicates if the layer is a temporary layer. |
boolean |
isTimeDataCumulative()
Indicates that features will be animated cumilatively. |
boolean |
isUsesFilter()
Indicates if the current object draws using a filter. |
boolean |
isUseSymbolLevels()
Indicates if symbol levels are used for drawing. |
boolean |
isUseTime()
Indicates whether to use the time for animation purposes. |
boolean |
isValid()
Indicates if the layer is currently valid. |
boolean |
isVisible()
Indicates if the layer is currently visible. |
ICursor |
ITable_search(IQueryFilter queryFilter,
boolean recycling)
An object cursor that can be used to fetch row objects selected by the specified query. |
void |
load(IStream pstm)
load |
void |
onAddField(IObjectClassSchemaEventsOnAddFieldEvent theEvent)
This event is fired when a new field is added to the object class. |
void |
onBehaviorChanged(IObjectClassSchemaEventsOnBehaviorChangedEvent theEvent)
This event is fired when the behavior class for the object class changes. |
void |
onCreateDataset(IWorkspaceEventsOnCreateDatasetEvent theEvent)
This event is fired when a dataset is created. |
void |
onDeleteDataset(IWorkspaceEventsOnDeleteDatasetEvent theEvent)
This event is fired when a dataset is deleted. |
void |
onDeleteField(IObjectClassSchemaEventsOnDeleteFieldEvent theEvent)
This event is fired when a field is deleted from the object class. |
void |
onRenameDataset(IWorkspaceEventsOnRenameDatasetEvent theEvent)
This event is fired when a dataset is renamed. |
void |
prepareForPublishing()
Prepare the layer for the publishing process. |
void |
prepareTimeQuery(ITimeValue pTimeValue,
IQueryFilter[] pFilter)
Prepares an input query filter by appending the time expression into the where clause. |
void |
readExternal(ObjectInput in)
|
void |
removeAllRelationshipClasses()
Removes all memory relationship classes from a standalone table or layer. |
void |
removeExtension(int index)
Removes the specified extension. |
void |
removeHyperlink(int index)
Removes the hyperlink at the specified index. |
void |
removeIDefinitionExpressionEventsListener(IDefinitionExpressionEvents theListener)
removeIDefinitionExpressionEventsListener. |
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(String name)
Renames this Dataset. |
int |
rowCount(IQueryFilter queryFilter)
The number of Rows selected by the specified query. |
void |
save(IStream pstm,
int fClearDirty)
save |
IFeatureCursor |
search(IQueryFilter queryFilter,
boolean recycling)
Creates a cursor based upon the search criteria. |
IFeatureCursor |
searchDisplayFeatures(IQueryFilter queryFilter,
boolean recycling)
Creates a cursor from the display feature class based upon the search criteria. |
ICursor |
searchDisplayTable(IQueryFilter pQueryFilter,
boolean recycling)
Creates a cursor from the display table based upon the search criteria. |
ISelectionSet |
select(IQueryFilter queryFilter,
int selType,
int selOption,
IWorkspace selectionContainer)
A selection that contains the object ids selected by the specified query. |
ISelectionSet |
selectDisplayTable(IQueryFilter pQueryFilter,
int selType,
int selOption,
IWorkspace pSelWorkspace)
Creates a selection set from the display table based upon the search criteria. |
void |
selectFeatures(IQueryFilter filter,
int method,
boolean justOne)
Selects features based upon the specifed criteria and combination method. |
void |
selectionChanged()
Fires the features layer update event. |
void |
selectRows(IQueryFilter filter,
int method,
boolean justOne)
Selects rows based upon the specified criteria and combination method. |
void |
setAnnotationProperties(IAnnotateLayerPropertiesCollection props)
Annotation properties. |
void |
setAnnotationPropertiesIDByRef(IUID uid)
The UID used for annotation properties. |
void |
setAreaOfInterest(IEnvelope aoi)
The default area of interest for the layer. |
void |
setBrightness(short brightnessValue)
Layer brightness in percent (-100 - 100). |
void |
setBrowseName(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 |
setCombinationMethod(int method)
Combination method for the selection. |
void |
setContrast(short contrastValue)
Layer contrast in percent (-100 - 100). |
void |
setCurrentMapLevel(int rhs1)
Current map level for drawing symbols. |
void |
setCustomTimeExtentByRef(ITimeExtent layerVisibiltyTime)
Custom time extent during which a layer is visible. |
void |
setDataSourceName(IName name)
Name of the data object for the layer. |
void |
setDataSourceType(String text)
Data source type. |
void |
setDefinitionExpression(String expression)
Definition query expression for the existing layer. |
void |
setDisplayAnnotation(boolean value)
Indicates if the layer displays annotation. |
void |
setDisplayField(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 |
setEndTimeFieldName(String fieldName)
Name of the field that has end time for a row. |
void |
setExclusionSetByRef(IFeatureIDSet fIDs)
The set of features that are excluded from drawing. |
void |
setExpressionPropertiesByRef(IDisplayExpressionProperties displayExpressionProperties)
Properties that describe the display expression. |
void |
setExpressionPropertiesByRef(IHotLinkExpressionProperties ppHotLinkExpressionProperties)
Properties that describe the hyperlink expression. |
void |
setFeatureClassByRef(IFeatureClass fclass)
The layer's feature class. |
void |
setFieldOrder(IFieldInfoSet fieldInfoSet)
A new order for the fields. |
void |
setHotlinkField(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(String pField)
Indicates the fieldname of the layer that contains the HTML redirect URL values. |
void |
setHTMLRedirectFieldPrefix(String pPrefix)
Indicates the text to precede the HTMLRedirectField value for the redirect URL. |
void |
setHTMLRedirectFieldSuffix(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(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(String text)
Description for the layer. |
void |
setLayerWeight(double layerWeight)
Default layer position. |
void |
setMacroName(String name)
Name of macro used for the hotlink. |
void |
setMapLevel(int mapLevel)
Current map level for drawing multi-level symbols. |
void |
setMaximumScale(double maxScale)
Maximum scale (representative fraction) at which the layer will display. |
void |
setMinimumScale(double minScale)
Minimum scale (representative fraction) at which the layer will display. |
void |
setName(String name)
Layer name. |
void |
setRelationshipClassByRef(IRelationshipClass relClass)
The current relationship class used to display related fields. |
void |
setRelativeBase(String basePath)
Base path used when storing relative path names. |
void |
setRendererByRef(IFeatureRenderer renderer)
Renderer used to draw the layer. |
void |
setRendererPropertyPageClassID(IUID clsid)
Class id of the property page for the renderer. |
void |
setScale(double rhs1)
The current scale of the display. |
void |
setScaleSymbols(boolean scale)
Indicates if symbols are scaled for the layer. |
void |
setSearchOrder(int order)
Flag that specifies the search order used when applying a mixed attribute-spatial query. |
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 |
setStartTimeFieldName(String fieldName)
Name of the field that has start time for a row. |
void |
setSupportsInteractive(boolean supported)
Indicates if the layer supports interactive effects changes. |
void |
setSymbolsAreGraduated(boolean symbolsAreGraduated)
Indicates if symbols are graduated. |
void |
setTemporary(boolean temporary)
Indicates if the layer is a temporary layer. |
void |
setTimeDataCumulative(boolean cumilative)
Indicates that features will be animated cumilatively. |
void |
setTimeDimensionFormat(String format)
Returns the format of the dimension that represents time. |
void |
setTimeDimensionName(String fieldName)
Returns the name of the dimension that represents time. |
void |
setTimeInterval(double interval)
Returns recommended time interval to be used to animate this layer/ table. |
void |
setTimeIntervalUnits(int units)
Returns recommended time interval units to be used to animate this layer/ table. |
void |
setTimeOffset(double timeOffset)
Returns time offset that needs to be applied to the data for drawing. |
void |
setTimeOffsetUnits(int units)
Returns recommended time interval units to be used to animate this layer/ table. |
void |
setTimeReferenceByRef(ITimeReference nativeTimeReference)
Time reference for the data. |
void |
setTimeValueFormat(String format)
Time value format if the field name is of the string format. |
void |
setTrackIDFieldName(String fieldName)
Field that contains the rows that uniquely identifies the object whose time is being tracked. |
void |
setTransparency(short alpha)
Layer transparency in percent (0-100). |
void |
setUseSymbolLevels(boolean useSymbolLevels)
Indicates if symbol levels are used for drawing. |
void |
setUseTime(boolean useTime)
Indicates whether to use the time for animation purposes. |
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(ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public FeatureLayer() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic FeatureLayer(Object obj) throws IOException
FeatureLayer theFeatureLayer = (FeatureLayer) obj;
obj
to FeatureLayer
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public void addILayerEventsListener(ILayerEvents theListener) throws IOException
theListener
- An object that implements the com.esri.arcgis.carto.ILayerEvents interface.
IOException
- If there are communications problems.public void removeILayerEventsListener(ILayerEvents theListener) throws IOException
theListener
- An object that implements the com.esri.arcgis.carto.ILayerEvents interface.
IOException
- If there are communications problems.public void addIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener) throws IOException
theListener
- An object that implements the com.esri.arcgis.carto.IFeatureLayerSelectionEvents interface.
IOException
- If there are communications problems.public void removeIFeatureLayerSelectionEventsListener(IFeatureLayerSelectionEvents theListener) throws IOException
theListener
- An object that implements the com.esri.arcgis.carto.IFeatureLayerSelectionEvents interface.
IOException
- If there are communications problems.public void addIDefinitionExpressionEventsListener(IDefinitionExpressionEvents theListener) throws IOException
theListener
- An object that implements the com.esri.arcgis.carto.IDefinitionExpressionEvents interface.
IOException
- If there are communications problems.public void removeIDefinitionExpressionEventsListener(IDefinitionExpressionEvents theListener) throws IOException
theListener
- An object that implements the com.esri.arcgis.carto.IDefinitionExpressionEvents interface.
IOException
- If there are communications problems.public IFeatureClass getFeatureClass() throws IOException, AutomationException
The FeatureClass data source for the layer.
getFeatureClass
in interface IFeatureLayer
getFeatureClass
in interface IFeatureLayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFeatureClassByRef(IFeatureClass fclass) throws IOException, AutomationException
setFeatureClassByRef
in interface IFeatureLayer
setFeatureClassByRef
in interface IFeatureLayer2
fclass
- A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getDataSourceType() throws IOException, AutomationException
Describes the type of data referenced by the feature layer. In ArcMap and ArcCatalog this description appears on the layer's properties dialog on the Source tab after "Data Type:"
Here is a list of default values for DataSourceType for common feature layer types:
Layer Type | Value |
---|---|
Personal Geodatabase | "Personal Geodatabase Feature Class" |
SDE | "SDE Feature Class" |
Shapefile | "Shapefile Feature Class" |
ArcInfo or PC ArcInfo Coverage (annotation) | "Annotation Feature Class" |
ArcInfo or PC ArcInfo Coverage (point) | "Point Feature Class" |
ArcInfo or PC ArcInfo Coverage (line) | "Arc Feature Class" |
ArcInfo or PC ArcInfo Coverage (polygon) | "Polygon Feature Class" |
Edge | "StreetMap Feature Class" |
CAD (annotation) | "CAD Annotation Feature Class" |
CAD (point) | "CAD Point Feature Class" |
CAD (line) | "CAD Polyline Feature Class" |
CAD (polygon) | "CAD Polygon Feature Class" |
getDataSourceType
in interface IFeatureLayer
getDataSourceType
in interface IFeatureLayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDataSourceType(String text) throws IOException, AutomationException
setDataSourceType
in interface IFeatureLayer
setDataSourceType
in interface IFeatureLayer2
text
- The text (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getDisplayField() throws IOException, AutomationException
The name of the layer's primary display field.
Usually this field name contains the string "name", or is the first string field found in the layer's attributes. This field is used to show map tips for the layer. The value of this property must match the name of one of the fields in the layer's FeatureClass.
getDisplayField
in interface IFeatureLayer
getDisplayField
in interface IFeatureLayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDisplayField(String fieldName) throws IOException, AutomationException
setDisplayField
in interface IFeatureLayer
setDisplayField
in interface IFeatureLayer2
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSelectable() throws IOException, AutomationException
Indicates whether the layer's features are selectable.
The default value for Selectable is False.
isSelectable
in interface IFeatureLayer
isSelectable
in interface IFeatureLayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSelectable(boolean value) throws IOException, AutomationException
setSelectable
in interface IFeatureLayer
setSelectable
in interface IFeatureLayer2
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFeatureCursor search(IQueryFilter queryFilter, boolean recycling) throws IOException, AutomationException
Use this method to return a read-only cursor of the layer's features.
If there is a definition query set on the layer, the Search method will automatically work on the subset of features in the layer that meet the definition criteria. You specify an additional query that will be applied after the layer's definition query by passing valid IQueryFilter object for the QueryFilter parameter.
This Search method will not work on joined fields. If the FeatureLayer has any joins, you should use the IGeoFeatureLayer::SearchDisplayFeatures method instead.
You cannot use the cursor returned by IFeatureLayer::Search to update features, instead use IFeatureClass::Update.
Recycling specifies whether the resulting feature cursor will be recycling or non-recycling. Use True for recycling cursor and False for a non-recycling cursor. See the topic for IFeatureClass::Search for more information.
search
in interface IFeatureLayer
search
in interface IFeatureLayer2
queryFilter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling
- The recycling (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isScaleSymbols() throws IOException, AutomationException
Indicates whether the symbols for this layer will respect the reference scale of the map containing the layer. Set this property to True for your layer and set a map reference scale to have your layer symbology scale as you zoom in and out.
isScaleSymbols
in interface IFeatureLayer
isScaleSymbols
in interface IFeatureLayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setScaleSymbols(boolean scale) throws IOException, AutomationException
setScaleSymbols
in interface IFeatureLayer
setScaleSymbols
in interface IFeatureLayer2
scale
- The scale (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getName() throws IOException, AutomationException
Use this property to associate a string with a layer.
getName
in interface ILayer
getName
in interface ILayer2
getName
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setName(String name) throws IOException, AutomationException
setName
in interface ILayer
setName
in interface ILayer2
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isValid() throws IOException, AutomationException
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.
isValid
in interface ILayer
isValid
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getAreaOfInterest() throws IOException, AutomationException
Returns the spatial-referenced extent of the layer.
getAreaOfInterest
in interface ILayer
getAreaOfInterest
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMinimumScale() throws IOException, AutomationException
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.
getMinimumScale
in interface ILayer
getMinimumScale
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMinimumScale(double minScale) throws IOException, AutomationException
setMinimumScale
in interface ILayer
setMinimumScale
in interface ILayer2
minScale
- The minScale (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMaximumScale() throws IOException, AutomationException
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.
getMaximumScale
in interface ILayer
getMaximumScale
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMaximumScale(double maxScale) throws IOException, AutomationException
setMaximumScale
in interface ILayer
setMaximumScale
in interface ILayer2
maxScale
- The maxScale (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isVisible() throws IOException, AutomationException
isVisible
in interface ILayer
isVisible
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setVisible(boolean visible) throws IOException, AutomationException
setVisible
in interface ILayer
setVisible
in interface ILayer2
visible
- The visible (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isShowTips() throws IOException, AutomationException
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.
isShowTips
in interface ILayer
isShowTips
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setShowTips(boolean show) throws IOException, AutomationException
setShowTips
in interface ILayer
setShowTips
in interface ILayer2
show
- The show (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTipText(double x, double y, double tolerance) throws IOException, AutomationException
getTipText
in interface ILayer
getTipText
in interface ILayer2
x
- The x (in)y
- The y (in)tolerance
- The tolerance (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCached() throws IOException, AutomationException
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.
isCached
in interface ILayer
isCached
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCached(boolean cached) throws IOException, AutomationException
Informational property. Container is responsible for cache management.
setCached
in interface ILayer
setCached
in interface ILayer2
cached
- The cached (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSupportedDrawPhases() throws IOException, AutomationException
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.
getSupportedDrawPhases
in interface ILayer
getSupportedDrawPhases
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSpatialReferenceByRef(ISpatialReference rhs1) throws IOException, AutomationException
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.
setSpatialReferenceByRef
in interface ILayer
setSpatialReferenceByRef
in interface ILayer2
rhs1
- A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) throws IOException, AutomationException
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.
draw
in interface ILayer
draw
in interface ILayer2
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getShapeType() throws IOException, AutomationException
Returns the basic geometry type of the layer's underlying feature class. See IFeatureClass::ShapeType for more information.
getShapeType
in interface IFeatureLayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void expandRegionForSymbols(IDisplay display, IGeometry region) throws IOException, AutomationException
expandRegionForSymbols
in interface IFeatureLayer2
expandRegionForSymbols
in interface ILayerSymbologyExtents
display
- A reference to a com.esri.arcgis.display.IDisplay (in)region
- A reference to a com.esri.arcgis.geometry.IGeometry (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFeatureRenderer getRenderer() throws IOException, AutomationException
getRenderer
in interface IGeoFeatureLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRendererByRef(IFeatureRenderer renderer) throws IOException, AutomationException
setRendererByRef
in interface IGeoFeatureLayer
renderer
- A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IUID getRendererPropertyPageClassID() throws IOException, AutomationException
getRendererPropertyPageClassID
in interface IGeoFeatureLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRendererPropertyPageClassID(IUID clsid) throws IOException, AutomationException
setRendererPropertyPageClassID
in interface IGeoFeatureLayer
clsid
- A reference to a com.esri.arcgis.system.IUID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDisplayAnnotation() throws IOException, AutomationException
Indicates whether dynamic labeling is on for the layer. Use this property to see if labeling is on for a layer, or to toggle labeling on or off.
isDisplayAnnotation
in interface IGeoFeatureLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDisplayAnnotation(boolean value) throws IOException, AutomationException
setDisplayAnnotation
in interface IGeoFeatureLayer
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IUID getAnnotationPropertiesID() throws IOException, AutomationException
Indicates the CLSID of the labeling properties used to label the layer.
ArcGIS provides two engines that can be used for labeling, the ESRI Standard Labeling Engine and the ESRI Maplex Labeling Engine.
You can use AnnotationPropertiesID determine which engine is being used by the layer to label features.
ESRI Standard Labeling Engine: GUID for LabelEngineLayerProperties = "{01004145-0D1C-11D2-A26F-080009B6F22B}"
ESRI Maplex Labeling Engine: GUID for MaplexLabelEngineLayerProperties = "{20664808-0D1C-11D2-A26F-080009B6F22B}"
You should not set this property. The labeling engine set for the map controls how each layer in the map will be labeled. To set this use IMap::AnnotationEngine. When the label engine is changed, the label properties of the all layers in the map will automatically be changed to properties of the new label engine.
If have a standalone layer that is not in a map, you can translate the properties to the other label engine by using IAnnotationPropertiesConverter on the coclass MaplexAnnotationPropertiesConverter.
getAnnotationPropertiesID
in interface IGeoFeatureLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAnnotationPropertiesIDByRef(IUID uid) throws IOException, AutomationException
setAnnotationPropertiesIDByRef
in interface IGeoFeatureLayer
uid
- A reference to a com.esri.arcgis.system.IUID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IAnnotateLayerPropertiesCollection getAnnotationProperties() throws IOException, AutomationException
Provides access to the labeling properites for the layer.
A feature layer's labeling properties are accessed via this property which returns a collection. Each item in the collection is an IAnnotateLayerProperties object that represents a label class. To learn more, see IAnnotateLayerProperties.
getAnnotationProperties
in interface IGeoFeatureLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAnnotationProperties(IAnnotateLayerPropertiesCollection props) throws IOException, AutomationException
setAnnotationProperties
in interface IGeoFeatureLayer
props
- A reference to a com.esri.arcgis.carto.IAnnotateLayerPropertiesCollection (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCurrentMapLevel(int rhs1) throws IOException, AutomationException
When symbol level drawing is used, this property is used by the framework to communicate to a layer what the current symbol level being drawn is. Priori to ArcGIS 9.0 this was the only method by which this could be communicated to a layer. At ArcGIS 9.0 and later versions, IMapLevel::MapLevel can be used for this. IMapLevel is implemented by more layers than IGeoFeatureLayer, so a layer that does not participate in symbol level drawing, for example a RasterLayer, can still know the current symbol level.
setCurrentMapLevel
in interface IGeoFeatureLayer
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFeatureIDSet getExclusionSet() throws IOException, AutomationException
Provides access to the set of features that are exluded from drawing for a layer. In ArcMap, features are added to this set when you convert features to graphics, and you can resume drawing these features, thereby removing them from the ExclusionSet, by using the Layer Properties dialog's Display tab.
When you use IDataExclusion to exclude features from drawing for a feature renderer, the excluded features will not show up in the layer's ExclusionSet.
getExclusionSet
in interface IGeoFeatureLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setExclusionSetByRef(IFeatureIDSet fIDs) throws IOException, AutomationException
setExclusionSetByRef
in interface IGeoFeatureLayer
fIDs
- A reference to a com.esri.arcgis.carto.IFeatureIDSet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFeatureClass getDisplayFeatureClass() throws IOException, AutomationException
Provides access to an IFeatureClass object that contains joined fields if present on the layer.
getDisplayFeatureClass
in interface IGeoFeatureLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFeatureCursor searchDisplayFeatures(IQueryFilter queryFilter, boolean recycling) throws IOException, AutomationException
SearchDisplayFeatures works like IFeatureLayer::Search with the added behavior that it will work on joined fields if you qualify field names. For example, if you want to search a field called "Pop1990" from a joined table called "Demog", you should used "Demog.Pop1990" for the field name in the query filter used in the search method.
The IDisplayTable::SearchDisplayTable method is a similar search method which will work on feature layers as well as other types of layers and standalone tables. If you want your code to be generic enough to work on different types of layers, you should use IDisplayTable::SearchDisplayTable.
searchDisplayFeatures
in interface IGeoFeatureLayer
queryFilter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling
- The recycling (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isScaleRangeReadOnly() throws IOException, AutomationException
Some layer types do not support a writeable MinimumScale or MaximumScale. Use this property to determine whether or not a layer supports this.
isScaleRangeReadOnly
in interface ILayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAreaOfInterest(IEnvelope aoi) throws IOException, AutomationException
setAreaOfInterest
in interface ILayer2
aoi
- A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISelectionSet getSelectionSet() throws IOException, AutomationException
getSelectionSet
in interface IFeatureSelection
getSelectionSet
in interface ITableSelection
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSelectionSetByRef(ISelectionSet selectionSet) throws IOException, AutomationException
setSelectionSetByRef
in interface IFeatureSelection
setSelectionSetByRef
in interface ITableSelection
selectionSet
- A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getCombinationMethod() throws IOException, AutomationException
getCombinationMethod
in interface IFeatureSelection
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCombinationMethod(int method) throws IOException, AutomationException
setCombinationMethod
in interface IFeatureSelection
method
- A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getBufferDistance() throws IOException, AutomationException
getBufferDistance
in interface IFeatureSelection
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBufferDistance(double distance) throws IOException, AutomationException
setBufferDistance
in interface IFeatureSelection
distance
- The distance (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSetSelectionSymbol() throws IOException, AutomationException
isSetSelectionSymbol
in interface IFeatureSelection
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSetSelectionSymbol(boolean setSymbol) throws IOException, AutomationException
setSetSelectionSymbol
in interface IFeatureSelection
setSymbol
- The setSymbol (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IColor getSelectionColor() throws IOException, AutomationException
getSelectionColor
in interface IFeatureSelection
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSelectionColorByRef(IColor color) throws IOException, AutomationException
setSelectionColorByRef
in interface IFeatureSelection
color
- A reference to a com.esri.arcgis.display.IColor (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISymbol getSelectionSymbol() throws IOException, AutomationException
getSelectionSymbol
in interface IFeatureSelection
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSelectionSymbolByRef(ISymbol symbol) throws IOException, AutomationException
setSelectionSymbolByRef
in interface IFeatureSelection
symbol
- A reference to a com.esri.arcgis.display.ISymbol (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void add(IFeature feature) throws IOException, AutomationException
add
in interface IFeatureSelection
feature
- A reference to a com.esri.arcgis.geodatabase.IFeature (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void selectFeatures(IQueryFilter filter, int method, boolean justOne) throws IOException, AutomationException
selectFeatures
in interface IFeatureSelection
filter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)method
- A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)justOne
- The justOne (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void clear() throws IOException, AutomationException
clear
in interface IFeatureSelection
clear
in interface ITableSelection
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void selectionChanged() throws IOException, AutomationException
selectionChanged
in interface IFeatureSelection
selectionChanged
in interface ITableSelection
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getDefinitionExpression() throws IOException, AutomationException
getDefinitionExpression
in interface IFeatureLayerDefinition
getDefinitionExpression
in interface IFeatureLayerDefinition2
getDefinitionExpression
in interface ITableDefinition
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDefinitionExpression(String expression) throws IOException, AutomationException
setDefinitionExpression
in interface IFeatureLayerDefinition
setDefinitionExpression
in interface IFeatureLayerDefinition2
setDefinitionExpression
in interface ITableDefinition
expression
- The expression (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISelectionSet getDefinitionSelectionSet() throws IOException, AutomationException
You can use the DefintionSelectionSet property to get the selection set that was used to define the new layer created by the IFeatureLayerDefintion::CreateSelectionLayer method. Note, before calling CreateSelectionLayer, the selection set returned by DefintionSelectionSet will be Nothing. Therefore, you can only use this property after you have called the CreateSelectionLayer method.
getDefinitionSelectionSet
in interface IFeatureLayerDefinition
getDefinitionSelectionSet
in interface IFeatureLayerDefinition2
getDefinitionSelectionSet
in interface ITableDefinition
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFeatureLayer createSelectionLayer(String layerName, boolean useCurrentSelection, String joinTableNames, String expression) throws IOException, AutomationException
createSelectionLayer
in interface IFeatureLayerDefinition
createSelectionLayer
in interface IFeatureLayerDefinition2
layerName
- The layerName (in)useCurrentSelection
- The useCurrentSelection (in)joinTableNames
- The joinTableNames (in)expression
- The expression (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRelationshipClass getRelationshipClass() throws IOException, AutomationException
RelClass must be a defined relationship class on the base feature class.
getRelationshipClass
in interface IDisplayRelationshipClass
getRelationshipClass
in interface IFeatureLayerDefinition
getRelationshipClass
in interface IFeatureLayerDefinition2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRelationshipClassByRef(IRelationshipClass relClass) throws IOException, AutomationException
setRelationshipClassByRef
in interface IFeatureLayerDefinition
setRelationshipClassByRef
in interface IFeatureLayerDefinition2
relClass
- A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSearchOrder() throws IOException, AutomationException
getSearchOrder
in interface IFeatureLayerDefinition2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSearchOrder(int order) throws IOException, AutomationException
setSearchOrder
in interface IFeatureLayerDefinition2
order
- A com.esri.arcgis.geodatabase.esriSearchOrder constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISpatialReference getSpatialReference() throws IOException, AutomationException
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.
getSpatialReference
in interface IGeoDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getExtent() throws IOException, AutomationException
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.
getExtent
in interface IGeoDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean applies(Object pUnk) throws IOException, AutomationException
Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.
CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.
applies
in interface IPropertySupport
pUnk
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canApply(Object pUnk) throws IOException, AutomationException
CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.
CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.
canApply
in interface IPropertySupport
pUnk
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getCurrent(Object pUnk) throws IOException, AutomationException
getCurrent
in interface IPropertySupport
pUnk
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object apply(Object newObject) throws IOException, AutomationException
Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.
Use the Applies and CanApply methods to determine if an Apply can be used on an object.
apply
in interface IPropertySupport
newObject
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getLegendGroupCount() throws IOException, AutomationException
The number of legend groups is determined by the implementation of the renderer, consequently this property is read only. For example, SimpleRenderer has one group, while a BiUniqueValueRenderer has any number of groups.
getLegendGroupCount
in interface ILegendInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILegendGroup getLegendGroup(int index) throws IOException, AutomationException
getLegendGroup
in interface ILegendInfo
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILegendItem getLegendItem() throws IOException, AutomationException
Layer or renderer legend information is further formatted for display in ArcMap legends. A renderer can override this formatting by returning a LegendItem for this property. ESRI renderers typically do not return anything for this property. With this configuration, legend formatting becomes a user or developer choice on the legend object.
getLegendItem
in interface ILegendInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSymbolsAreGraduated() throws IOException, AutomationException
Indicates whether the symbols used for a layer or renderer's legend vary by size.
For example the proportional symbol renderer returns True for this property.
You can use this property to distinguish between a layer symbolized with graduated color or graduated symbol type layer symbology. Both of these symbolizations use a ClassBreaksRenderer, but only a graduated symbol symbolization will return True for this property.
isSymbolsAreGraduated
in interface ILegendInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSymbolsAreGraduated(boolean symbolsAreGraduated) throws IOException, AutomationException
setSymbolsAreGraduated
in interface ILegendInfo
symbolsAreGraduated
- The symbolsAreGraduated (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getFieldCount() throws IOException, AutomationException
getFieldCount
in interface ILayerFields
getFieldCount
in interface ITableFields
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IField getField(int index) throws IOException, AutomationException
getField
in interface ILayerFields
getField
in interface ITableFields
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFieldInfo getFieldInfo(int index) throws IOException, AutomationException
getFieldInfo
in interface ILayerFields
getFieldInfo
in interface ITableFields
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int findField(String fieldName) throws IOException, AutomationException
findField
in interface ILayerFields
findField
in interface IClass
findField
in interface ITableFields
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFieldInfoSet getFieldInfos() throws IOException, AutomationException
getFieldInfos
in interface IOrderedLayerFields
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFieldOrder(IFieldInfoSet fieldInfoSet) throws IOException, AutomationException
setFieldOrder
in interface IOrderedLayerFields
fieldInfoSet
- A reference to a com.esri.arcgis.carto.IFieldInfoSet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDisplayExpressionProperties getExpressionProperties() throws IOException, AutomationException
getExpressionProperties
in interface IDisplayString
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setExpressionPropertiesByRef(IDisplayExpressionProperties displayExpressionProperties) throws IOException, AutomationException
setExpressionPropertiesByRef
in interface IDisplayString
displayExpressionProperties
- A reference to a com.esri.arcgis.carto.IDisplayExpressionProperties (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String findDisplayString(IObject pObject) throws IOException, AutomationException
findDisplayString
in interface IDisplayString
pObject
- A reference to a com.esri.arcgis.geodatabase.IObject (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray identify(IGeometry pGeom) throws IOException, AutomationException
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.
identify
in interface IIdentify
pGeom
- A reference to a com.esri.arcgis.geometry.IGeometry (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray identify(IGeometry pGeom, ITrackCancel pTrackCancel) throws IOException, AutomationException
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.
identify
in interface IIdentify2
pGeom
- A reference to a com.esri.arcgis.geometry.IGeometry (in)pTrackCancel
- A reference to a com.esri.arcgis.system.ITrackCancel (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setScale(double rhs1) throws IOException, AutomationException
setScale
in interface IIdentify2
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IName getDataSourceName() throws IOException, AutomationException
getDataSourceName
in interface IDataLayer
getDataSourceName
in interface IDataLayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDataSourceName(IName name) throws IOException, AutomationException
setDataSourceName
in interface IDataLayer
setDataSourceName
in interface IDataLayer2
name
- A reference to a com.esri.arcgis.system.IName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDataSourceSupported(IName name) throws IOException, AutomationException
isDataSourceSupported
in interface IDataLayer
isDataSourceSupported
in interface IDataLayer2
name
- A reference to a com.esri.arcgis.system.IName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean connect(IName pOptRepairName) throws IOException, AutomationException
connect
in interface IDataLayer
connect
in interface IDataLayer2
pOptRepairName
- A reference to a com.esri.arcgis.system.IName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getRelativeBase() throws IOException, AutomationException
The RelativeBase property is used internally when persisting and loading documents with a relative path. When a document has been fully loaded the path is realized to a complete path.
getRelativeBase
in interface IDataLayer
getRelativeBase
in interface IDataLayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRelativeBase(String basePath) throws IOException, AutomationException
setRelativeBase
in interface IDataLayer
setRelativeBase
in interface IDataLayer2
basePath
- The basePath (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void disconnect() throws IOException, AutomationException
disconnect
in interface IDataLayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean inWorkspace(IWorkspace workspace) throws IOException, AutomationException
inWorkspace
in interface IDataLayer2
workspace
- A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDrawingPropsDirty() throws IOException, AutomationException
isDrawingPropsDirty
in interface ILayerDrawingProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDrawingPropsDirty(boolean dirty) throws IOException, AutomationException
setDrawingPropsDirty
in interface ILayerDrawingProperties
dirty
- The dirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSmallImage() throws IOException, AutomationException
The icon used to represent the layer in ArcCatalog's 'List' and 'Details' views.
getSmallImage
in interface ILayerInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSmallSelectedImage() throws IOException, AutomationException
The icon used to represent the layer when it is selected in ArcCatalog's 'List' and 'Details' views.
getSmallSelectedImage
in interface ILayerInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getLargeImage() throws IOException, AutomationException
The icon used to represent the layer in ArcCatalog's 'Large Icon' view.
getLargeImage
in interface ILayerInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getLargeSelectedImage() throws IOException, AutomationException
The icon used to represent the layer when it is selected in ArcCatalog's 'Large Icon' view.
getLargeSelectedImage
in interface ILayerInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isUsesFilter() throws IOException, AutomationException
The UsesFilter property returns true when the object in question will draw with a filter. Drawing with a filter means means that an object that would normally draw as vector graphics will instead draw as raster. The UsesFilter property is particularly useful for detecting vector map layers that will be rasterized at time of print or export.
isUsesFilter
in interface IDisplayAdmin
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDisplayFilter(IDisplayFilter displayFilter) throws IOException, AutomationException
setDisplayFilter
in interface IDisplayFilterManager
displayFilter
- A reference to a com.esri.arcgis.display.IDisplayFilter (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDisplayFilter getDisplayFilter() throws IOException, AutomationException
getDisplayFilter
in interface IDisplayFilterManager
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getHyperlinkCount() throws IOException, AutomationException
getHyperlinkCount
in interface IHyperlinkContainer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IHyperlink getHyperlink(int index) throws IOException, AutomationException
getHyperlink
in interface IHyperlinkContainer
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHyperlinkByRef(int index, IHyperlink link) throws IOException, AutomationException
setHyperlinkByRef
in interface IHyperlinkContainer
index
- The index (in)link
- A reference to a com.esri.arcgis.carto.IHyperlink (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addHyperlink(IHyperlink link) throws IOException, AutomationException
addHyperlink
in interface IHyperlinkContainer
link
- A reference to a com.esri.arcgis.carto.IHyperlink (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void removeHyperlink(int index) throws IOException, AutomationException
removeHyperlink
in interface IHyperlinkContainer
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getHotlinkField() throws IOException, AutomationException
getHotlinkField
in interface IHotlinkContainer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHotlinkField(String fieldName) throws IOException, AutomationException
setHotlinkField
in interface IHotlinkContainer
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getHotlinkType() throws IOException, AutomationException
getHotlinkType
in interface IHotlinkContainer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHotlinkType(int linkType) throws IOException, AutomationException
setHotlinkType
in interface IHotlinkContainer
linkType
- A com.esri.arcgis.carto.esriHyperlinkType constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getMacroName() throws IOException, AutomationException
getMacroName
in interface IHotlinkMacro
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMacroName(String name) throws IOException, AutomationException
setMacroName
in interface IHotlinkMacro
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IHotLinkExpressionProperties IHotlinkExpression_getExpressionProperties() throws IOException, AutomationException
IHotlinkExpression_getExpressionProperties
in interface IHotlinkExpression
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setExpressionPropertiesByRef(IHotLinkExpressionProperties ppHotLinkExpressionProperties) throws IOException, AutomationException
setExpressionPropertiesByRef
in interface IHotlinkExpression
ppHotLinkExpressionProperties
- A reference to a com.esri.arcgis.carto.IHotLinkExpressionProperties (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String executeExpression(IObject pObject) throws IOException, AutomationException
executeExpression
in interface IHotlinkExpression
pObject
- A reference to a com.esri.arcgis.geodatabase.IObject (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSupportsTransparency() throws IOException, AutomationException
isSupportsTransparency
in interface ILayerEffects
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSupportsContrastChange() throws IOException, AutomationException
isSupportsContrastChange
in interface ILayerEffects
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSupportsBrightnessChange() throws IOException, AutomationException
isSupportsBrightnessChange
in interface ILayerEffects
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSupportsInteractive(boolean supported) throws IOException, AutomationException
setSupportsInteractive
in interface ILayerEffects
supported
- The supported (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSupportsInteractive() throws IOException, AutomationException
isSupportsInteractive
in interface ILayerEffects
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public short getTransparency() throws IOException, AutomationException
When
you set Transparency for a
FeatureLayer, a
TransparencyDisplayFilter is created and applied
to the layer. You can accomplish the same effect by manually
creating a new TransparencyDisplayFilter using IDisplayFilter, and
then assigning it to a layer using
IDisplayFilterManager.
getTransparency
in interface ILayerEffects
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTransparency(short alpha) throws IOException, AutomationException
setTransparency
in interface ILayerEffects
alpha
- The alpha (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public short getContrast() throws IOException, AutomationException
getContrast
in interface ILayerEffects
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setContrast(short contrastValue) throws IOException, AutomationException
setContrast
in interface ILayerEffects
contrastValue
- The contrastValue (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public short getBrightness() throws IOException, AutomationException
getBrightness
in interface ILayerEffects
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBrightness(short brightnessValue) throws IOException, AutomationException
setBrightness
in interface ILayerEffects
brightnessValue
- The brightnessValue (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRow createRow() throws IOException, AutomationException
The CreateRow method creates a new row in the underlying database with a system assigned object id value. A row object representing the created row is returned to the caller. The row object returned has the system assigned object ID as the value of the OIDField. All other fields are initialized to null values if they can be made null and to built-in default values appropriate to the type of the field if they cannot be made null.
The caller is responsible for setting the desired field values into the row and calling the Store method on the row. If the table represents an object class with subtypes, then it is the caller’s responsibility to set the default subtype code into the row and call the InitDefaultValues method on the row before storing, if that is the desired result. For tables without object behavior, insert cursors offer a more efficient way for inserting new rows.
createRow
in interface ITable
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRow getRow(int oID) throws IOException, AutomationException
The GetRow method returns an existing row object, given its object ID value. The caller can query the returned row object for additional object specific interfaces. The retrieved row may be modified; calling Store on the row object after changing it will trigger messages to related objects and will mark the row for committing to the database.
getRow
in interface ITable
oID
- The oID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ICursor getRows(Object oids, boolean recycling) throws IOException, AutomationException
The GetRows method returns a cursor that may be used to retrieve a set of rows specified by the input array of object id values. See the description of the Search method to understand the meaning of the recycling parameter. It is far more efficient to retrieve a set of rows using the GetRows method than it is to retrieve each individual row using the GetRow method. The retrieved rows may be modified; Store should be called on the row objects after changing them.
The oids parameter should be passed an integer array. For example:
// Get a recycling cursor for the OID array.
int[] oids = new int[] { 10844, 10853, 10871 };
ICursor cursor = table.getRows(oids, true);
getRows
in interface ITable
oids
- A Variant (in)recycling
- The recycling (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRowBuffer createRowBuffer() throws IOException, AutomationException
The CreateRowBuffer method creates a new row buffer object in memory and returns it to the caller. No row is created in the database. The returned row buffer does not have an object ID value. The caller can set values into the row buffer and use it as an argument to the InsertRow method on an insert cursor; the latter is obtained by calling the Insert method on the Table.
createRowBuffer
in interface ITable
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void updateSearchedRows(IQueryFilter queryFilter, IRowBuffer buffer) throws IOException, AutomationException
This method will edit the rows matching the query filter's constraints. The values in each row will be replaced with the corresponding field's value in the provided row buffer. The fields being edited should be specified in the query filter's SubFields property. If the row buffer contains null values, and the SubFields property is not properly set, the row's values will be overwritten with the row buffer's null values.
updateSearchedRows
in interface ITable
queryFilter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)buffer
- A reference to a com.esri.arcgis.geodatabase.IRowBuffer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deleteSearchedRows(IQueryFilter queryFilter) throws IOException, AutomationException
deleteSearchedRows
in interface ITable
queryFilter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int rowCount(IQueryFilter queryFilter) throws IOException, AutomationException
rowCount
in interface ITable
queryFilter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ICursor ITable_search(IQueryFilter queryFilter, boolean recycling) throws IOException, AutomationException
ITable_search
in interface ITable
queryFilter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling
- The recycling (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ICursor update(IQueryFilter queryFilter, boolean recycling) throws IOException, AutomationException
The Update method returns an update cursor that can be used to update or delete rows. It offers somewhat faster performance than multiple calls to Store or Delete on row objects fetched using a non-recycling search cursor for tables storing simple rows and simple features. There is no difference in performance for complex objects and features.
When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.
update
in interface ITable
queryFilter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling
- The recycling (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ICursor insert(boolean useBuffering) throws IOException, AutomationException
The Insert method returns an insert cursor that can be used to bulk insert rows. It offers significantly faster performance than multiple calls to CreateRow and Store for tables storing simple rows and simple features (that is, for tables whose CLSID is esriGeoDatabase.Row, esriGeoDatabase.Object, or esriGeoDatabase.Feature).
Insert cursors on tables containing complex objects use the CreateRow and Store methods to achieve polymorphism, and there is no difference in performance in these cases.
When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.
insert
in interface ITable
useBuffering
- The useBuffering (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISelectionSet select(IQueryFilter queryFilter, int selType, int selOption, IWorkspace selectionContainer) throws IOException, AutomationException
The Select method returns a selection set that holds either row IDs or row objects from the Table depending on the selection option. Multiple selection sets can be created on the same table. It is up to a client application or object to keep a reference on created selections and use them as appropriate. For example, a FeatureLayer creates and uses selections on a FeatureClass (a type of Table).
The selType parameter determines the type of selection set that will be created: an ID set, a snapshot, or a hybrid. See the ISelectionSet interface for a comparison of the three types.
When calling Select the selectionContainer parameter is no longer required. A null value should be passed as this parameter.
select
in interface ITable
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFields getFields() throws IOException, AutomationException
getFields
in interface IClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IIndexes getIndexes() throws IOException, AutomationException
getIndexes
in interface IClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addField(IField field) throws IOException, AutomationException
Prior to adding a new field to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
Attempting to add a new field that does not allow null values will fail, if the class already has data in it. The only solution is to recreate the class with the non-nullable field, then copy the rows from the original class into the new class.
addField
in interface IClass
field
- A reference to a com.esri.arcgis.geodatabase.IField (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deleteField(IField field) throws IOException, AutomationException
DeleteField removes the specified field from a table, object class or feature class. Fields that are required by the Geodatabase and cannot be removed include:
Prior to deleting a field from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
// Assume we have a reference to a FeatureClass (pFC) IFields pFields; IField pField; pFields = pFC.getFields(); pField = pFields.getField(pFields.findField("MyField")); pFC.deleteField(pField);
deleteField
in interface IClass
field
- A reference to a com.esri.arcgis.geodatabase.IField (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addIndex(IIndex index) throws IOException, AutomationException
Prior to adding a new index to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
addIndex
in interface IClass
index
- A reference to a com.esri.arcgis.geodatabase.IIndex (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deleteIndex(IIndex index) throws IOException, AutomationException
Prior to deleting an index from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.
deleteIndex
in interface IClass
index
- A reference to a com.esri.arcgis.geodatabase.IIndex (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isHasOID() throws IOException, AutomationException
isHasOID
in interface IClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getOIDFieldName() throws IOException, AutomationException
getOIDFieldName
in interface IClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IUID getCLSID() throws IOException, AutomationException
getCLSID
in interface IClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IUID getEXTCLSID() throws IOException, AutomationException
getEXTCLSID
in interface IClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getExtension() throws IOException, AutomationException
getExtension
in interface IClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet getExtensionProperties() throws IOException, AutomationException
getExtensionProperties
in interface IClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IName getFullName() throws IOException, AutomationException
getFullName
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getBrowseName() throws IOException, AutomationException
getBrowseName
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBrowseName(String name) throws IOException, AutomationException
setBrowseName
in interface IDataset
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getType() throws IOException, AutomationException
// Assume we have a reference to an IfeatureClass (pFeatureClass) IDataset pDataset = null;
pDataset = new IDatasetProxy(pFeatureClass);
System.out.println(pDataset.getName() + " " + pDataset.getType());
if(pFeatureClass != null){
pDataset = pFeatureClass.getFeatureDataset();
System.out.println(pDataset.getName() + " " + pDataset.getType());
}
pDataset = new IDatasetProxy(pDataset.getWorkspace());
System.out.println(pDataset.getName() + " " +
pDataset.getType());
getType
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getCategory() throws IOException, AutomationException
IDataset::Category returns a description of the category of the dataset. The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog. The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".
The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.
getCategory
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumDataset getSubsets() throws IOException, AutomationException
The Subsets property returns other Dataset objects contained in this dataset.
IDataset::Subsets is not supported for Graph objects such as a Geometric Network. To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.
getSubsets
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IWorkspace getWorkspace() throws IOException, AutomationException
The Workspace property returns the containing workspace for this dataset.
getWorkspace
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet getPropertySet() throws IOException, AutomationException
The PropertySet property is used to return any additional intrinsic properties (but not metadata properties) that may apply to the dataset. One use of this property is to distinguish between the types of File Geodatabase datafile formats. If called on a Feature Class or Table in a File Geodatabase the Datafile Format property can either be esriFGDBStandardDatafile or esriFGDBCompressedDatafile.
Most datasets do not implement this property and will either raise an error or return a null value if it's called. There are a handful of exceptions that will return property sets; these include the datasets from file geodatabases (as mentioned above) and coverages.
Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.
IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.
getPropertySet
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canCopy() throws IOException, AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
The CanCopy method is supported by:
canCopy
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDataset copy(String copyName, IWorkspace copyWorkspace) throws IOException, AutomationException
IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.
copy
in interface IDataset
copyName
- The copyName (in)copyWorkspace
- A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canDelete() throws IOException, AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
canDelete
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void delete() throws IOException, AutomationException
Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.
delete
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canRename() throws IOException, AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
canRename
in interface IDataset
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void rename(String name) throws IOException, AutomationException
IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network. In addition, certain feature classes, such as network feature classes, cannot be renamed.
rename
in interface IDataset
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumRelationshipClass getRelationshipClasses() throws IOException, AutomationException
getRelationshipClasses
in interface IRelationshipClassCollection
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumRelationshipClass findRelationshipClasses(IObjectClass objectClass, int role) throws IOException, AutomationException
findRelationshipClasses
in interface IRelationshipClassCollection
objectClass
- A reference to a com.esri.arcgis.geodatabase.IObjectClass (in)role
- A com.esri.arcgis.geodatabase.esriRelRole constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addRelationshipClass(IRelationshipClass relationshipClass) throws IOException, AutomationException
addRelationshipClass
in interface IRelationshipClassCollectionEdit
relationshipClass
- A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void removeRelationshipClass(IRelationshipClass relationshipClass) throws IOException, AutomationException
removeRelationshipClass
in interface IRelationshipClassCollectionEdit
relationshipClass
- A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void removeAllRelationshipClasses() throws IOException, AutomationException
removeAllRelationshipClasses
in interface IRelationshipClassCollectionEdit
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getExtensionCount() throws IOException, AutomationException
getExtensionCount
in interface ILayerExtensions
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getExtension(int index) throws IOException, AutomationException
getExtension
in interface ILayerExtensions
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addExtension(Object ext) throws IOException, AutomationException
addExtension
in interface ILayerExtensions
ext
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void removeExtension(int index) throws IOException, AutomationException
removeExtension
in interface ILayerExtensions
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ITable getDisplayTable() throws IOException, AutomationException
getDisplayTable
in interface IDisplayTable
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ICursor searchDisplayTable(IQueryFilter pQueryFilter, boolean recycling) throws IOException, AutomationException
QueryFilter specifies an IQueryFilterObject to be used for the search.
Recycling specifies whether the resulting cursor is recycling or non-recycling. Use True for recycling cursor and False for a non-recycling cursor.
If there is a definition query set on the layer or table, the SearchDisplayTable method will work on the subset of rows that meet the definition criteria. Otherwise, it will search the whole table.
SearchDisplayTable will return an ICursor with all of the rows that satisfy some attribute and/or spatial query as specified by an IQueryFilter object. If Nothing is given as the IQueryFilter, then the cursor will have all of the rows from the table.
This SearchDisplayTable method will also work on joined fields if you qualify the field names. For example, if you want to search a field called "Pop1990" from a joined table called "Demog", you should used "Demog.Pop1990" for the field name in the query filter used in the search method.
The Recycling parameter controls row object allocation behavior. Recycling cursors rehydrate a single row object on each fetch and can be used to optimize read-only access, for example, when drawing. It is illegal to maintain a reference on a row object returned by a recycling cursor across multiple calls to NextRow on the cursor. Row objects returned by a recycling cursor should not be modified.
Non-recycling cursors return a separate row object on each fetch. The objects returned by a non-recycling cursor may be modified and stored with polymorphic behavior. The geodatabase guarantees 'unique instance semantics' on non-recycling feature objects fetched during an edit session.
Recycling cursors should be used only for drawing and read-only access to object state. Use non-recycling search cursors to fetch objects that are to be updated.
searchDisplayTable
in interface IDisplayTable
pQueryFilter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)recycling
- The recycling (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISelectionSet selectDisplayTable(IQueryFilter pQueryFilter, int selType, int selOption, IWorkspace pSelWorkspace) throws IOException, AutomationException
selectDisplayTable
in interface IDisplayTable
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISelectionSet getDisplaySelectionSet() throws IOException, AutomationException
getDisplaySelectionSet
in interface IDisplayTable
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void onAddField(IObjectClassSchemaEventsOnAddFieldEvent theEvent) throws IOException, AutomationException
onAddField
in interface IObjectClassSchemaEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void onDeleteField(IObjectClassSchemaEventsOnDeleteFieldEvent theEvent) throws IOException, AutomationException
onDeleteField
in interface IObjectClassSchemaEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void onBehaviorChanged(IObjectClassSchemaEventsOnBehaviorChangedEvent theEvent) throws IOException, AutomationException
onBehaviorChanged
in interface IObjectClassSchemaEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getJoinType() throws IOException, AutomationException
Indicates the type of the most recent join.
getJoinType
in interface IDisplayRelationshipClass
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void displayRelationshipClass(IRelationshipClass relClass, int joinType) throws IOException, AutomationException
RelClass can be either a file or memory based relationship class, but must be defined on the base feature class.
This method internally initializes a RelQueryTable to perform a join. relClass can be can be either a predefined relationship class in a geodatabase or an in memory relationship class. For more information on relationship clases, see IRelationshipClass
displayRelationshipClass
in interface IDisplayRelationshipClass
relClass
- A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)joinType
- A com.esri.arcgis.geodatabase.esriJoinType constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getMapLevel() throws IOException, AutomationException
getMapLevel
in interface IMapLevel
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMapLevel(int mapLevel) throws IOException, AutomationException
setMapLevel
in interface IMapLevel
mapLevel
- The mapLevel (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isUseSymbolLevels() throws IOException, AutomationException
isUseSymbolLevels
in interface ISymbolLevels
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setUseSymbolLevels(boolean useSymbolLevels) throws IOException, AutomationException
setUseSymbolLevels
in interface ISymbolLevels
useSymbolLevels
- The useSymbolLevels (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ITable getAttributeTable() throws IOException, AutomationException
getAttributeTable
in interface IAttributeTable
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum) throws IOException, AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
enumConnectionPoints
in interface IConnectionPointContainer
ppEnum
- A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) throws IOException, AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
findConnectionPoint
in interface IConnectionPointContainer
riid
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)ppCP
- A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray find(String search, boolean contains, Object fields, ITrackCancel trackCancel) throws IOException, AutomationException
This method returns an reference to an Array of FeatureFindData objects. To search, pass in a reference to an Fields object along with the search string and a boolean option to return features that have attributes that contain the string. If Contains = False, only objects with an attribute that consists of the entire search string will be returned.
find
in interface IFind
search
- The search (in)contains
- The contains (in)fields
- A Variant (in)trackCancel
- A reference to a com.esri.arcgis.system.ITrackCancel (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getFindFields() throws IOException, AutomationException
getFindFields
in interface IFind
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getFindDisplayField() throws IOException, AutomationException
getFindDisplayField
in interface IFind
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getLayerWeight() throws IOException, AutomationException
The LayerWeight property defines the weight of the layer in the auto arrange order. During auto arrange, the higher weight layers are added to the map first, which means they draw lower in the draw order.
Default weights for layers are these values:
Annotation layers = 97
Points layers = 98
Polyline layers = 99
Polygon Layers = 100
getLayerWeight
in interface ILayerPosition
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLayerWeight(double layerWeight) throws IOException, AutomationException
setLayerWeight
in interface ILayerPosition
layerWeight
- The layerWeight (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCanSelect() throws IOException, AutomationException
Use CanSelect to determine if you can open a selection set on the table. A situation where CanSelect will be False is a standalone database table without an OID column.
isCanSelect
in interface ITableCapabilities
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addRow(IRow row) throws IOException, AutomationException
addRow
in interface ITableSelection
row
- A reference to a com.esri.arcgis.geodatabase.IRow (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void selectRows(IQueryFilter filter, int method, boolean justOne) throws IOException, AutomationException
The justOne parameter tells the search to stop once it has found one feature.
selectRows
in interface ITableSelection
filter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)method
- A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)justOne
- The justOne (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSupportsPublishing() throws IOException, AutomationException
isSupportsPublishing
in interface IPublishLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getPublishingDescription() throws IOException, AutomationException
getPublishingDescription
in interface IPublishLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDataValid() throws IOException, AutomationException
isDataValid
in interface IPublishLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getDataDetails(String bsPadding) throws IOException, AutomationException
getDataDetails
in interface IPublishLayer
bsPadding
- The bsPadding (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void prepareForPublishing() throws IOException, AutomationException
prepareForPublishing
in interface IPublishLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTemporary(boolean temporary) throws IOException, AutomationException
setTemporary
in interface ITemporaryLayer
temporary
- The temporary (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isTemporary() throws IOException, AutomationException
isTemporary
in interface ITemporaryLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getLastMinimumScale() throws IOException, AutomationException
getLastMinimumScale
in interface ILayerGeneralProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getLastMaximumScale() throws IOException, AutomationException
getLastMaximumScale
in interface ILayerGeneralProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String ILayerGeneralProperties_getLayerDescription() throws IOException, AutomationException
ILayerGeneralProperties_getLayerDescription
in interface ILayerGeneralProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLayerDescription(String text) throws IOException, AutomationException
setLayerDescription
in interface ILayerGeneralProperties
text
- The text (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isHTMLPopupEnabled() throws IOException, AutomationException
isHTMLPopupEnabled
in interface IHTMLPopupIdentify
isHTMLPopupEnabled
in interface IHTMLPopupInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHTMLPopupEnabled(boolean pEnabled) throws IOException, AutomationException
setHTMLPopupEnabled
in interface IHTMLPopupInfo
pEnabled
- The pEnabled (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getHTMLPresentationStyle() throws IOException, AutomationException
getHTMLPresentationStyle
in interface IHTMLPopupIdentify
getHTMLPresentationStyle
in interface IHTMLPopupInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHTMLPresentationStyle(int pStyle) throws IOException, AutomationException
setHTMLPresentationStyle
in interface IHTMLPopupInfo
pStyle
- A com.esri.arcgis.carto.esriHTMLPopupStyle constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isHTMLHideFieldNameColumn() throws IOException, AutomationException
isHTMLHideFieldNameColumn
in interface IHTMLPopupInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHTMLHideFieldNameColumn(boolean pHide) throws IOException, AutomationException
setHTMLHideFieldNameColumn
in interface IHTMLPopupInfo
pHide
- The pHide (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getHTMLRedirectField() throws IOException, AutomationException
getHTMLRedirectField
in interface IHTMLPopupInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHTMLRedirectField(String pField) throws IOException, AutomationException
setHTMLRedirectField
in interface IHTMLPopupInfo
pField
- The pField (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getHTMLRedirectFieldPrefix() throws IOException, AutomationException
getHTMLRedirectFieldPrefix
in interface IHTMLPopupInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHTMLRedirectFieldPrefix(String pPrefix) throws IOException, AutomationException
setHTMLRedirectFieldPrefix
in interface IHTMLPopupInfo
pPrefix
- The pPrefix (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getHTMLRedirectFieldSuffix() throws IOException, AutomationException
getHTMLRedirectFieldSuffix
in interface IHTMLPopupInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHTMLRedirectFieldSuffix(String pSufix) throws IOException, AutomationException
setHTMLRedirectFieldSuffix
in interface IHTMLPopupInfo
pSufix
- The pSufix (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getHTMLXSLStylesheet() throws IOException, AutomationException
getHTMLXSLStylesheet
in interface IHTMLPopupInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHTMLXSLStylesheet(String pStyleSheet) throws IOException, AutomationException
setHTMLXSLStylesheet
in interface IHTMLPopupInfo
pStyleSheet
- The pStyleSheet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isHTMLUseCodedDomainValues() throws IOException, AutomationException
isHTMLUseCodedDomainValues
in interface IHTMLPopupInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHTMLUseCodedDomainValues(boolean pCodedValues) throws IOException, AutomationException
setHTMLUseCodedDomainValues
in interface IHTMLPopupInfo
pCodedValues
- The pCodedValues (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getHTMLOutput(IFeature pFeature) throws IOException, AutomationException
getHTMLOutput
in interface IHTMLPopupInfo
pFeature
- A reference to a com.esri.arcgis.geodatabase.IFeature (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isHTMLDownloadAttachmentData() throws IOException, AutomationException
isHTMLDownloadAttachmentData
in interface IHTMLPopupInfo2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHTMLDownloadAttachmentData(boolean pDownloadAttachmentData) throws IOException, AutomationException
setHTMLDownloadAttachmentData
in interface IHTMLPopupInfo2
pDownloadAttachmentData
- The pDownloadAttachmentData (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String hTMLOutput(IFeature pFeature, IPropertySet pOptions) throws IOException, AutomationException
hTMLOutput
in interface IHTMLPopupInfo2
pFeature
- A reference to a com.esri.arcgis.geodatabase.IFeature (in)pOptions
- A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String hTMLIdentify(IPoint pPoint, double tolerance) throws IOException, AutomationException
hTMLIdentify
in interface IHTMLPopupIdentify
pPoint
- A reference to a com.esri.arcgis.geometry.IPoint (in)tolerance
- The tolerance (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String hTMLTipText(IPoint pPoint, double tolerance) throws IOException, AutomationException
hTMLTipText
in interface IHTMLPopupIdentify
pPoint
- A reference to a com.esri.arcgis.geometry.IPoint (in)tolerance
- The tolerance (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void hTMLIdentify(IDisplay pDisplay, IGeometry pGeometry, IPropertySet pOptions, IStringArray[] ppItemNames, IStringArray[] ppItemHTML) throws IOException, AutomationException
hTMLIdentify
in interface IHTMLPopupIdentify2
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSupportsTime() throws IOException, AutomationException
This property indicates whether the layer is able to render time-related data. If this property is false, it means that time-related data cannot be handled by the underlying software.
isSupportsTime
in interface ITimeData
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isUseTime() throws IOException, AutomationException
This property indicates whether the meta-data used to properly configure time-related rendering has been provided. The property is also used to indicate whether the layer should use the time-related meta-data to render time-related data. If the property is false, it can mean two things:
1. The layer has not yet been provided with information like the name of the attribute in the data which contains the time of each feature.
2. The layer has simply been told not to display time-related data. This may be a temporary state change desired by a user that does not want the layer to change when running an animation.
isUseTime
in interface ITimeData
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setUseTime(boolean useTime) throws IOException, AutomationException
setUseTime
in interface ITimeData
useTime
- The useTime (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ITimeReference getTimeReference() throws IOException, AutomationException
This is the time reference for the data that this layer is rendering/providing. This property is read-only in the ITimeData interface because not all layers have the ability to change the TimeReference property of the data they represent. If the layer has the ability to change this property, it will implement the ITimeTableDefinition interface, and through that interface provide the ability to change the property's value.
getTimeReference
in interface ITimeData
getTimeReference
in interface ITimeDimensionDefinition
getTimeReference
in interface ITimeTableDefinition
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ITimeExtent getFullTimeExtent() throws IOException, AutomationException
This property provides a TimeExtent which represents the time from the earliest time stamp in the data to the latests time stamp in the data.
getFullTimeExtent
in interface ITimeData
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getStartTimeFieldName() throws IOException, AutomationException
This property contains the name of the column which contains the start time for each feature. If the feature has only one associated time, then this field is used, and the EndTimeFieldName is not set.
getStartTimeFieldName
in interface ITimeTableDefinition
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setStartTimeFieldName(String fieldName) throws IOException, AutomationException
setStartTimeFieldName
in interface ITimeTableDefinition
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getEndTimeFieldName() throws IOException, AutomationException
If the data in a table has a start and an end time, this property contains the name of the column that holds the end time for each feature. If the data only has one time associated with it (it is instantaneous) then this property is not set.
getEndTimeFieldName
in interface ITimeTableDefinition
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setEndTimeFieldName(String fieldName) throws IOException, AutomationException
setEndTimeFieldName
in interface ITimeTableDefinition
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTimeValueFormat() throws IOException, AutomationException
This property contains an emumeration representing the format of the data stored in the Start Time Field and the End Time Field. The Start Time Field and the End Time Field must use the same format. Only formats allowed by this enumeration are allowed.
getTimeValueFormat
in interface ITimeTableDefinition
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeValueFormat(String format) throws IOException, AutomationException
setTimeValueFormat
in interface ITimeTableDefinition
format
- The format (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTrackIDFieldName() throws IOException, AutomationException
The TrackIDFieldName property contains the name of the field which can be used to group features by the object they represent. For example, if a table contains observations of automobiles, and each feature in the table represents the location of one automobile at one point in time, there will be one field that uniquely identifies which automobile a feature is associated with (e.g. license plate number). The TrackIDFieldName is the field that can be used to group the attributes by the real-world object that they represent (the "Track" that they belong to).
getTrackIDFieldName
in interface ITimeTableDefinition
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTrackIDFieldName(String fieldName) throws IOException, AutomationException
setTrackIDFieldName
in interface ITimeTableDefinition
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeReferenceByRef(ITimeReference nativeTimeReference) throws IOException, AutomationException
setTimeReferenceByRef
in interface ITimeDimensionDefinition
setTimeReferenceByRef
in interface ITimeTableDefinition
nativeTimeReference
- A reference to a com.esri.arcgis.system.ITimeReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ITimeExtent getCustomTimeExtent() throws IOException, AutomationException
getCustomTimeExtent
in interface ITimeTableDefinition
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCustomTimeExtentByRef(ITimeExtent layerVisibiltyTime) throws IOException, AutomationException
setCustomTimeExtentByRef
in interface ITimeTableDefinition
layerVisibiltyTime
- A reference to a com.esri.arcgis.system.ITimeExtent (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeDataCumulative(boolean cumilative) throws IOException, AutomationException
setTimeDataCumulative
in interface ITimeDataDisplay
cumilative
- The cumilative (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isTimeDataCumulative() throws IOException, AutomationException
TimeDataCumulative is true when the data should be persist on the display as it ages. This is useful in settings where the new data "builds upon" historical data. For example when displaying the location of a wild animal, this property will cause the layer to display all of the historical locations for the animal, providing a good view of the animal's territory.
isTimeDataCumulative
in interface ITimeDataDisplay
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeInterval(double interval) throws IOException, AutomationException
setTimeInterval
in interface ITimeDataDisplay
interval
- The interval (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getTimeInterval() throws IOException, AutomationException
This property represents the time interval of the data used when rendering the layer. The time interval represents the minimum expected time between changes in the data. For example, when using weather imagery that is updated every 10 minutes, you would set the time interval to 10 minutes. When using census data that is recorded every year, the time interval would be set to 1 year. Note that this property is the value of the interval, and must be set along with the units for the time interval.
getTimeInterval
in interface ITimeDataDisplay
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeIntervalUnits(int units) throws IOException, AutomationException
setTimeIntervalUnits
in interface ITimeDataDisplay
units
- A com.esri.arcgis.system.esriTimeUnits constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getTimeIntervalUnits() throws IOException, AutomationException
This property is the enumerated value representing the time units used when measuring the time interval. This property should be read/written along with the time interval value. For more information about the time interval, see the documentation on the TimeInterval property.
getTimeIntervalUnits
in interface ITimeDataDisplay
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeOffset(double timeOffset) throws IOException, AutomationException
setTimeOffset
in interface ITimeDataDisplay
timeOffset
- The timeOffset (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getTimeOffset() throws IOException, AutomationException
The TimeOffset is used to display data at a different time on the timeline. This is for temporary purposes only. It can be useful for comparing data sets from different time period when you need to display the two sets of data together. For example, to visualize the growth pattern of two wild fires that happened in two different years, one of the layers can be given an offset that will cause it to appear as if the fire started at the same time as the other fire. In this way the growth patterns can be seen together, and compared.
getTimeOffset
in interface ITimeDataDisplay
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeOffsetUnits(int units) throws IOException, AutomationException
setTimeOffsetUnits
in interface ITimeDataDisplay
units
- A com.esri.arcgis.system.esriTimeUnits constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getTimeOffsetUnits() throws IOException, AutomationException
This property is the enumerated value representing the time units used when measuring the time offset. This property should be read/written along with the time offset value. For more information about the time offset, see the documentation on the TimeOffset property.
getTimeOffsetUnits
in interface ITimeDataDisplay
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isMultiDimensional() throws IOException, AutomationException
isMultiDimensional
in interface ITimeDimensionDefinition
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTimeDimensionName() throws IOException, AutomationException
getTimeDimensionName
in interface ITimeDimensionDefinition
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeDimensionName(String fieldName) throws IOException, AutomationException
setTimeDimensionName
in interface ITimeDimensionDefinition
fieldName
- The fieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTimeDimensionFormat() throws IOException, AutomationException
getTimeDimensionFormat
in interface ITimeDimensionDefinition
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeDimensionFormat(String format) throws IOException, AutomationException
setTimeDimensionFormat
in interface ITimeDimensionDefinition
format
- The format (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void prepareTimeQuery(ITimeValue pTimeValue, IQueryFilter[] pFilter) throws IOException, AutomationException
prepareTimeQuery
in interface ITimeDisplayTable
pTimeValue
- A reference to a com.esri.arcgis.system.ITimeValue (in)pFilter
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in/out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray identifyEx(IDisplay pDisplay, IGeometry pGeom, ITrackCancel pTrackCancel) throws IOException, AutomationException
identifyEx
in interface IIdentifyDisplay
pDisplay
- A reference to a com.esri.arcgis.display.IDisplay (in)pGeom
- A reference to a com.esri.arcgis.geometry.IGeometry (in)pTrackCancel
- A reference to a com.esri.arcgis.system.ITrackCancel (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void onCreateDataset(IWorkspaceEventsOnCreateDatasetEvent theEvent) throws IOException, AutomationException
The OnCreateDataset method is fired after a dataset has been created.
onCreateDataset
in interface IWorkspaceEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void onRenameDataset(IWorkspaceEventsOnRenameDatasetEvent theEvent) throws IOException, AutomationException
The OnRenameDataset method is fired after a dataset has been renamed.
onRenameDataset
in interface IWorkspaceEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void onDeleteDataset(IWorkspaceEventsOnDeleteDatasetEvent theEvent) throws IOException, AutomationException
The OnDeleteDataset method is fired after a dataset has been created.
onDeleteDataset
in interface IWorkspaceEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |