schemacrawler.utility

Class Query

java.lang.Object

schemacrawler.utility.Query

All Implemented Interfaces:

java.io.Serializable

public final class Query
extends java.lang.Object
implements java.io.Serializable

A SQL query. May be parameterized with ant-like variable references.

Author:

sfatehi

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Query(java.lang.String name, java.lang.String query) Definition of a query, including a name, and parameterized or regular SQL.
Query(java.lang.String name, java.lang.String query, boolean throwSQLException) Definition of a query, including a name, and parameterized or regular SQL.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Gets the query name.
java.lang.String	getQuery() Gets the query SQL.
boolean	hasName() Whether a query name was provided.
boolean	isQueryOver() Determines if this query has substitutable parameters, and whether it should be run once for each table.
boolean	isThrowSQLException() Whether the query should throw a SQL exception on an error during execution.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query(java.lang.String name,
             java.lang.String query)

Definition of a query, including a name, and parameterized or regular SQL.

Parameters:

name - Query name.

query - Query SQL.

Query

public Query(java.lang.String name,
             java.lang.String query,
             boolean throwSQLException)

Definition of a query, including a name, and parameterized or regular SQL.

Parameters:

name - Query name.

query - Query SQL.

throwSQLException - Whether the query should throw a SQL exception on an error.

Method Detail

getName

public java.lang.String getName()

Gets the query name.

Returns:

Query name

getQuery

public java.lang.String getQuery()

Gets the query SQL.

Returns:

Query SQL

hasName

public boolean hasName()

Whether a query name was provided.

Returns:

Whether a query name was provided

isQueryOver

public boolean isQueryOver()

Determines if this query has substitutable parameters, and whether it should be run once for each table.

Returns:

If the query is to be run over each table

isThrowSQLException

public boolean isThrowSQLException()

Whether the query should throw a SQL exception on an error during execution.

Returns:

Whether the query should throw a SQL exception on an error

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object