com.esri.sde.sdk.client
Class SeQueryInfo

java.lang.Object
  com.esri.sde.sdk.client.SeQueryInfo

All Implemented Interfaces:

java.lang.Cloneable

public class SeQueryInfo
extends java.lang.Object
implements java.lang.Cloneable

Holds information for advanced query operations. An SeQueryInfo object is used to retrieve layer and table statistics.

Field Summary

static int	SE_QUERYTYPE_ATTRIBUTE_FIRST
static int	SE_QUERYTYPE_JFA
static int	SE_QUERYTYPE_JSF
static int	SE_QUERYTYPE_JSFA
static int	SE_QUERYTYPE_V3

Constructor Summary

SeQueryInfo()
Constructs an SeQueryInfo object.

Method Summary

java.lang.Object	clone() Clones the SeQueryInfo object.
java.lang.String	getByClause() Returns the SQL ORDER BY string for the query.
java.lang.String[]	getColumns() Returns a copy of the SeColumnDefinitions set on this queryinfo object.
SeSqlConstruct	getConstruct() Returns the SeSqlConstruct.
int	getEntityType() Returns the shape type as an int.
java.lang.String	getLogfile() Returns the logfile name.
int	getQueryType() Returns the query type.
int	numColumns() Returns the number of columns set on the queryinfo object.
void	setByClause(java.lang.String byClause) Sets the SQL ORDER BY or GROUP BY string for the query.
void	setColumns(java.lang.String[] cols) Sets the array of SeColumnDefinitions for the query.
void	setConstruct(SeSqlConstruct construct) Sets the SesqlConstruct that holds the tables and where clause for the query.
void	setEntityType(int type) Sets the shape (entity) type.
void	setKeySetParameters(SeObjectId keySetId, java.lang.String keySetColumn, java.lang.String targetTable, java.lang.String targetColumn) Sets Keyset information.
void	setLogfile(java.lang.String logfile) Sets the logfile name.
void	setQueryType(int type) Sets the DBMS query type.
void	setXmlDocProperty(java.lang.String table, java.lang.String column, int docProperty) Sets an XML document property on an XML column in the query.
void	setXpathConstraint(java.lang.String table, java.lang.String column, java.lang.String xPathExpr) Sets the xpath constraint in the queryinfo.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SE_QUERYTYPE_ATTRIBUTE_FIRST

public static final int SE_QUERYTYPE_ATTRIBUTE_FIRST

See Also:

Constant Field Values

SE_QUERYTYPE_JFA

public static final int SE_QUERYTYPE_JFA

See Also:

Constant Field Values

SE_QUERYTYPE_JSF

public static final int SE_QUERYTYPE_JSF

See Also:

Constant Field Values

SE_QUERYTYPE_JSFA

public static final int SE_QUERYTYPE_JSFA

See Also:

Constant Field Values

SE_QUERYTYPE_V3

public static final int SE_QUERYTYPE_V3

See Also:

Constant Field Values

Constructor Detail

SeQueryInfo

public SeQueryInfo()
            throws SeException

Constructs an SeQueryInfo object.

Throws:

SeException

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clones the SeQueryInfo object.

Overrides:

clone in class java.lang.Object

Returns:

a SeQueryInfo as type Object.

Throws:

java.lang.CloneNotSupportedException - if an error occurs

getEntityType

public int getEntityType()

Returns the shape type as an int. possible values: SeLayer.TYPE_NIL SeLayer.TYPE_POINT SeLayer.TYPE_LINE SeLayer.TYPE_SIMPLE_LINE SeLayer.TYPE_POLYGON SeLayer.TYPE_MULTI_POINT SeLayer.TYPE_MULTI_LINE SeLayer.TYPE_MULTI_SIMPLE_LINE SeLayer.TYPE_MULTI_POLYGON

Returns:

int

setEntityType

public void setEntityType(int type)

Sets the shape (entity) type. possible values: SeLayer.TYPE_NIL SeLayer.TYPE_POINT SeLayer.TYPE_LINE SeLayer.TYPE_SIMPLE_LINE SeLayer.TYPE_POLYGON SeLayer.TYPE_MULTI_POINT SeLayer.TYPE_MULTI_LINE SeLayer.TYPE_MULTI_SIMPLE_LINE SeLayer.TYPE_MULTI_POLYGON

getByClause

public java.lang.String getByClause()

Returns the SQL ORDER BY string for the query.

setByClause

public void setByClause(java.lang.String byClause)
                 throws SeException

Sets the SQL ORDER BY or GROUP BY string for the query. The ORDER BY string is appended to the end of the WHERE clause set by setConstruct(). You must set the phrase "order by" or "group by" as the first two words of your byClause.

Throws:

SeException

getQueryType

public int getQueryType()

Returns the query type. SE_QUERYTYPE_ATTRIBUTE_FIRST SE_QUERYTYPE_JFA SE_QUERYTYPE_JSF SE_QUERYTYPE_JSFA SE_QUERYTYPE_V3

setQueryType

public void setQueryType(int type)
                  throws SeException

Sets the DBMS query type. It allows users to join layer tables (spatial, feature) with a user's business table and external tables. A Query Type is defined as the type of SQL select statement the server will use to execute spatial and non-spatial queries. Query types are: SE_QUERYTYPE_ATTRIBUTE_FIRST - join the business tables first, followed by the spatial and/or feature table. SE_QUERYTYPE_JFA - join the feature and attribute (business) tables. SE_QUERYTYPE_JSF - join the spatial and feature tables. SE_QUERYTYPE_JSFA - join the spatial/business/feature tables. SE_QUERYTYPE_V3 - use the old-style query method where all tables are queried individually.

Throws:

SeException

numColumns

public int numColumns()

Returns the number of columns set on the queryinfo object.

getColumns

public java.lang.String[] getColumns()
                              throws SeException

Returns a copy of the SeColumnDefinitions set on this queryinfo object.

Throws:

SeException

setColumns

public void setColumns(java.lang.String[] cols)
                throws SeException

Sets the array of SeColumnDefinitions for the query.

Throws:

SeException

getConstruct

public SeSqlConstruct getConstruct()
                            throws SeException

Returns the SeSqlConstruct.

Throws:

SeException

setConstruct

public void setConstruct(SeSqlConstruct construct)
                  throws SeException

Sets the SesqlConstruct that holds the tables and where clause for the query.

Throws:

SeException

setKeySetParameters

public void setKeySetParameters(SeObjectId keySetId,
                                java.lang.String keySetColumn,
                                java.lang.String targetTable,
                                java.lang.String targetColumn)
                         throws SeException

Sets Keyset information.

Throws:

SeException

getLogfile

public java.lang.String getLogfile()

Returns the logfile name.

Returns:

String logfile

setLogfile

public void setLogfile(java.lang.String logfile)
                throws SeException

Sets the logfile name.

Throws:

SeException

setXpathConstraint

public void setXpathConstraint(java.lang.String table,
                               java.lang.String column,
                               java.lang.String xPathExpr)
                        throws SeException

Sets the xpath constraint in the queryinfo.

Throws:

SeException

setXmlDocProperty

public void setXmlDocProperty(java.lang.String table,
                              java.lang.String column,
                              int docProperty)
                       throws SeException

Sets an XML document property on an XML column in the query. As of SDE 9.0, the only property supported is SE_DOC_HAS_TAG_CONFLICTS. Setting this property ensures that only documents that have been flagged as having tag conflicts are returned. This function may be called multiple times. In the case of queries involving multiple XML columns, the SeQueryInfo object will maintain a list of properties, one per XML column. If this function is called more than once for the same XML column, only the last property set for that column will be retained (i.e. at most one property per column). Calling this function with a zero property value will remove any existing property on that column.

Parameters:

table - Table with xml column.

column - XML column in table.

docProperty - Document Property.

Throws:

SeException