net.sf.jkniv.sqlegance.builder.xml

Interface ISql

All Known Subinterfaces:

ISqlTag

All Known Implementing Classes:

AbstractSqlTag, DeleteTag, IncludeTag, InsertTag, ProcedureTag, SelectTag, UpdateTag

public interface ISql

This class represent a query language (JPQL, HQL or SQL) from XML file, each node at xml file is represented by this class. Those queries can be dynamic or static and to recover a dynamic query (built on-the-fly) is necessary to pass the parameters that can be mounted.

Since:

0.0.2

Author:

alisson gomes

Method Summary

Modifier and Type	Method and Description
LanguageType	getLanguageType() Retrieve the language type used at sql sentence.
String	getSql() Retrieve static sql from a node, the dynamic parts is skipped.
String	getSql(Object params) Retrieve dynamic sql from a node, the dynamic parts is evaluated at time to create the sql.
SqlCommandType	getSqlCommandType() Retrieve node type: INSERT, UPDATE, DELETE, SELECT or PROCEDURE.

Method Detail

getSql

String getSql()

Retrieve static sql from a node, the dynamic parts is skipped.

Returns:

Sql sentence

getSql

String getSql(Object params)

Retrieve dynamic sql from a node, the dynamic parts is evaluated at time to create the sql.

Parameters:

params - parameters to evaluate dynamic sql, can be a object like Author, Book, etc or a java.util.Map where yours keys is like the properties.

Returns:

Dynamic sql sentence

getSqlCommandType

SqlCommandType getSqlCommandType()

Retrieve node type: INSERT, UPDATE, DELETE, SELECT or PROCEDURE.

Returns:

node type declared at xml file.

getLanguageType

LanguageType getLanguageType()

Retrieve the language type used at sql sentence.

Returns:

language type declared at xml file.