de.ipcon.db.oql

Class SQLQuery

java.lang.Object

de.ipcon.db.oql.SQLQuery

public class SQLQuery
extends java.lang.Object

Immutable value object holding the SQL generated by the OQLQuery.

The design allows generating multiple distinct SQLQuery objects from a single parsed OQL query (e.g. varying parameter lists) without altering the AST.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log
static int	NO_LIMIT

Constructor Summary

Constructors

Constructor and Description
SQLQuery(java.lang.String query, java.lang.Object[] args, java.lang.Class<?> resultClass, int expectedRows) Constructs a basic SQL query without specific limits or sorting.
SQLQuery(java.lang.String query, java.lang.Object[] args, java.lang.Class<?> resultClass, int expectedRows, int limit, boolean sorted, FilterNode filterPart) Constructs a fully specified SQL query.

Method Summary

Modifier and Type	Method and Description
java.lang.Object[]	getArgs() Returns the positional parameters for JDBC execution.
int	getExpectedRows()
java.util.function.Predicate<BOI>	getFilterPredicate()
int	getLimit()
java.lang.String	getQuery()
java.lang.Class<?>	getResultClass()
boolean	isSorted()
static SQLQuery	ofOQL(SchemaI schema, java.lang.String oqlQuery, java.lang.Object[] parameters) Factory method to parse an OQL query and immediately translate it to SQL.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.apache.log4j.Logger log

NO_LIMIT

public static final int NO_LIMIT

See Also:

Constant Field Values

Constructor Detail

SQLQuery

public SQLQuery(java.lang.String query,
                java.lang.Object[] args,
                java.lang.Class<?> resultClass,
                int expectedRows)

Constructs a basic SQL query without specific limits or sorting.

Parameters:

query - the raw JDBC SQL string

args - the JDBC positional parameters

resultClass - the expected return entity/type class

expectedRows - the estimated row count, or -1 if unknown

SQLQuery

public SQLQuery(java.lang.String query,
                java.lang.Object[] args,
                java.lang.Class<?> resultClass,
                int expectedRows,
                int limit,
                boolean sorted,
                FilterNode filterPart)

Constructs a fully specified SQL query.

Parameters:

query - the raw JDBC SQL string

args - the JDBC positional parameters

resultClass - the expected return entity/type class

expectedRows - the estimated row count, or -1 if unknown

limit - the maximum rows to return, or -1 for no limit

sorted - true if the query contains an explicit "order by" clause

filterPart - the AST node representing post-db filtering logic

Method Detail

ofOQL

public static SQLQuery ofOQL(SchemaI schema,
                             java.lang.String oqlQuery,
                             java.lang.Object[] parameters)
                      throws OQLException

Factory method to parse an OQL query and immediately translate it to SQL.

Parameters:

schema - the schema to use for determining attribute types

oqlQuery - the raw OQL query string

parameters - the positional parameters for the OQL query

Returns:

the fully translated SQL query object

Throws:

OQLException - if the OQL query could not be parsed or translated

getQuery

public java.lang.String getQuery()

getArgs

public java.lang.Object[] getArgs()

Returns the positional parameters for JDBC execution.

Note: Returns the internal array reference for performance reasons; do not mutate the array.

Returns:

the positional parameters for JDBC execution

getResultClass

public java.lang.Class<?> getResultClass()

getExpectedRows

public int getExpectedRows()

Returns:

a positive integer representing the estimated row count, or -1 (NO_LIMIT) if unknown

getLimit

public int getLimit()

Returns:

the maximum number of rows to retrieve, or -1 (NO_LIMIT) if unbounded

isSorted

public boolean isSorted()

getFilterPredicate

public java.util.function.Predicate<BOI> getFilterPredicate()