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

Class ProcedureParameterTag

java.lang.Object

net.sf.jkniv.sqlegance.builder.xml.ProcedureParameterTag

public class ProcedureParameterTag
extends Object

Tag of stored procedure parameters 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_MODE
static String	ATTRIBUTE_PROPERTY
static String	ATTRIBUTE_SQLTYPE
static String	ATTRIBUTE_TYPENAME
static String	TAG_NAME

Constructor Summary

Constructors

Constructor	Description
ProcedureParameterTag(String property, String mode)	Build a parameter with your values.
ProcedureParameterTag(String property, String mode, String sqlType)	Build a parameter with your values.
ProcedureParameterTag(String property, String mode, String sqlType, String typeName)	Build a parameter with your values.

Method Summary

Modifier and Type	Method	Description
ParameterMode	getMode()	mode from stored procedure parameter
String	getProperty()	Property name from object parameter, can be a object like Author, Book, etc.
int	getSqlType()	SQL type from parameter
String	getTagName()	Retrieve the tag name.
String	getTypeName()	The fully-qualified name of an SQL structured type

Methods inherited from class java.lang.Object

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

Field Detail

TAG_NAME

public static final String TAG_NAME

See Also:

Constant Field Values

ATTRIBUTE_PROPERTY

public static final String ATTRIBUTE_PROPERTY

See Also:

Constant Field Values

ATTRIBUTE_MODE

public static final String ATTRIBUTE_MODE

See Also:

Constant Field Values

ATTRIBUTE_SQLTYPE

public static final String ATTRIBUTE_SQLTYPE

See Also:

Constant Field Values

ATTRIBUTE_TYPENAME

public static final String ATTRIBUTE_TYPENAME

See Also:

Constant Field Values

Constructor Detail

ProcedureParameterTag

public ProcedureParameterTag(String property,
                             String mode,
                             String sqlType,
                             String typeName)

Build a parameter with your values.

Parameters:

property - Name from property.

mode - The mode from procedure parameter: IN, OUT, INOUT. The value is insensitive-case

sqlType - Name of one constant at java.sql.Types, sample: BOOLEAN, CHAR, etc. The value is insensitive-case. One type that's not belong to jav.sql.Types throw one ConfigurationException.

typeName - the fully-qualified name of an SQL structured type

Throws:

RepositoryException - TODO javadoc

ProcedureParameterTag

public ProcedureParameterTag(String property,
                             String mode,
                             String sqlType)

Build a parameter with your values.

Parameters:

property - Name from property.

mode - The mode from procedure parameter: IN, OUT, INOUT. The value is insensitive-case

sqlType - Name of one constant at java.sql.Types, sample: BOOLEAN, CHAR, etc. The value is insensitive-case. One type that's not belong to jav.sql.Types throw one ConfigurationException.

Throws:

RepositoryException - TODO javadoc

ProcedureParameterTag

public ProcedureParameterTag(String property,
                             String mode)

Build a parameter with your values.

Parameters:

property - Name from property.

mode - The mode from procedure parameter: IN, OUT, INOUT. The value is insensitive-case

Throws:

RepositoryException - TODO javadoc

Method Detail

getTagName

public String getTagName()

Retrieve the tag name.

Returns:

name from tag paramenter.

getProperty

public String getProperty()

Property name from object parameter, can be a object like Author, Book, etc. or a java.util.Map where the key is the property value.

Returns:

the property value declared at XML file.

getSqlType

public int getSqlType()

SQL type from parameter

Returns:

type of stored procedure parameter.

getMode

public ParameterMode getMode()

mode from stored procedure parameter

Returns:

the mode declared at XML file.

getTypeName

public String getTypeName()

The fully-qualified name of an SQL structured type

Returns:

Return names of user-named or REF output parameter (STRUCT, DISTINCT, JAVA_OBJECT, and named array types) parameter the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given