com.esri.arcgis.catalog
Interface IQuery

All Superinterfaces:
Serializable
All Known Implementing Classes:
FileSystemQuery

public interface IQuery
extends Serializable

Provides access to members that let you modify a query.

Product Availability

Available with ArcGIS Desktop.


Method Summary
 void addFieldQuery(int type, int op, String value, String tag)
          Adds a field query.
 IUID getClassID()
          Class ID indicating the type of query object that has been defined.
 String getDatasetName()
          Name of the dataset for which to search.
 INativeType getDatasetType()
          Type of object for which to search.
 String getDate1()
          Start date, or first date.
 String getDate2()
          End date, or second date.
 int getDateOperator()
          Operator for comparing dates.
 int getDateType()
          Date that will be tested.
 IPropertySet getEngineProperties()
          Property set containing properties of the search engine that will be used to execute the query.
 IEnvelope getEnvelope()
          Search extent in decimal degrees.
 int getEnvelopeOperator()
          Operator for comparing the dataset's extent to the search extent.
 void getFieldQuery(int index, int[] type, int[] op, String[] value, String[] tag)
          Returns the nth field query.
 String getNameOfQuery()
          Name of the query.
 IEnvelope getNativeEnvelope()
          Search extent in the dataset's coordinate system.
 int getNumFieldQueries()
          Number of field queries.
 boolean isCaseSensitive()
          Indicates if field query comparisons will be case sensitive.
 void load(IPropertySet pPropertySet)
          Loads the query's parameters from the given XML property set.
 void save(IPropertySet pPropertySet)
          Saves the query's parameters to the given XML property set.
 void setDatasetName(String name)
          Name of the dataset for which to search.
 void setDatasetTypeByRef(INativeType ppNativeType)
          Type of object for which to search.
 void setDate1(String date)
          Start date, or first date.
 void setDate2(String date)
          End date, or second date.
 void setDateOperator(int op)
          Operator for comparing dates.
 void setDateType(int type)
          Date that will be tested.
 void setEnvelopeByRef(IEnvelope ppEnvelope)
          Search extent in decimal degrees.
 void setEnvelopeOperator(int pOp)
          Operator for comparing the dataset's extent to the search extent.
 void setIsCaseSensitive(boolean isCaseSensitive)
          Indicates if field query comparisons will be case sensitive.
 void setNameOfQuery(String name)
          Name of the query.
 void setNativeEnvelopeByRef(IEnvelope ppEnvelope)
          Search extent in the dataset's coordinate system.
 

Method Detail

getNameOfQuery

String getNameOfQuery()
                      throws IOException,
                             AutomationException
Name of the query.

Product Availability

Available with ArcGIS Desktop.

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNameOfQuery

void setNameOfQuery(String name)
                    throws IOException,
                           AutomationException
Name of the query.

Product Availability

Available with ArcGIS Desktop.

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

getDatasetName

String getDatasetName()
                      throws IOException,
                             AutomationException
Name of the dataset for which to search.

Product Availability

Available with ArcGIS Desktop.

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDatasetName

void setDatasetName(String name)
                    throws IOException,
                           AutomationException
Name of the dataset for which to search.

Product Availability

Available with ArcGIS Desktop.

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

isCaseSensitive

boolean isCaseSensitive()
                        throws IOException,
                               AutomationException
Indicates if field query comparisons will be case sensitive.

Product Availability

Available with ArcGIS Desktop.

Returns:
The isCaseSensitive
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsCaseSensitive

void setIsCaseSensitive(boolean isCaseSensitive)
                        throws IOException,
                               AutomationException
Indicates if field query comparisons will be case sensitive.

Product Availability

Available with ArcGIS Desktop.

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

getDatasetType

INativeType getDatasetType()
                           throws IOException,
                                  AutomationException
Type of object for which to search.

Product Availability

Available with ArcGIS Desktop.

Returns:
A reference to a com.esri.arcgis.geodatabase.INativeType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDatasetTypeByRef

void setDatasetTypeByRef(INativeType ppNativeType)
                         throws IOException,
                                AutomationException
Type of object for which to search.

Product Availability

Available with ArcGIS Desktop.

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

getEnvelope

IEnvelope getEnvelope()
                      throws IOException,
                             AutomationException
Search extent in decimal degrees.

Product Availability

Available with ArcGIS Desktop.

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnvelopeByRef

void setEnvelopeByRef(IEnvelope ppEnvelope)
                      throws IOException,
                             AutomationException
Search extent in decimal degrees.

Product Availability

Available with ArcGIS Desktop.

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

getNativeEnvelope

IEnvelope getNativeEnvelope()
                            throws IOException,
                                   AutomationException
Search extent in the dataset's coordinate system.

Product Availability

Available with ArcGIS Desktop.

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNativeEnvelopeByRef

void setNativeEnvelopeByRef(IEnvelope ppEnvelope)
                            throws IOException,
                                   AutomationException
Search extent in the dataset's coordinate system.

Product Availability

Available with ArcGIS Desktop.

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

getEnvelopeOperator

int getEnvelopeOperator()
                        throws IOException,
                               AutomationException
Operator for comparing the dataset's extent to the search extent.

Product Availability

Available with ArcGIS Desktop.

Returns:
A com.esri.arcgis.catalog.esriFindEnvelopeOperator constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnvelopeOperator

void setEnvelopeOperator(int pOp)
                         throws IOException,
                                AutomationException
Operator for comparing the dataset's extent to the search extent.

Product Availability

Available with ArcGIS Desktop.

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

getDateType

int getDateType()
                throws IOException,
                       AutomationException
Date that will be tested.

Product Availability

Available with ArcGIS Desktop.

Returns:
A com.esri.arcgis.catalog.esriFindDateType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDateType

void setDateType(int type)
                 throws IOException,
                        AutomationException
Date that will be tested.

Product Availability

Available with ArcGIS Desktop.

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

getDateOperator

int getDateOperator()
                    throws IOException,
                           AutomationException
Operator for comparing dates.

Product Availability

Available with ArcGIS Desktop.

Returns:
A com.esri.arcgis.catalog.esriFindDateOperator constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDateOperator

void setDateOperator(int op)
                     throws IOException,
                            AutomationException
Operator for comparing dates.

Product Availability

Available with ArcGIS Desktop.

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

getDate1

String getDate1()
                throws IOException,
                       AutomationException
Start date, or first date.

Product Availability

Available with ArcGIS Desktop.

Returns:
The date
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDate1

void setDate1(String date)
              throws IOException,
                     AutomationException
Start date, or first date.

Product Availability

Available with ArcGIS Desktop.

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

getDate2

String getDate2()
                throws IOException,
                       AutomationException
End date, or second date.

Product Availability

Available with ArcGIS Desktop.

Returns:
The date
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDate2

void setDate2(String date)
              throws IOException,
                     AutomationException
End date, or second date.

Product Availability

Available with ArcGIS Desktop.

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

getNumFieldQueries

int getNumFieldQueries()
                       throws IOException,
                              AutomationException
Number of field queries.

Product Availability

Available with ArcGIS Desktop.

Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldQuery

void getFieldQuery(int index,
                   int[] type,
                   int[] op,
                   String[] value,
                   String[] tag)
                   throws IOException,
                          AutomationException
Returns the nth field query.

Product Availability

Available with ArcGIS Desktop.

Parameters:
index - The index (in)
type - A com.esri.arcgis.catalog.esriFindFieldType constant (out: use single element array)
op - A com.esri.arcgis.catalog.esriFindFieldOperator constant (out: use single element array)
value - The value (out: use single element array)
tag - The tag (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addFieldQuery

void addFieldQuery(int type,
                   int op,
                   String value,
                   String tag)
                   throws IOException,
                          AutomationException
Adds a field query.

Product Availability

Available with ArcGIS Desktop.

Parameters:
type - A com.esri.arcgis.catalog.esriFindFieldType constant (in)
op - A com.esri.arcgis.catalog.esriFindFieldOperator constant (in)
value - The value (in)
tag - The tag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

IUID getClassID()
                throws IOException,
                       AutomationException
Class ID indicating the type of query object that has been defined.

Product Availability

Available with ArcGIS Desktop.

Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

void load(IPropertySet pPropertySet)
          throws IOException,
                 AutomationException
Loads the query's parameters from the given XML property set.

Product Availability

Available with ArcGIS Desktop.

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

save

void save(IPropertySet pPropertySet)
          throws IOException,
                 AutomationException
Saves the query's parameters to the given XML property set.

Product Availability

Available with ArcGIS Desktop.

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

getEngineProperties

IPropertySet getEngineProperties()
                                 throws IOException,
                                        AutomationException
Property set containing properties of the search engine that will be used to execute the query.

Product Availability

Available with ArcGIS Desktop.

Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.