net.sf.jkniv.sqlegance.builder.xml

Class AbstractSqlTag

java.lang.Object

net.sf.jkniv.sqlegance.builder.xml.AbstractSqlTag

All Implemented Interfaces:

SqlTag, Sql

Direct Known Subclasses:

IncludeTag, ProcedureTag

public abstract class AbstractSqlTag
extends Object
implements SqlTag

Generic tag to support the common functions from other tags.

Since:

0.0.2

Author:

Alisson Gomes

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_BATCH
static String	ATTRIBUTE_CACHE
static String	ATTRIBUTE_GROUP_BY
static String	ATTRIBUTE_HINT
static String	ATTRIBUTE_ISOLATION
static String	ATTRIBUTE_NAME
static String	ATTRIBUTE_RESULTSET_CONCURRENCY
static String	ATTRIBUTE_RESULTSET_HOLDABILITY
static String	ATTRIBUTE_RESULTSET_TYPE
static String	ATTRIBUTE_RETURN_TYPE
static String	ATTRIBUTE_TIMEOUT
static String	ATTRIBUTE_TYPE
static String	ATTRIBUTE_VALIDATION
protected String	id
protected LanguageType	languageType
protected static Assertable	NOT_NULL

Constructor Summary

Constructors

Constructor and Description
AbstractSqlTag(String id, LanguageType languageType) Build a new SQL tag from XML file.
AbstractSqlTag(String id, LanguageType languageType, Isolation isolation, int timeout, ResultSetType resultSetType, ResultSetConcurrency resultSetConcurrency, ResultSetHoldability resultSetHoldability, String returnType, ValidateType validateType, Statistical stats) Build a new SQL tag from XML file.
AbstractSqlTag(String id, LanguageType languageType, Isolation isolation, int timeout, ValidateType validateType, Statistical stats) Build a new SQL tag from XML file.
AbstractSqlTag(String id, LanguageType languageType, SqlDialect sqlDialect)

Method Summary

Modifier and Type	Method and Description
void	addTag(ITextTag tag) add a new text tag.
void	addTag(List<ITextTag> tags) add a set of text tags (static or dynamic).
void	addTag(String text) add a set of static text from tag elements.
Deletable	asDeletable() Deletable instance
Insertable	asInsertable() Insertable instance
Selectable	asSelectable() Selectable instance
Storable	asStorable() Storable instance
Updateable	asUpdateable() Updateable instance
void	bind(SqlDialect sqlDialect)
boolean	equals(Object obj)
String[]	extractNames(Object params) Extract the name parameters from dynamic query
String[]	extractNames(String sql) Extract the name parameters from SQL
Isolation	getIsolation() Retrieves the current transaction isolation level for the query.
LanguageType	getLanguageType() language from SQL sentence.
String	getName() Retrieve the identifier name from tag.
String	getPackage() name of package that this SQL belongs
ParamParser	getParamParser() strategy to parser the parameters from SQL.
String	getResourceName() The filename that SQL belong to
ResultSetConcurrency	getResultSetConcurrency()
ResultSetHoldability	getResultSetHoldability()
ResultSetType	getResultSetType()
String	getReturnType()
Class<?>	getReturnTypeAsClass()
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.
SqlDialect	getSqlDialect() dialect for a specific database
Statistical	getStats() get statistical data from query execution
int	getTimeout() Retrieves the number of seconds the repository will wait for a Query object to execute.
Date	getTimestamp() Timestamp when sql was read from xml
ValidateType	getValidateType()
String	getXPath() Expression XPATH to read SQL
int	hashCode()
boolean	hasReturnType()
boolean	isDeletable() Verify if command is a DELETE
boolean	isInsertable() Verify if command is a INSERT
boolean	isSelectable() Verify if command is a SELECT
boolean	isStorable() Verify if command is a STORED PROCEDURE
boolean	isUpdateable() Verify if command is a UPDATE
void	setIsolation(Isolation isolation)
void	setPackage(String name) name of package this sql belong
void	setResourceName(String resourceName) File name from Sql
void	setResultSetConcurrency(ResultSetConcurrency resultSetConcurrency)
void	setResultSetHoldability(ResultSetHoldability resultSetHoldability)
void	setResultSetType(ResultSetType resultSetType)
void	setResultType(String returnType)
protected void	setStats(Statistical stats)
void	setTimeout(int timeout)
void	setValidateType(ValidateType validateType)
void	setXpath(String xpath) set the XPATH expression to retrieve the query at xml file.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.jkniv.sqlegance.builder.xml.SqlTag

getTagName

Methods inherited from interface net.sf.jkniv.sqlegance.Sql

getSqlType

Field Detail

NOT_NULL

protected static final Assertable NOT_NULL

ATTRIBUTE_NAME

public static final String ATTRIBUTE_NAME

See Also:

Constant Field Values

ATTRIBUTE_TYPE

public static final String ATTRIBUTE_TYPE

See Also:

Constant Field Values

ATTRIBUTE_ISOLATION

public static final String ATTRIBUTE_ISOLATION

See Also:

Constant Field Values

ATTRIBUTE_TIMEOUT

public static final String ATTRIBUTE_TIMEOUT

See Also:

Constant Field Values

ATTRIBUTE_HINT

public static final String ATTRIBUTE_HINT

See Also:

Constant Field Values

ATTRIBUTE_BATCH

public static final String ATTRIBUTE_BATCH

See Also:

Constant Field Values

ATTRIBUTE_CACHE

public static final String ATTRIBUTE_CACHE

See Also:

Constant Field Values

ATTRIBUTE_RETURN_TYPE

public static final String ATTRIBUTE_RETURN_TYPE

See Also:

Constant Field Values

ATTRIBUTE_GROUP_BY

public static final String ATTRIBUTE_GROUP_BY

See Also:

Constant Field Values

ATTRIBUTE_RESULTSET_TYPE

public static final String ATTRIBUTE_RESULTSET_TYPE

See Also:

Constant Field Values

ATTRIBUTE_RESULTSET_CONCURRENCY

public static final String ATTRIBUTE_RESULTSET_CONCURRENCY

See Also:

Constant Field Values

ATTRIBUTE_RESULTSET_HOLDABILITY

public static final String ATTRIBUTE_RESULTSET_HOLDABILITY

See Also:

Constant Field Values

ATTRIBUTE_VALIDATION

public static final String ATTRIBUTE_VALIDATION

See Also:

Constant Field Values

id

protected String id

languageType

protected LanguageType languageType

Constructor Detail

AbstractSqlTag

public AbstractSqlTag(String id,
                      LanguageType languageType)

Build a new SQL tag from XML file.

Parameters:

id - Name/Identify from tag.

languageType - type of language from tag.

AbstractSqlTag

public AbstractSqlTag(String id,
                      LanguageType languageType,
                      SqlDialect sqlDialect)

AbstractSqlTag

public AbstractSqlTag(String id,
                      LanguageType languageType,
                      Isolation isolation,
                      int timeout,
                      ValidateType validateType,
                      Statistical stats)

Build a new SQL tag from XML file.

Parameters:

id - Name/Identify from tag.

languageType - type of language from tag.

isolation - Retrieves the current transaction isolation level for the query.

timeout - Retrieves the number of seconds the repository will wait for a Query object to execute.

validateType - validation to apply before execute SQL.

stats - SQL statistical

AbstractSqlTag

public AbstractSqlTag(String id,
                      LanguageType languageType,
                      Isolation isolation,
                      int timeout,
                      ResultSetType resultSetType,
                      ResultSetConcurrency resultSetConcurrency,
                      ResultSetHoldability resultSetHoldability,
                      String returnType,
                      ValidateType validateType,
                      Statistical stats)

Build a new SQL tag from XML file.

Parameters:

id - Name/Identify from tag.

languageType - type of language from tag.

isolation - Retrieves the current transaction isolation level for the query.

timeout - Retrieves the number of seconds the repository will wait for a Query object to execute.

resultSetType - TODO javadoc

resultSetConcurrency - TODO javadoc

resultSetHoldability - TODO javadoc

returnType - v

validateType - TODO javadoc

stats - statistical for procedures

Method Detail

getSql

public String getSql()

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

Specified by:

getSql in interface Sql

Returns:

Sql sentence

getSql

public String getSql(Object params)

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

Specified by:

getSql in interface 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

getLanguageType

public LanguageType getLanguageType()

language from SQL sentence.

Specified by:

getLanguageType in interface Sql

Returns:

the type of language used to SQL sentence.

getName

public String getName()

Retrieve the identifier name from tag.

Specified by:

getName in interface SqlTag

Specified by:

getName in interface Sql

Returns:

name from tag

addTag

public void addTag(ITextTag tag)

add a new text tag.

Specified by:

addTag in interface SqlTag

Parameters:

tag - content as another tag

addTag

public void addTag(String text)

add a set of static text from tag elements.

Specified by:

addTag in interface SqlTag

Parameters:

text - content

addTag

public void addTag(List<ITextTag> tags)

add a set of text tags (static or dynamic).

Specified by:

addTag in interface SqlTag

Parameters:

tags - content as list of text tags

getIsolation

public Isolation getIsolation()

Description copied from interface: Sql

Retrieves the current transaction isolation level for the query.

Specified by:

getIsolation in interface Sql

Returns:

the current transaction isolation level.

setIsolation

public void setIsolation(Isolation isolation)

getTimeout

public int getTimeout()

Description copied from interface: Sql

Retrieves the number of seconds the repository will wait for a Query object to execute. If the limit is exceeded, a RepositoryException is thrown.

Specified by:

getTimeout in interface Sql

Returns:

the current query timeout limit in seconds; zero means there is no limit

setTimeout

public void setTimeout(int timeout)

isSelectable

public boolean isSelectable()

Description copied from interface: Sql

Verify if command is a SELECT

Specified by:

isSelectable in interface Sql

Returns:

true when is SELECT, false otherwise

isInsertable

public boolean isInsertable()

Description copied from interface: Sql

Verify if command is a INSERT

Specified by:

isInsertable in interface Sql

Returns:

true when is INSERT, false otherwise

isUpdateable

public boolean isUpdateable()

Description copied from interface: Sql

Verify if command is a UPDATE

Specified by:

isUpdateable in interface Sql

Returns:

true when is UPDATE, false otherwise

isDeletable

public boolean isDeletable()

Description copied from interface: Sql

Verify if command is a DELETE

Specified by:

isDeletable in interface Sql

Returns:

true when is DELETE, false otherwise

asSelectable

public Selectable asSelectable()

Description copied from interface: Sql

Selectable instance

Specified by:

asSelectable in interface Sql

Returns:

this instance

asInsertable

public Insertable asInsertable()

Description copied from interface: Sql

Insertable instance

Specified by:

asInsertable in interface Sql

Returns:

this instance

asUpdateable

public Updateable asUpdateable()

Description copied from interface: Sql

Updateable instance

Specified by:

asUpdateable in interface Sql

Returns:

this instance

asDeletable

public Deletable asDeletable()

Description copied from interface: Sql

Deletable instance

Specified by:

asDeletable in interface Sql

Returns:

this instance

isStorable

public boolean isStorable()

Description copied from interface: Sql

Verify if command is a STORED PROCEDURE

Specified by:

isStorable in interface Sql

Returns:

true when is STORED PROCEDURE, false otherwise

asStorable

public Storable asStorable()

Description copied from interface: Sql

Storable instance

Specified by:

asStorable in interface Sql

Returns:

this instance

getResultSetType

public ResultSetType getResultSetType()

Specified by:

getResultSetType in interface Sql

setResultSetType

public void setResultSetType(ResultSetType resultSetType)

getResultSetConcurrency

public ResultSetConcurrency getResultSetConcurrency()

Specified by:

getResultSetConcurrency in interface Sql

setResultSetConcurrency

public void setResultSetConcurrency(ResultSetConcurrency resultSetConcurrency)

getResultSetHoldability

public ResultSetHoldability getResultSetHoldability()

Specified by:

getResultSetHoldability in interface Sql

setResultSetHoldability

public void setResultSetHoldability(ResultSetHoldability resultSetHoldability)

setResultType

public void setResultType(String returnType)

getReturnType

public String getReturnType()

Specified by:

getReturnType in interface Sql

hasReturnType

public boolean hasReturnType()

Specified by:

hasReturnType in interface Sql

getReturnTypeAsClass

public Class<?> getReturnTypeAsClass()

Specified by:

getReturnTypeAsClass in interface Sql

setValidateType

public void setValidateType(ValidateType validateType)

Specified by:

setValidateType in interface Sql

getValidateType

public ValidateType getValidateType()

Specified by:

getValidateType in interface Sql

setXpath

public void setXpath(String xpath)

Description copied from interface: SqlTag

set the XPATH expression to retrieve the query at xml file.

Specified by:

setXpath in interface SqlTag

Parameters:

xpath - expression

getXPath

public String getXPath()

Description copied from interface: Sql

Expression XPATH to read SQL

Specified by:

getXPath in interface Sql

Returns:

the XPATH expression to read the SQL at XML file.

setResourceName

public void setResourceName(String resourceName)

Description copied from interface: SqlTag

File name from Sql

Specified by:

setResourceName in interface SqlTag

Parameters:

resourceName - filename from sql as resource

getResourceName

public String getResourceName()

Description copied from interface: Sql

The filename that SQL belong to

Specified by:

getResourceName in interface Sql

Returns:

return the filename, relative to absolute classpath, where the SQL was read.

getTimestamp

public Date getTimestamp()

Description copied from interface: Sql

Timestamp when sql was read from xml

Specified by:

getTimestamp in interface Sql

Returns:

when SQL was read from XML file

getParamParser

public ParamParser getParamParser()

Description copied from interface: Sql

strategy to parser the parameters from SQL.

Specified by:

getParamParser in interface Sql

Returns:

return the implementation of parser (colon, hash or question mark)

extractNames

public String[] extractNames(Object params)

Description copied from interface: Sql

Extract the name parameters from dynamic query

Specified by:

extractNames in interface Sql

Parameters:

params - parameters from query

Returns:

array of parameters names from query, array based-zero length when haven't param. Array of questions marks (?) is returned when the isn't name based.

extractNames

public String[] extractNames(String sql)

Description copied from interface: Sql

Extract the name parameters from SQL

Specified by:

extractNames in interface Sql

Parameters:

sql - sentence

Returns:

array of parameters names from query, array based-zero length when haven't param. Array of questions marks (?) is returned when the isn't name based.

bind

public void bind(SqlDialect sqlDialect)

Specified by:

bind in interface Sql

getSqlDialect

public SqlDialect getSqlDialect()

Description copied from interface: Sql

dialect for a specific database

Specified by:

getSqlDialect in interface Sql

Returns:

the dialect

getPackage

public String getPackage()

Description copied from interface: Sql

name of package that this SQL belongs

Specified by:

getPackage in interface Sql

Returns:

name of package

setPackage

public void setPackage(String name)

Description copied from interface: SqlTag

name of package this sql belong

Specified by:

setPackage in interface SqlTag

Parameters:

name - of package

getStats

public Statistical getStats()

Description copied from interface: Sql

get statistical data from query execution

Specified by:

getStats in interface Sql

Returns:

the statistical like min/max/avg times.

setStats

protected void setStats(Statistical stats)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object