com.esri.arcgis.carto
Interface IFeatureLayerDefinition2

All Superinterfaces:

Serializable

All Known Implementing Classes:

CadAnnotationLayer, CadastralFabricSubLayer, CadFeatureLayer, CoverageAnnotationLayer, DimensionLayer, FDOGraphicsLayer, FeatureLayer, GdbRasterCatalogLayer

public interface IFeatureLayerDefinition2
extends Serializable

Provides additional access to members that define a subset of the features from the underlying feature class.

Remarks

In addition to providing access to all of the methods and properties of IFeatureLayerDefinition, this interface has a property that specifies the query order when accessing features from the database. Use SearchOrder to specify whether to query first by spatial extent or attribute. In the ArcGIS implementation, this only applies when the layer data source is in an ArcSDE geodatabase.

Product Availability

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

Method Summary

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.
String	getDefinitionExpression() Definition query expression for the existing layer.
ISelectionSet	getDefinitionSelectionSet() The selection set that defines the subset of features in a selection layer.
IRelationshipClass	getRelationshipClass() The current relationship class used to display related fields.
int	getSearchOrder() Flag that specifies the search order used when applying a mixed attribute-spatial query.
void	setDefinitionExpression(String expression) Definition query expression for the existing layer.
void	setRelationshipClassByRef(IRelationshipClass relClass) The current relationship class used to display related fields.
void	setSearchOrder(int order) Flag that specifies the search order used when applying a mixed attribute-spatial query.

Method Detail

getDefinitionExpression

String getDefinitionExpression()
                               throws IOException,
                                      AutomationException

Definition query expression for the existing layer.

Product Availability

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

Returns:

The expression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefinitionExpression

void setDefinitionExpression(String expression)
                             throws IOException,
                                    AutomationException

Definition query expression for the existing layer.

Product Availability

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

Parameters:

expression - The expression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefinitionSelectionSet

ISelectionSet getDefinitionSelectionSet()
                                        throws IOException,
                                               AutomationException

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

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createSelectionLayer

IFeatureLayer createSelectionLayer(String layerName,
                                   boolean useCurrentSelection,
                                   String joinTableNames,
                                   String expression)
                                   throws IOException,
                                          AutomationException

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

Product Availability

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

Parameters:

layerName - The layerName (in)

useCurrentSelection - The useCurrentSelection (in)

joinTableNames - The joinTableNames (in)

expression - The expression (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationshipClass

IRelationshipClass getRelationshipClass()
                                        throws IOException,
                                               AutomationException

The current relationship class used to display related fields.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelationshipClassByRef

void setRelationshipClassByRef(IRelationshipClass relClass)
                               throws IOException,
                                      AutomationException

The current relationship class used to display related fields.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchOrder

int getSearchOrder()
                   throws IOException,
                          AutomationException

Flag that specifies the search order used when applying a mixed attribute-spatial query.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriSearchOrder constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchOrder

void setSearchOrder(int order)
                    throws IOException,
                           AutomationException

Flag that specifies the search order used when applying a mixed attribute-spatial query.

Product Availability

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

Parameters:

order - A com.esri.arcgis.geodatabase.esriSearchOrder constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.