Difference between revisions of "GVBufferMapping"
(Created page with "This element specifies how to map the GVBuffer fields with output parameters by store procedure. It has two subelements: * Description; * GVBufferFieldOutput+. ==GVBufferFiel...") |
(→CallSPSimpleBaseFormatter) |
||
(7 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | This element specifies how to map the GVBuffer fields with output parameters by store procedure. | + | This element specifies how to map the [[GVBuffer]] fields with output parameters by store procedure. |
− | + | Might contain the following sub-elements: | |
− | * Description | + | * [[Description]] |
− | * GVBufferFieldOutput | + | * [[#GVBufferFieldOutput|GVBufferFieldOutput]] |
− | ==GVBufferFieldOutput== | + | ===GVBufferFieldOutput=== |
− | + | GVBufferFieldOutput element defines the [[GVBuffer]] field that will be mapped with the output parameters from the store procedure. | |
− | It | + | It is used by: [[GVBufferMapping]]. |
− | + | The following table shows its attributes: | |
− | + | {|class="gvtable" | |
+ | ! Attribute !! Type !! Description | ||
+ | |- | ||
+ | | name || optional || Defines the name of the field to map | ||
+ | |- | ||
+ | | setterMethod || required || Defines the method that populates the [[GVBuffer]] field with the output parameter from store procedure. | ||
+ | See [[GVBufferSetMethods]] | ||
+ | |- | ||
+ | | property || optional || This attribute defines the value of the [[GVBuffer]] property if the method is setProperty() | ||
+ | |- | ||
+ | | type || required || Defines the Java type of the [[GVBuffer]] field. | ||
+ | The attribute's admitted values are: | ||
+ | * string | ||
+ | * int | ||
+ | * long | ||
+ | * byte_array | ||
+ | |} | ||
− | + | Might contain the following sub-elements: | |
+ | * [[Description]] | ||
+ | * [[#CallSPSimpleBaseFormatter|CallSPSimpleBaseFormatter]] | ||
− | + | ====CallSPSimpleBaseFormatter==== | |
− | + | ||
− | + | This formatter reads the value of the output parameter from a call to store procedures. | |
− | + | ||
+ | The CallSPSimpleBaseFormatter Element is used by: GVBufferFieldOutput. | ||
+ | |||
+ | The following table shows its attributes: | ||
+ | {|class="gvtable" | ||
+ | ! Attribute !! Type !! Description | ||
+ | |- | ||
+ | | type || fixed || This attribute must assume the value '''base_formatter'''. | ||
+ | |- | ||
+ | | class || fixed || This attribute must assume the value | ||
+ | '''it.greenvulcano.gvesb.j2ee.db.formatter.base.CallSPSimpleBaseFormatter''' | ||
+ | |- | ||
+ | | stylesheet || optional || Transformation to be applied after the store procedure. | ||
+ | |- | ||
+ | | structure || optional || This element defines the structure of the XML document that wraps the query result. | ||
+ | * ONLY_DATA Inserts into the XML document only the output of the query. | ||
+ | * METADATA_AND_DATA Inserts into the XML document the query output, and some information about DB objects (table, fields) | ||
+ | The attribute's default value is: METADATA_AND_DATA. | ||
+ | The attribute's admitted values are: | ||
+ | |- | ||
+ | | outputParamIndex || required || This attribute defines the position parameter has in the statement. | ||
+ | |} | ||
+ | |||
+ | Might contain the following sub-elements: | ||
+ | * [[Description]] |
Latest revision as of 12:08, 12 November 2012
This element specifies how to map the GVBuffer fields with output parameters by store procedure.
Might contain the following sub-elements:
GVBufferFieldOutput
GVBufferFieldOutput element defines the GVBuffer field that will be mapped with the output parameters from the store procedure.
It is used by: GVBufferMapping.
The following table shows its attributes:
Attribute | Type | Description |
---|---|---|
name | optional | Defines the name of the field to map |
setterMethod | required | Defines the method that populates the GVBuffer field with the output parameter from store procedure. |
property | optional | This attribute defines the value of the GVBuffer property if the method is setProperty() |
type | required | Defines the Java type of the GVBuffer field.
The attribute's admitted values are:
|
Might contain the following sub-elements:
CallSPSimpleBaseFormatter
This formatter reads the value of the output parameter from a call to store procedures.
The CallSPSimpleBaseFormatter Element is used by: GVBufferFieldOutput.
The following table shows its attributes:
Attribute | Type | Description |
---|---|---|
type | fixed | This attribute must assume the value base_formatter. |
class | fixed | This attribute must assume the value
it.greenvulcano.gvesb.j2ee.db.formatter.base.CallSPSimpleBaseFormatter |
stylesheet | optional | Transformation to be applied after the store procedure. |
structure | optional | This element defines the structure of the XML document that wraps the query result.
The attribute's default value is: METADATA_AND_DATA. The attribute's admitted values are: |
outputParamIndex | required | This attribute defines the position parameter has in the statement. |
Might contain the following sub-elements: