|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface QueryTranslator
Defines the contract of an HQL->SQL translator.
Field Summary | |
---|---|
static String |
ERROR_CANNOT_DETERMINE_TYPE
|
static String |
ERROR_CANNOT_FETCH_WITH_ITERATE
|
static String |
ERROR_CANNOT_FORMAT_LITERAL
|
static String |
ERROR_NAMED_PARAMETER_DOES_NOT_APPEAR
|
Method Summary | |
---|---|
List |
collectSqlStrings()
|
void |
compile(Map replacements,
boolean shallow)
Compile a "normal" query. |
boolean |
containsCollectionFetches()
Does the translated query contain collection fetches? |
int |
executeUpdate(QueryParameters queryParameters,
SessionImplementor session)
Perform a bulk update/delete operation given the underlying query definition. |
String[][] |
getColumnNames()
Returns the column names in the generated SQL. |
Class |
getDynamicInstantiationResultType()
|
Map |
getEnabledFilters()
Returns the filters enabled for this query translator. |
ParameterTranslations |
getParameterTranslations()
Return information about any parameters encountered during translation. |
String |
getQueryIdentifier()
Retrieve the query identifier for this translator. |
Set |
getQuerySpaces()
Returns the set of query spaces (table names) that the query refers to. |
String |
getQueryString()
Returns the HQL string processed by the translator. |
String[] |
getReturnAliases()
Returns an array of HQL aliases |
Type[] |
getReturnTypes()
Returns an array of Types represented in the query result. |
String |
getSQLString()
Returns the SQL string generated by the translator. |
boolean |
isManipulationStatement()
|
Iterator |
iterate(QueryParameters queryParameters,
EventSource session)
Perform an iterate operation given the underlying query definition. |
List |
list(SessionImplementor session,
QueryParameters queryParameters)
Perform a list operation given the underlying query definition. |
ScrollableResults |
scroll(QueryParameters queryParameters,
SessionImplementor session)
Perform a scroll operation given the underlying query definition. |
void |
validateScrollability()
Validate the scrollability of the translated query. |
Field Detail |
---|
static final String ERROR_CANNOT_FETCH_WITH_ITERATE
static final String ERROR_NAMED_PARAMETER_DOES_NOT_APPEAR
static final String ERROR_CANNOT_DETERMINE_TYPE
static final String ERROR_CANNOT_FORMAT_LITERAL
Method Detail |
---|
void compile(Map replacements, boolean shallow) throws QueryException, MappingException
replacements
- Defined query substitutions.shallow
- Does this represent a shallow (scalar or entity-id) select?
QueryException
- There was a problem parsing the query string.
MappingException
- There was a problem querying defined mappings.List list(SessionImplementor session, QueryParameters queryParameters) throws HibernateException
session
- The session owning this query.queryParameters
- The query bind parameters.
HibernateException
Iterator iterate(QueryParameters queryParameters, EventSource session) throws HibernateException
queryParameters
- The query bind parameters.session
- The session owning this query.
HibernateException
ScrollableResults scroll(QueryParameters queryParameters, SessionImplementor session) throws HibernateException
queryParameters
- The query bind parameters.session
- The session owning this query.
HibernateException
int executeUpdate(QueryParameters queryParameters, SessionImplementor session) throws HibernateException
queryParameters
- The query bind parameters.session
- The session owning this query.
HibernateException
Set getQuerySpaces()
String getQueryIdentifier()
String getSQLString()
List collectSqlStrings()
String getQueryString()
Map getEnabledFilters()
Type[] getReturnTypes()
String[] getReturnAliases()
String[][] getColumnNames()
ParameterTranslations getParameterTranslations()
void validateScrollability() throws HibernateException
HibernateException
boolean containsCollectionFetches()
boolean isManipulationStatement()
Class getDynamicInstantiationResultType()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |