net.sf.jkniv.sqlegance.builder.xml

Class IncludeTag

java.lang.Object

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

net.sf.jkniv.sqlegance.builder.xml.IncludeTag

All Implemented Interfaces:

SqlTag, Sql

public class IncludeTag
extends AbstractSqlTag
implements SqlTag

Tag of include xml file. Include tag is used to organize xml sentences at many files separated.

Since:

0.0.2

Author:

Alisson Gomes

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_HREF
static String	TAG_NAME

Fields inherited from class net.sf.jkniv.sqlegance.builder.xml.AbstractSqlTag

ATTRIBUTE_BATCH, ATTRIBUTE_CACHE, ATTRIBUTE_GROUP_BY, ATTRIBUTE_HINT, ATTRIBUTE_ISOLATION, ATTRIBUTE_NAME, ATTRIBUTE_RESULTSET_CONCURRENCY, ATTRIBUTE_RESULTSET_HOLDABILITY, ATTRIBUTE_RESULTSET_TYPE, ATTRIBUTE_RETURN_TYPE, ATTRIBUTE_TIMEOUT, ATTRIBUTE_TYPE, ATTRIBUTE_VALIDATION, id, languageType, NOT_NULL

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getSql(Object params) Retrieve dynamic sql from a node, the dynamic parts is evaluated at time to create the sql.
SqlType	getSqlType() Command type to execute.
String	getTagName() Retrieve the tag name.

Methods inherited from class net.sf.jkniv.sqlegance.builder.xml.AbstractSqlTag

addTag, addTag, addTag, asDeletable, asInsertable, asSelectable, asStorable, asUpdateable, bind, equals, extractNames, extractNames, getIsolation, getLanguageType, getName, getPackage, getParamParser, getResourceName, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getReturnType, getReturnTypeAsClass, getSql, getSqlDialect, getStats, getTimeout, getTimestamp, getValidateType, getXPath, hashCode, hasReturnType, isDeletable, isInsertable, isSelectable, isStorable, isUpdateable, setIsolation, setPackage, setResourceName, setResultSetConcurrency, setResultSetHoldability, setResultSetType, setResultType, setStats, setTimeout, setValidateType, setXpath

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

addTag, addTag, addTag, getName, setPackage, setResourceName, setXpath

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

asDeletable, asInsertable, asSelectable, asStorable, asUpdateable, bind, extractNames, extractNames, getIsolation, getLanguageType, getPackage, getParamParser, getResourceName, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getReturnType, getReturnTypeAsClass, getSql, getSqlDialect, getStats, getTimeout, getTimestamp, getValidateType, getXPath, hasReturnType, isDeletable, isInsertable, isSelectable, isStorable, isUpdateable, setValidateType

Field Detail

TAG_NAME

public static final String TAG_NAME

See Also:

Constant Field Values

ATTRIBUTE_HREF

public static final String ATTRIBUTE_HREF

See Also:

Constant Field Values

Constructor Detail

IncludeTag

public IncludeTag(String id,
                  LanguageType languageType)

Build a new include tag from XML file.

Parameters:

id - Name/Identify from tag

languageType - type of language from tag

Method Detail

getSql

public String getSql(Object params)

Description copied from class: AbstractSqlTag

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

Specified by:

getSql in interface Sql

Overrides:

getSql in class AbstractSqlTag

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:

NULL is returned, because this tag isn't SQL sentence.

getTagName

public String getTagName()

Retrieve the tag name.

Specified by:

getTagName in interface SqlTag

Returns:

name from tag include.

getSqlType

public SqlType getSqlType()

Command type to execute.

Specified by:

getSqlType in interface Sql

Returns:

the type of command used, UNKNOW.