Class ImageQueryFilterClass

Namespace
ESRI.ArcGIS.Carto
Assembly
ESRI.Server.Carto.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("0B9D971A-D026-49F3-85A0-A5BE5F6BE888")]
public class ImageQueryFilterClass : ImageQueryFilter, IImageQueryFilter, ITimeQueryFilter, ISpatialFilter, IPersistStream, IPersist, IXMLSerialize, IXMLVersionSupport, IClone, IQueryFilter2, IQueryFilter, IQueryFilterDefinition2, IQueryFilterDefinition, ISupportErrorInfo
Inheritance
ImageQueryFilterClass
Implements
Inherited Members

Constructors

ImageQueryFilterClass()

public ImageQueryFilterClass()

Properties

GeometryEx[bool]

public virtual bool GeometryEx[bool Geometry] { set; }

Parameters

Geometry bool

Property Value

bool

Explicit Interface Implementations

AddField(string)

virtual void AddField(string subField)

Parameters

subField string

Assign(IClone)

Assigns the properties of src to the receiver.

virtual void Assign(IClone src)

Parameters

src IClone

Clone()

Clones the receiver and assigns the result to *clone.

virtual IClone Clone()

Returns

IClone

Deserialize(IXMLSerializeData)

Deserializes an object from XML.

virtual void Deserialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

FilterDefs

The filter definitions specified for this query filter.

virtual IFilterDefs FilterDefs { get; set; }

Returns

IFilterDefs

Remarks

The FilterDefs property contains the set of FilterDefs objects that will be applied to the query.

FilterOwnsGeometry

Indicates whether the filter owns the query geometry.

virtual bool FilterOwnsGeometry { get; }

Returns

bool

Geometry

The query geometry used to filter results.

virtual IGeometry Geometry { get; set; }

Returns

IGeometry

Remarks

If a geometry bag is being used as the filter's query geometry, a spatial index should be created for the bag prior to any evaluation using the filter. This can be done by casting the geometry bag to the ISpatialIndex interface, setting the AllowIndexing property to true, and calling the Invalidate method.

Note that at ArcGIS 9.3 and later, setting this property to null will cause an error.

GeometryField

The name of the Geometry field to which the filter applies.

virtual string GeometryField { get; set; }

Returns

string

GetClassID(out Guid)

virtual void GetClassID(out Guid pClassID)

Parameters

pClassID Guid

GetSizeMax(out _ULARGE_INTEGER)

virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)

Parameters

pcbSize _ULARGE_INTEGER

IPersistStream_GetClassID(out Guid)

virtual void IPersistStream_GetClassID(out Guid pClassID)

Parameters

pClassID Guid

IQueryFilter2_AddField(string)

virtual void IQueryFilter2_AddField(string subField)

Parameters

subField string

IQueryFilter2_OutputSpatialReference[string]

virtual ISpatialReference IQueryFilter2_OutputSpatialReference[string FieldName] { get; set; }

Parameters

FieldName string

Returns

ISpatialReference

IQueryFilter2_SubFields

virtual string IQueryFilter2_SubFields { get; set; }

Returns

string

IQueryFilter2_WhereClause

virtual string IQueryFilter2_WhereClause { get; set; }

Returns

string

IQueryFilterDefinition2_FilterDefs

virtual IFilterDefs IQueryFilterDefinition2_FilterDefs { get; set; }

Returns

IFilterDefs

IQueryFilterDefinition2_PostfixClause

virtual string IQueryFilterDefinition2_PostfixClause { get; set; }

Returns

string

IQueryFilter_AddField(string)

Appends a single field name to the list of sub-fields.

virtual void IQueryFilter_AddField(string subField)

Parameters

subField string

Remarks

The AddField method can be used to add a field to the SubFields list before the query is executed. Adding a field will clear the default "*" value from the SubFields. Setting it back to this original "*" can be done either by setting Subfields to "*" or to "".

IQueryFilter_OutputSpatialReference[string]

The spatial reference in which to output geometry for a given field.

virtual ISpatialReference IQueryFilter_OutputSpatialReference[string FieldName] { get; set; }

Parameters

FieldName string

Returns

ISpatialReference

IQueryFilter_SubFields

The comma delimited list of field names for the filter.

virtual string IQueryFilter_SubFields { get; set; }

Returns

string

Remarks

When accessing rows from a subset of data defined by a query filter, all the fields will be present, but just those specified by SubFields will be populated with values. This ensures that the field index positions for an object remain constant no matter how it was hydrated.

When editing data, always use "*" for the SubFields property.

IQueryFilter_WhereClause

The where clause for the filter.

virtual string IQueryFilter_WhereClause { get; set; }

Returns

string

InterfaceSupportsErrorInfo(ref Guid)

virtual void InterfaceSupportsErrorInfo(ref Guid riid)

Parameters

riid Guid

IsDirty()

virtual void IsDirty()

IsEqual(IClone)

Indicates if the receiver and other have the same properties.

virtual bool IsEqual(IClone other)

Parameters

other IClone

Returns

bool

IsIdentical(IClone)

Indicates if the receiver and other are the same object.

virtual bool IsIdentical(IClone other)

Parameters

other IClone

Returns

bool

Load(IStream)

virtual void Load(IStream pstm)

Parameters

pstm IStream

MinNamespaceSupported

The minimum namespace the class can serialize to (eg the 90 namespace).

virtual string MinNamespaceSupported { get; }

Returns

string

MultidimensionalDefinition

An array of multidimensional value objects.

virtual IMultidimensionalDefinition MultidimensionalDefinition { get; set; }

Returns

IMultidimensionalDefinition

OutputSpatialReference[string]

virtual ISpatialReference OutputSpatialReference[string FieldName] { get; set; }

Parameters

FieldName string

Returns

ISpatialReference

OutputTimeReference

Output time reference.

virtual ITimeReference OutputTimeReference { get; set; }

Returns

ITimeReference

PixelSize

The query pixel size in a given spatial reference.

virtual IPoint PixelSize { get; set; }

Returns

IPoint

PostfixClause

A clause that will be appended to the SELECT statement, following the where clause. Most commonly used for clauses like ORDER BY.

virtual string PostfixClause { get; set; }

Returns

string

Remarks

The PostfixClause property allows for a postfix clause to be added to a query filter.  The PostfixClause property is a string property. It can be used to specify an ORDER BY clause for the query. Historically, this clause has not been supported due to issues with placement in the SQL generated for spatial and/or versioned queries. This property ensures proper placement of the clause in the SQL generated by the system.

PrefixClause

A clause that will be inserted between the SELECT keyword and the SELECT COLUMN LIST. Most commonly used for clauses like DISTINCT or ALL.

virtual string PrefixClause { get; set; }

Returns

string

Save(IStream, int)

virtual void Save(IStream pstm, int fClearDirty)

Parameters

pstm IStream
fClearDirty int

SearchOrder

The search order used by the filter.

virtual esriSearchOrder SearchOrder { get; set; }

Returns

esriSearchOrder

Remarks

SearchOrder gets the order in which spatial searches are applied by the RDBMS (ArcSDE). The spatial component of the search should generally be applied before the attribute component. The more spatially restrictive of the two should be used. In the following query, "Find all wells with particulate counts between 1000 and 1200 in within 5 miles of a school", the esriSearchOrderAttribute enumerator is more effective. If the filter geometry is the outline of the city of Modesto, California and the attribute query is "street_name = 'Main St.'" then esriSearchOrderSpatial should be used, as there are a large number of "Main St." records at a national level.

Please note that esriSearchOrderSpatial is the default option.  The following esriSearchOrder enumeration values are used to set the search order:

esriSearchOrderAttribute

Sets the search order to attribute first.

esriSearchOrderSpatial

Sets the search order to spatial first.







Serialize(IXMLSerializeData)

Serializes an object to XML.

virtual void Serialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

SpatialRel

The spatial relationship checked by the filter.

virtual esriSpatialRelEnum SpatialRel { get; set; }

Returns

esriSpatialRelEnum

SpatialRelDescription

The array elements which describe the spatial relation between the query geometry and the requested geometries. There are 9 chars in this string which can be either 'F', 'T' or ''; e.g., TTFFT***' represents CONTAIN.

virtual string SpatialRelDescription { get; set; }

Returns

string

Remarks

The SpatialRelDescription allows the comparison of any spatial relationship between two geometries. A spatial relationship is defined by the intersections between the boundary, interior, and exterior of the query geometry and the requested geometry.

All of the spatial relationships defined by the esriSpatialRelEnum enumeration can be duplicated using this property.


Interior:
The interior of a shape is defined as the entire shape minus its boundary. All shapes have interior.

Boundary:
Linear and area shapes have boundaries, but point shapes do not. The boundary of linear shapes consists of the end points of all linear parts. The boundary of area shapes consists of the linear boundary of the polygon shell(s).

Exterior:
The area outside a shape. All shapes have an exterior.







Each element for the first shape, the query geometry, may be tested against each element of the second shape, the requested geometry, giving nine possible spatial intersections as listed in the table below:

Query Geometry Requested Geometry
1 interior interior
2 interior boundary
3 interior exterior
4 boundary interior
5 boundary boundary
6 boundary exterior
7 exterior interior
8 exterior boundary
9 exterior exterior


The nine-characters string expected by ISpatialFilter::SpatialRelDescription, is used to specify whether the intersection of each of the elements in the array is true (T), false (F), or not tested (*).

For instance, in 'FFFTTT***', relationships 1-3 must be false, relationships 4-6 must be true, and relationships 7-9 are not tested.

Note that any two shapes' exteriors always intersect.

Example Strings

Shares a boundary: '****T***'

Shares a boundary and interiors intersect: 'T***T****'

Shares a boundary and interiors do not intersect: 'F***T****'

Does not touch the boundary and interiors intersect: 'T***F****'





Approximate  esriSpatialRelEnum SpatialRelDescription Strings 
Relation Query Geometry Requested Geometry String
Contains Line Line TT*FFT***
Contains Point Line TT*FFT***
Contains Point Point T********
Contains Line Poly TT*FFT***
Contains Poly Poly TT*FFT***
Crosses Line Line TF*FF****
Crosses Poly Line TT**F****
Crosses Line Poly TT**T****
Overlaps Line Line TT*T*****
Overlaps Point Point T********
Overlaps Poly Poly TT*T*****
Touch Line Line FF*FT****
Touch Poly Line FF*FT****
Touch Line Poly FF*FT****
Touch Poly Poly FF*FT****
Within Line Line TF**F****
Within Point Line T********
Within Point Point T********
Within Line Poly TF**F****
Within Poly Poly TF**F****



 

SpatialResolution

The spatial resolution in which to output geometry.

virtual double SpatialResolution { get; set; }

Returns

double

SubFields

virtual string SubFields { get; set; }

Returns

string

TimeRelation

Time relation for the time query.

virtual esriTimeRelation TimeRelation { get; set; }

Returns

esriTimeRelation

TimeValue

Time value.

virtual ITimeValue TimeValue { get; set; }

Returns

ITimeValue

WhereClause

virtual string WhereClause { get; set; }

Returns

string

set_GeometryEx(IGeometry, bool)

virtual void set_GeometryEx(IGeometry Geometry, bool A_2)

Parameters

Geometry IGeometry
A_2 bool