Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.catalog
Interface IQuery

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
FileSystemQuery, IQueryProxy
public interface IQuery
extends java.io.Serializable

COM Interface 'IQuery'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriCatalog.olb'

Description: 'Provides access to members that let you modify a query.' 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 =

Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID4ea3e4eb_9dfa_11d3_a6cb_0008c7d3ae50
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void addFieldQuery(int type, int op, java.lang.String value, java.lang.String tag)
          Adds a field query.
 IUID getClassID()
          Class ID indicating the type of query object that has been defined.
 java.lang.String getDatasetName()
          Name of the dataset for which to search.
 INativeType getDatasetType()
          Type of object for which to search.
 java.lang.String getDate1()
          Start date, or first date.
 java.lang.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, java.lang.String[] value, java.lang.String[] tag)
          Returns the nth field query.
 java.lang.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(java.lang.String name)
          Name of the dataset for which to search.
 void setDatasetTypeByRef(INativeType ppNativeType)
          Type of object for which to search.
 void setDate1(java.lang.String date)
          Start date, or first date.
 void setDate2(java.lang.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(java.lang.String name)
          Name of the query.
 void setNativeEnvelopeByRef(IEnvelope ppEnvelope)
          Search extent in the dataset's coordinate system.
 

Field Detail

IID4ea3e4eb_9dfa_11d3_a6cb_0008c7d3ae50

static final int IID4ea3e4eb_9dfa_11d3_a6cb_0008c7d3ae50
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getNameOfQuery

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

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

setNameOfQuery

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

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

getDatasetName

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

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

setDatasetName

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

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

isCaseSensitive

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

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

setIsCaseSensitive

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

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

getDatasetType

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

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

setDatasetTypeByRef

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

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

getEnvelope

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

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

setEnvelopeByRef

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

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

getNativeEnvelope

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

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

setNativeEnvelopeByRef

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

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

getEnvelopeOperator

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

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

setEnvelopeOperator

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

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

getDateType

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

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

setDateType

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

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

getDateOperator

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

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

setDateOperator

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

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

getDate1

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

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

setDate1

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

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

getDate2

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

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

setDate2

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

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

getNumFieldQueries

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

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

getFieldQuery

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

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addFieldQuery

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

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

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

load

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

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

save

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

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

getEngineProperties

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

Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD