Elexis API documentation
Version 2.1.6 as of December 11 2011

com.healthmarketscience.jackcess.query
Class Query

java.lang.Object
  extended by com.healthmarketscience.jackcess.query.Query
Direct Known Subclasses:
BaseSelectQuery, DataDefinitionQuery, PassthroughQuery, UnionQuery, UpdateQuery

public abstract class Query
extends java.lang.Object

Base class for classes which encapsulate information about an Access query. The toSQLString() method can be used to convert this object into the actual SQL string which this query data represents.

Author:
James Ahlborn

Nested Class Summary
static class Query.Row
          Struct containing the information from a single row of the system query table.
static class Query.Type
           
 
Method Summary
static Query create(int objectFlag, java.lang.String name, java.util.List<Query.Row> rows, int objectId)
          Creates a concrete Query instance from the given query data.
 java.lang.String getName()
          Returns the name of the query.
 int getObjectFlag()
           
 int getObjectId()
          Returns the unique object id of the query.
 java.lang.String getOwnerAccessType()
           
 java.util.List<java.lang.String> getParameters()
           
 java.util.List<Query.Row> getRows()
          Returns the rows from the system query table from which the query information was derived.
 Query.Type getType()
          Returns the type of the query.
 java.lang.String toSQLString()
          Returns the actual SQL string which this query data represents.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getName

public java.lang.String getName()
Returns the name of the query.


getType

public Query.Type getType()
Returns the type of the query.


getObjectId

public int getObjectId()
Returns the unique object id of the query.


getObjectFlag

public int getObjectFlag()

getRows

public java.util.List<Query.Row> getRows()
Returns the rows from the system query table from which the query information was derived.


getParameters

public java.util.List<java.lang.String> getParameters()

getOwnerAccessType

public java.lang.String getOwnerAccessType()

toSQLString

public java.lang.String toSQLString()
Returns the actual SQL string which this query data represents.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

create

public static Query create(int objectFlag,
                           java.lang.String name,
                           java.util.List<Query.Row> rows,
                           int objectId)
Creates a concrete Query instance from the given query data.

Parameters:
objectFlag - the flag indicating the type of the query
name - the name of the query
rows - the rows from the system query table containing the data describing this query
objectId - the unique object id of this query
Returns:
a Query instance for the given query data

Elexis API documentation
Version 2.1.6 as of December 11 2011

Copyright 2005-2011 by Gerry Weirich, Elexis