com.esri.arcgis.catalogUI
Class FileSystemQuery

java.lang.Object
  com.esri.arcgis.catalogUI.FileSystemQuery

All Implemented Interfaces:

IQuery, IArcIMSQuery, IFindDialogSettings, IXmlQuery, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class FileSystemQuery
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IQuery, IXmlQuery, IArcIMSQuery, IFindDialogSettings

A query that can be used to search XML documents.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

FileSystemQuery()
Constructs a FileSystemQuery using ArcGIS Engine.

FileSystemQuery(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FileSystemQuery theFileSystemQuery = (FileSystemQuery) obj;

Method Summary

void	addFieldQuery(int type, int op, String value, String tag) Adds a field query.
void	buildExpressions() Creates a set of XSL Pattern expressions from a query.
boolean	equals(Object o) Compare this object with another
String	getBackgroundMap() Full name of the dataset to be used as the background map in the Geography tab.
IUID	getClassID() Class ID indicating the type of query object that has been defined.
static String	getClsid() getClsid.
int	getContentType() The Content type.
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.
String	getExpression(int index) The nth expression.
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	getNumExpressions() Number of expressions that were generated.
int	getNumFieldQueries() Number of field queries.
int	hashCode() the hashcode for this object
boolean	isAnd() Indicates if the expressions are ANDed together (as opposed to ORed).
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	setBackgroundMap(String pBackgroundMap) Full name of the dataset to be used as the background map in the Geography tab.
void	setContentType(int type) The Content type.
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	setIsAnd(boolean isAnd) Indicates if the expressions are ANDed together (as opposed to ORed).
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

FileSystemQuery

public FileSystemQuery()
                throws IOException,
                       UnknownHostException

Constructs a FileSystemQuery using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

FileSystemQuery

public FileSystemQuery(Object obj)
                throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getNameOfQuery

public String getNameOfQuery()
                      throws IOException,
                             AutomationException

Name of the query.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getNameOfQuery in interface IQuery

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNameOfQuery

public void setNameOfQuery(String name)
                    throws IOException,
                           AutomationException

Name of the query.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setNameOfQuery in interface IQuery

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetName

public String getDatasetName()
                      throws IOException,
                             AutomationException

Name of the dataset for which to search.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getDatasetName in interface IQuery

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDatasetName

public void setDatasetName(String name)
                    throws IOException,
                           AutomationException

Name of the dataset for which to search.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setDatasetName in interface IQuery

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCaseSensitive

public boolean isCaseSensitive()
                        throws IOException,
                               AutomationException

Indicates if field query comparisons will be case sensitive.

Product Availability

Available with ArcGIS Desktop.

Specified by:

isCaseSensitive in interface IQuery

Returns:

The isCaseSensitive

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsCaseSensitive

public void setIsCaseSensitive(boolean isCaseSensitive)
                        throws IOException,
                               AutomationException

Indicates if field query comparisons will be case sensitive.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setIsCaseSensitive in interface IQuery

Parameters:

isCaseSensitive - The isCaseSensitive (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetType

public INativeType getDatasetType()
                           throws IOException,
                                  AutomationException

Type of object for which to search.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getDatasetType in interface IQuery

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

public void setDatasetTypeByRef(INativeType ppNativeType)
                         throws IOException,
                                AutomationException

Type of object for which to search.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setDatasetTypeByRef in interface IQuery

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

public IEnvelope getEnvelope()
                      throws IOException,
                             AutomationException

Search extent in decimal degrees.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getEnvelope in interface IQuery

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

public void setEnvelopeByRef(IEnvelope ppEnvelope)
                      throws IOException,
                             AutomationException

Search extent in decimal degrees.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setEnvelopeByRef in interface IQuery

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

public IEnvelope getNativeEnvelope()
                            throws IOException,
                                   AutomationException

Search extent in the dataset's coordinate system.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getNativeEnvelope in interface IQuery

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

public void setNativeEnvelopeByRef(IEnvelope ppEnvelope)
                            throws IOException,
                                   AutomationException

Search extent in the dataset's coordinate system.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setNativeEnvelopeByRef in interface IQuery

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

public int getEnvelopeOperator()
                        throws IOException,
                               AutomationException

Operator for comparing the dataset's extent to the search extent.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getEnvelopeOperator in interface IQuery

Returns:

A com.esri.arcgis.catalog.esriFindEnvelopeOperator constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnvelopeOperator

public void setEnvelopeOperator(int pOp)
                         throws IOException,
                                AutomationException

Operator for comparing the dataset's extent to the search extent.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setEnvelopeOperator in interface IQuery

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

public int getDateType()
                throws IOException,
                       AutomationException

Date that will be tested.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getDateType in interface IQuery

Returns:

A com.esri.arcgis.catalog.esriFindDateType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDateType

public void setDateType(int type)
                 throws IOException,
                        AutomationException

Date that will be tested.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setDateType in interface IQuery

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

public int getDateOperator()
                    throws IOException,
                           AutomationException

Operator for comparing dates.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getDateOperator in interface IQuery

Returns:

A com.esri.arcgis.catalog.esriFindDateOperator constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDateOperator

public void setDateOperator(int op)
                     throws IOException,
                            AutomationException

Operator for comparing dates.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setDateOperator in interface IQuery

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

public String getDate1()
                throws IOException,
                       AutomationException

Start date, or first date.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getDate1 in interface IQuery

Returns:

The date

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDate1

public void setDate1(String date)
              throws IOException,
                     AutomationException

Start date, or first date.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setDate1 in interface IQuery

Parameters:

date - The date (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDate2

public String getDate2()
                throws IOException,
                       AutomationException

End date, or second date.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getDate2 in interface IQuery

Returns:

The date

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDate2

public void setDate2(String date)
              throws IOException,
                     AutomationException

End date, or second date.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setDate2 in interface IQuery

Parameters:

date - The date (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumFieldQueries

public int getNumFieldQueries()
                       throws IOException,
                              AutomationException

Number of field queries.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getNumFieldQueries in interface IQuery

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldQuery

public 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.

Specified by:

getFieldQuery in interface IQuery

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

public void addFieldQuery(int type,
                          int op,
                          String value,
                          String tag)
                   throws IOException,
                          AutomationException

Adds a field query.

Product Availability

Available with ArcGIS Desktop.

Specified by:

addFieldQuery in interface IQuery

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

public IUID getClassID()
                throws IOException,
                       AutomationException

Class ID indicating the type of query object that has been defined.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getClassID in interface IQuery

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

public void load(IPropertySet pPropertySet)
          throws IOException,
                 AutomationException

Loads the query's parameters from the given XML property set.

Product Availability

Available with ArcGIS Desktop.

Specified by:

load in interface IQuery

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

public void save(IPropertySet pPropertySet)
          throws IOException,
                 AutomationException

Saves the query's parameters to the given XML property set.

Product Availability

Available with ArcGIS Desktop.

Specified by:

save in interface IQuery

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

public 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.

Specified by:

getEngineProperties in interface IQuery

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.

buildExpressions

public void buildExpressions()
                      throws IOException,
                             AutomationException

Creates a set of XSL Pattern expressions from a query.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

buildExpressions in interface IXmlQuery

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumExpressions

public int getNumExpressions()
                      throws IOException,
                             AutomationException

Number of expressions that were generated.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getNumExpressions in interface IXmlQuery

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExpression

public String getExpression(int index)
                     throws IOException,
                            AutomationException

The nth expression.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getExpression in interface IXmlQuery

Parameters:

index - The index (in)

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAnd

public boolean isAnd()
              throws IOException,
                     AutomationException

Indicates if the expressions are ANDed together (as opposed to ORed).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isAnd in interface IXmlQuery

Returns:

The isAnd

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsAnd

public void setIsAnd(boolean isAnd)
              throws IOException,
                     AutomationException

Indicates if the expressions are ANDed together (as opposed to ORed).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setIsAnd in interface IXmlQuery

Parameters:

isAnd - The isAnd (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContentType

public int getContentType()
                   throws IOException,
                          AutomationException

The Content type.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getContentType in interface IArcIMSQuery

Returns:

A com.esri.arcgis.catalog.esriContentType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContentType

public void setContentType(int type)
                    throws IOException,
                           AutomationException

The Content type.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setContentType in interface IArcIMSQuery

Parameters:

type - A com.esri.arcgis.catalog.esriContentType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundMap

public String getBackgroundMap()
                        throws IOException,
                               AutomationException

Full name of the dataset to be used as the background map in the Geography tab.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getBackgroundMap in interface IFindDialogSettings

Returns:

The pBackgroundMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundMap

public void setBackgroundMap(String pBackgroundMap)
                      throws IOException,
                             AutomationException

Full name of the dataset to be used as the background map in the Geography tab.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setBackgroundMap in interface IFindDialogSettings

Parameters:

pBackgroundMap - The pBackgroundMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.