com.esri.arcgis.geodatabase
Interface IReplicaFilterDescriptionEdit

All Superinterfaces:
Serializable
All Known Implementing Classes:
ReplicaDescription

public interface IReplicaFilterDescriptionEdit
extends Serializable

Provides access to members that set a replica's properties.

Remarks

To perform a check out or a data extraction, the properties in the IReplicaFilterDescriptionEdit interface must be set to define the rows to check out or extract. If none of these properties is set, all rows are included for all datasets.

This interface only allows properties to be set. The IReplicaFilterDescription interface can be used to get these settings.

Three types of filters can be applied using this interface. These include selection sets, where clauses and boundary geometries. In order of for data to be included, it must satisfy all filters that are applied. For example, if selection and geometry filters are applied, only selected features that are inside a bounding geometry will be included.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void setGeometryByRef(IGeometry rhs1)
          The geometry used to determine which features to extract or check out.
 void setRowsType(int index, int rhs2)
          Replica row type options.
 void setSpatialRelation(int rhs1)
          The spatial operator used for a replica.
 void setTableDefQuery(int index, String rhs2)
          The definition query to use when checking out a dataset.
 void setTableSelectionByRef(int index, ISelectionSet rhs2)
          The selection set to use when checking out a dataset.
 void setTableUsesDefQuery(int index, boolean rhs2)
          Indicates if a definition query will be used when checking out a dataset.
 void setTableUsesQueryGeometry(int index, boolean rhs2)
          Indicates if a spatial extent will be used when checking out a dataset.
 void setTableUsesSelection(int index, boolean rhs2)
          Indicates if a selection will be used when checking out a dataset.
 

Method Detail

setGeometryByRef

void setGeometryByRef(IGeometry rhs1)
                      throws IOException,
                             AutomationException
The geometry used to determine which features to extract or check out.

Remarks

Set this property if you want to add an association with the specified shape to determine the features to check out or extract. The association is defined by the SpatialRelation property. For example, if the Geometry is a polygon and the SpatialRelation is esriSpatialRelIntersects, any features that intersect the polygon are checked out.

The SpatialReference of the geometry is significant. Data from the check-out feature classes gets projected into this spatial reference when the geometry association is applied. If the spatial reference of the geometry is not set, the features you expect to get checked out or extracted may not be included.

By default, the geometry is applied to all datasets in the replica description during a check out or extraction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
rhs1 - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpatialRelation

void setSpatialRelation(int rhs1)
                        throws IOException,
                               AutomationException
The spatial operator used for a replica.

Remarks

This property defines how the shape set for the Geometry property is applied during check out. For example, if the geometry is a polygon and the SpatialRelation is esriSpatialRelIntersects, any features that intersect the polygon are checked out.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
rhs1 - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTableUsesQueryGeometry

void setTableUsesQueryGeometry(int index,
                               boolean rhs2)
                               throws IOException,
                                      AutomationException
Indicates if a spatial extent will be used when checking out a dataset.

Product Availability

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

Parameters:
index - The index (in)
rhs2 - The rhs2 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTableUsesSelection

void setTableUsesSelection(int index,
                           boolean rhs2)
                           throws IOException,
                                  AutomationException
Indicates if a selection will be used when checking out a dataset.

Product Availability

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

Parameters:
index - The index (in)
rhs2 - The rhs2 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTableUsesDefQuery

void setTableUsesDefQuery(int index,
                          boolean rhs2)
                          throws IOException,
                                 AutomationException
Indicates if a definition query will be used when checking out a dataset.

Product Availability

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

Parameters:
index - The index (in)
rhs2 - The rhs2 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTableSelectionByRef

void setTableSelectionByRef(int index,
                            ISelectionSet rhs2)
                            throws IOException,
                                   AutomationException
The selection set to use when checking out a dataset.

Remarks

This property allows you to set a SelectionSet as a filter.

The IReplicaDescription::FindTable method can be used to return the index of a specific dataset. The IReplicaDescription::TableName and IReplicaDescription::TableNameCount properties can be used to cycle through all checked out datasets.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
index - The index (in)
rhs2 - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTableDefQuery

void setTableDefQuery(int index,
                      String rhs2)
                      throws IOException,
                             AutomationException
The definition query to use when checking out a dataset.

Product Availability

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

Parameters:
index - The index (in)
rhs2 - The rhs2 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRowsType

void setRowsType(int index,
                 int rhs2)
                 throws IOException,
                        AutomationException
Replica row type options.

Product Availability

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

Parameters:
index - The index (in)
rhs2 - A com.esri.arcgis.geodatabase.esriRowsType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.