Package com.healthmarketscience.jackcess.impl.query

Class QueryImpl

java.lang.Object

com.healthmarketscience.jackcess.impl.query.QueryImpl

All Implemented Interfaces:

PropertyMaps.Owner, Query

Direct Known Subclasses:

BaseSelectQueryImpl, DataDefinitionQueryImpl, PassthroughQueryImpl, UnionQueryImpl, UpdateQueryImpl

public abstract class QueryImpl
extends Object
implements Query, PropertyMaps.Owner

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

Nested Classes

Modifier and Type	Class	Description
static class	QueryImpl.Row	Struct containing the information from a single row of the system query table.

Nested classes/interfaces inherited from interface com.healthmarketscience.jackcess.query.Query

Query.Type

Method Summary

Modifier and Type	Method	Description
static QueryImpl	create(int objectFlag, String name, List<QueryImpl.Row> rows, int objectId)	Creates a concrete Query instance from the given query data alone, for tests of the sql it generates.
static QueryImpl	create(DatabaseImpl database, int objectFlag, String name, List<QueryImpl.Row> rows, int objectId)	Creates a concrete Query instance from the given query data.
String	getName()	Returns the name of the query.
QueryNameMapImpl	getNameMap()
int	getObjectFlag()
int	getObjectId()	Returns the unique object id of the query.
String	getOwnerAccessType()
List<String>	getParameters()	Returns the rows from the system query table from which the query information was derived.
PropertyMap	getProperties()
PropertyMaps	getPropertyMaps()
List<QueryImpl.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.
QueryImpl.Row	getTypeRow()
boolean	isHidden()	Whether or not this query has been marked as hidden.
void	propertiesUpdated()	Invoked when new properties are saved.
String	toSQLString()	Returns the actual SQL string which this query data represents.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Returns the name of the query.

Specified by:

getName in interface Query

getType

public Query.Type getType()

Returns the type of the query.

Specified by:

getType in interface Query

isHidden

public boolean isHidden()

Description copied from interface: Query

Whether or not this query has been marked as hidden.

Specified by:

isHidden in interface Query

getObjectId

public int getObjectId()

Returns the unique object id of the query.

Specified by:

getObjectId in interface Query

getObjectFlag

public int getObjectFlag()

Specified by:

getObjectFlag in interface Query

getProperties

public PropertyMap getProperties()
                          throws IOException

Specified by:

getProperties in interface Query

Returns:

the properties for this query

Throws:

IOException

getPropertyMaps

public PropertyMaps getPropertyMaps()
                             throws IOException

Returns:

all PropertyMaps for this query (and its columns)

Throws:

IOException

Usage:

Advanced: This method is for advanced/internal use.

getNameMap

public QueryNameMapImpl getNameMap()
                            throws IOException

Specified by:

getNameMap in interface Query

Returns:

the name map for this query, which cannot be changed, or null if the query has none

Throws:

IOException

propertiesUpdated

public void propertiesUpdated()
                       throws IOException

Description copied from interface: PropertyMaps.Owner

Invoked when new properties are saved.

Specified by:

propertiesUpdated in interface PropertyMaps.Owner

Throws:

IOException

getRows

public List<QueryImpl.Row> getRows()

Returns the rows from the system query table from which the query information was derived.

getTypeRow

public QueryImpl.Row getTypeRow()

getParameters

public List<String> getParameters()

Description copied from interface: Query

Returns the rows from the system query table from which the query information was derived.

Specified by:

getParameters in interface Query

getOwnerAccessType

public String getOwnerAccessType()

Specified by:

getOwnerAccessType in interface Query

toSQLString

public String toSQLString()

Returns the actual SQL string which this query data represents.

Specified by:

toSQLString in interface Query

toString

public String toString()

Overrides:

toString in class Object

create

public static QueryImpl create(int objectFlag,
                               String name,
                               List<QueryImpl.Row> rows,
                               int objectId)

Creates a concrete Query instance from the given query data alone, for tests of the sql it generates. The query has no database, so its properties cannot be read.

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

create

public static QueryImpl create(DatabaseImpl database,
                               int objectFlag,
                               String name,
                               List<QueryImpl.Row> rows,
                               int objectId)

Creates a concrete Query instance from the given query data.

Parameters:

database - the database which holds the query

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