Package net.sf.jkniv.sqlegance.builder.xml

Class ProcedureTag

java.lang.Object

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

net.sf.jkniv.sqlegance.builder.xml.ProcedureTag

All Implemented Interfaces:

SqlTag, Sql, Storable

public class ProcedureTag
extends AbstractSqlTag
implements SqlTag, Storable

Tag of procedure sentence. Stored procedures don't work yet!

Since:

0.0.2

Author:

Alisson Gomes

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTRIBUTE_SPNAME
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	Description
ProcedureTag(String id, LanguageType languageType, Statistical stats)	Build a new procedure tag from XML file.
ProcedureTag(String id, LanguageType languageType, Isolation isolation, int timeout, ValidateType validateType, Statistical stats)	Build a new procedure tag from XML file.

Method Summary

Modifier and Type	Method	Description
Storable	asStorable()	Storable instance
ProcedureParameterTag[]	getParams()	Retrieve parameter from stored procedure
String	getSpName()	Retrieve the name from stored procedure.
SqlType	getSqlType()	Command type to execute.
String	getTagName()	Retrieve the tag name.
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	isUpdateable()	Verify if command is a UPDATE
void	setParams(ProcedureParameterTag[] params)	Define parameters from stored procedure
void	setSpName(String spName)	Define the name of stored procedure.

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

addTag, addTag, addTag, asDeletable, asInsertable, asSelectable, asUpdateable, bind, equals, extractNames, extractNames, getIsolation, getLanguageType, getName, getPackage, getParamParser, getResourceName, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getReturnType, getReturnTypeAsClass, getSql, getSql, getSqlDialect, getStats, getTimeout, getTimestamp, getValidateType, getXPath, hashCode, hasReturnType, isStorable, 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.Sql

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

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

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

Field Detail

TAG_NAME

public static final String TAG_NAME

See Also:

Constant Field Values

ATTRIBUTE_SPNAME

public static final String ATTRIBUTE_SPNAME

See Also:

Constant Field Values

Constructor Detail

ProcedureTag

public ProcedureTag(String id,
                    LanguageType languageType,
                    Statistical stats)

Build a new procedure tag from XML file.

Parameters:

id - Name/Identify from tag.

languageType - type of language from tag.

stats - statistical for procedures

ProcedureTag

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

Build a new procedure 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

Method Detail

getTagName

public String getTagName()

Retrieve the tag name.

Specified by:

getTagName in interface SqlTag

Returns:

name from tag procedure.

getSqlType

public SqlType getSqlType()

Command type to execute.

Specified by:

getSqlType in interface Sql

Returns:

the type of command used, DELETE.

isSelectable

public boolean isSelectable()

Description copied from interface: Sql

Verify if command is a SELECT

Specified by:

isSelectable in interface Sql

Overrides:

isSelectable in class AbstractSqlTag

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

Overrides:

isInsertable in class AbstractSqlTag

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

Overrides:

isUpdateable in class AbstractSqlTag

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

Overrides:

isDeletable in class AbstractSqlTag

Returns:

true when is DELETE, false otherwise

setParams

public void setParams(ProcedureParameterTag[] params)

Define parameters from stored procedure

Parameters:

params - the parameters

getParams

public ProcedureParameterTag[] getParams()

Description copied from interface: Storable

Retrieve parameter from stored procedure

Specified by:

getParams in interface Storable

Returns:

the parameters

setSpName

public void setSpName(String spName)

Define the name of stored procedure.

Parameters:

spName - name of stored procedure.

getSpName

public String getSpName()

Description copied from interface: Storable

Retrieve the name from stored procedure.

Specified by:

getSpName in interface Storable

Returns:

name of stored procedure

asStorable

public Storable asStorable()

Description copied from interface: Sql

Storable instance

Specified by:

asStorable in interface Sql

Overrides:

asStorable in class AbstractSqlTag

Returns:

this instance