net.sf.jkniv.sqlegance.builder.xml

Class AbstractSqlTag

java.lang.Object

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

All Implemented Interfaces:

ISql, ISqlTag

Direct Known Subclasses:

DeleteTag, IncludeTag, InsertTag, ProcedureTag, SelectTag, UpdateTag

public abstract class AbstractSqlTag
extends Object
implements ISqlTag

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_NAME
static String	ATTRIBUTE_TYPE
protected String	id
protected LanguageType	languageType
org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
AbstractSqlTag(String id, LanguageType languageType) Build a new SQL tag from XML file.

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.
LanguageType	getLanguageType() language from SQL sentence.
String	getName() Retrieve the identifier name from tag.
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.

Methods inherited from class java.lang.Object

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

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

getTagName

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

getSqlCommandType

Field Detail

log

public final org.slf4j.Logger log

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

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.

Method Detail

getSql

public String getSql()

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

Specified by:

getSql in interface ISql

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 ISql

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 ISql

Returns:

the type of language used to SQL sentence.

getName

public String getName()

Retrieve the identifier name from tag.

Specified by:

getName in interface ISqlTag

Returns:

name from tag

addTag

public void addTag(ITextTag tag)

add a new text tag.

Specified by:

addTag in interface ISqlTag

addTag

public void addTag(String text)

add a set of static text from tag elements.

Specified by:

addTag in interface ISqlTag

addTag

public void addTag(List<ITextTag> tags)

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

Specified by:

addTag in interface ISqlTag