com.esri.arcgis.geodatabase

Class QueryFilter

java.lang.Object

com.esri.arcgis.geodatabase.QueryFilter

All Implemented Interfaces:

IQueryFilter, IQueryFilter2, IQueryFilterDefinition, IQueryFilterDefinition2, IQueryFilterDefinition3, IQueryFilterFIDSet, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class QueryFilter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IQueryFilter, IQueryFilter2, IQueryFilterDefinition, IQueryFilterDefinition2, IQueryFilterDefinition3, IQueryFilterFIDSet, IClone, IPersistStream, IXMLSerialize, java.io.Externalizable

COM Class 'QueryFilter'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description 'Esri Query Filter object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.geodatabase.IQueryFilter2

IID, IIDe5b21410_17a6_11d4_9f4b_00c04f79927c, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IQueryFilter

IIDfdfebd93_ed75_11d0_9a95_080009ec734b

Fields inherited from interface com.esri.arcgis.geodatabase.IQueryFilterDefinition3

IID, IIDadfe656b_a187_4cd2_add3_4f067f61d986, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IQueryFilterDefinition2

IID45096447_06ff_4e5e_a260_9213e009af29

Fields inherited from interface com.esri.arcgis.geodatabase.IQueryFilterDefinition

IID90f3c7ca_30d5_454b_ab33_fb869991edfe

Fields inherited from interface com.esri.arcgis.geodatabase.IQueryFilterFIDSet

IID, IID4430bbbe_47b7_11d4_9f52_00c04f79927c, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

Constructors

Constructor and Description
QueryFilter() Constructs a QueryFilter using ArcGIS Engine.
QueryFilter(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. QueryFilter theQueryFilter = (QueryFilter) obj;

Method Summary

Modifier and Type	Method and Description
void	addField(java.lang.String subField) Appends a single field name to the list of sub-fields.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IFIDSet	getFIDSet() The FID set used to filter results.
IFilterDefs	getFilterDefs() The filter definitions specified for this query filter.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
ISpatialReference	getOutputSpatialReference(java.lang.String fieldName) The spatial reference in which to output geometry for a given field.
void	getPaginationClause(int[] offset, int[] rowCount) A clause that controls query pagination.
java.lang.String	getPostfixClause() A clause that will be appended to the SELECT statement, following the where clause.
java.lang.String	getPrefixClause() A clause that will be inserted between the SELECT keyword and the SELECT COLUMN LIST.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
double	getSpatialResolution() The spatial resolution in which to output geometry.
java.lang.String	getSubFields() The comma delimited list of field names for the filter.
java.lang.String	getWhereClause() The where clause for the filter.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setFIDSetByRef(IFIDSet fIDSet) The FID set used to filter results.
void	setFilterDefsByRef(IFilterDefs filters) The filter definitions specified for this query filter.
void	setOutputSpatialReferenceByRef(java.lang.String fieldName, ISpatialReference outputSpatialReference) The spatial reference in which to output geometry for a given field.
void	setPaginationClause(int offset, int rowCount) A clause that controls query pagination.
void	setPostfixClause(java.lang.String clause) A clause that will be appended to the SELECT statement, following the where clause.
void	setPrefixClause(java.lang.String clause) A clause that will be inserted between the SELECT keyword and the SELECT COLUMN LIST.
void	setSpatialResolution(double resolution) The spatial resolution in which to output geometry.
void	setSubFields(java.lang.String subFields) The comma delimited list of field names for the filter.
void	setWhereClause(java.lang.String whereClause) The where clause for the filter.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

QueryFilter

public QueryFilter()
            throws java.io.IOException,
                   java.net.UnknownHostException

Constructs a QueryFilter using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

QueryFilter

public QueryFilter(java.lang.Object obj)
            throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
QueryFilter theQueryFilter = (QueryFilter) obj;

Construct a QueryFilter using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to QueryFilter.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getSubFields

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

The comma delimited list of field names for the filter.

Specified by:

getSubFields in interface IQueryFilter

Returns:

The subFields

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubFields

public void setSubFields(java.lang.String subFields)
                  throws java.io.IOException,
                         AutomationException

The comma delimited list of field names for the filter.

Specified by:

setSubFields in interface IQueryFilter

Parameters:

subFields - The subFields (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addField

public void addField(java.lang.String subField)
              throws java.io.IOException,
                     AutomationException

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

Specified by:

addField in interface IQueryFilter

Parameters:

subField - The subField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWhereClause

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

The where clause for the filter.

Specified by:

getWhereClause in interface IQueryFilter

Returns:

The whereClause

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWhereClause

public void setWhereClause(java.lang.String whereClause)
                    throws java.io.IOException,
                           AutomationException

The where clause for the filter.

Specified by:

setWhereClause in interface IQueryFilter

Parameters:

whereClause - The whereClause (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputSpatialReference

public ISpatialReference getOutputSpatialReference(java.lang.String fieldName)
                                            throws java.io.IOException,
                                                   AutomationException

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

Specified by:

getOutputSpatialReference in interface IQueryFilter

Parameters:

fieldName - The fieldName (in)

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

public void setOutputSpatialReferenceByRef(java.lang.String fieldName,
                                           ISpatialReference outputSpatialReference)
                                    throws java.io.IOException,
                                           AutomationException

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

Specified by:

setOutputSpatialReferenceByRef in interface IQueryFilter

Parameters:

fieldName - The fieldName (in)

outputSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialResolution

public double getSpatialResolution()
                            throws java.io.IOException,
                                   AutomationException

The spatial resolution in which to output geometry.

Specified by:

getSpatialResolution in interface IQueryFilter2

Returns:

The resolution

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialResolution

public void setSpatialResolution(double resolution)
                          throws java.io.IOException,
                                 AutomationException

The spatial resolution in which to output geometry.

Specified by:

setSpatialResolution in interface IQueryFilter2

Parameters:

resolution - The resolution (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPostfixClause

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

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

Specified by:

getPostfixClause in interface IQueryFilterDefinition

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 SELECT statement, following the where clause. Most commonly used for clauses like ORDER BY.

Specified by:

setPostfixClause in interface IQueryFilterDefinition

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.

Specified by:

getFilterDefs in interface IQueryFilterDefinition

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.

Specified by:

setFilterDefsByRef in interface IQueryFilterDefinition

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.

getPrefixClause

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

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

Specified by:

getPrefixClause in interface IQueryFilterDefinition2

Returns:

The clause

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPrefixClause

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

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

Specified by:

setPrefixClause in interface IQueryFilterDefinition2

Parameters:

clause - The clause (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPaginationClause

public void getPaginationClause(int[] offset,
                                int[] rowCount)
                         throws java.io.IOException,
                                AutomationException

A clause that controls query pagination.

Specified by:

getPaginationClause in interface IQueryFilterDefinition3

Parameters:

offset - The offset (out: use single element array)

rowCount - The rowCount (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPaginationClause

public void setPaginationClause(int offset,
                                int rowCount)
                         throws java.io.IOException,
                                AutomationException

A clause that controls query pagination.

Specified by:

setPaginationClause in interface IQueryFilterDefinition3

Parameters:

offset - The offset (in)

rowCount - The rowCount (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFIDSet

public IFIDSet getFIDSet()
                  throws java.io.IOException,
                         AutomationException

The FID set used to filter results.

Specified by:

getFIDSet in interface IQueryFilterFIDSet

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFIDSetByRef

public void setFIDSetByRef(IFIDSet fIDSet)
                    throws java.io.IOException,
                           AutomationException

The FID set used to filter results.

Specified by:

setFIDSetByRef in interface IQueryFilterFIDSet

Parameters:

fIDSet - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException