com.esri.arcgis.geodatabase
Interface IQueryFilterDefinition

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IQueryFilterDefinitionProxy, QueryFilter, SpatialFilter

public interface IQueryFilterDefinition

extends java.io.Serializable

Product Availability

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

Description

The IQueryFilterDefinition interface is used to define the set of FilterDef objects that are applied to the query. This set of objects is represented by the FilterDefs property. The other property on this interface PostfixClause is a string property that allows for addition text to be appended to the SQL generated by a query filter.

Method Summary

IFilterDefs	getFilterDefs() The filter definitions specified for this query filter.
java.lang.String	getPostfixClause() A clause that will be appended to the end of the where clause.
void	setFilterDefsByRef(IFilterDefs filters) The filter definitions specified for this query filter.
void	setPostfixClause(java.lang.String clause) A clause that will be appended to the end of the where clause.

Method Detail

getPostfixClause

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

A clause that will be appended to the end of the where clause. Most commonly used for clauses like ORDER BY.

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 a GROUP BY or ORDER BY clause for the query. Historically, these clauses have 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.

Please note, file geodatabase do not support the PostFixClause property, any specifications within the PostFixClause will be ignored.

Returns:

The clause

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPostfixClause

public void setPostfixClause(java.lang.String clause)
                      throws java.io.IOException,
                             AutomationException

A clause that will be appended to the end of the where clause. Most commonly used for clauses like ORDER BY.

Parameters:

clause - The clause (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFilterDefs

public IFilterDefs getFilterDefs()
                          throws java.io.IOException,
                                 AutomationException

The filter definitions specified for this query filter.

Remarks

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFilterDefsByRef

public void setFilterDefsByRef(IFilterDefs filters)
                        throws java.io.IOException,
                               AutomationException

The filter definitions specified for this query filter.

Parameters:

filters - A reference to a com.esri.arcgis.geodatabase.IFilterDefs (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.