Java Doc for ParameterValueSet.java in » Database-DBMS » db-derby-10.2 » org » apache » derby » iapi » sql » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Database DBMS » db derby 10.2 » org.apache.derby.iapi.sql

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.apache.derby.iapi.sql .ParameterValueSet

All known Subclasses:   org.apache.derby.impl.sql .GenericParameterValueSet,
ParameterValueSet
public interface ParameterValueSet (Code)
A ParameterValueSet is a set of parameter values that can be assembled by a JDBC driver and passed to a PreparedStatement all at once. The fact that they are all passed at once can reduce the communication overhead between client and server.
author:
   Jeff Lichtman

Method Summary
boolean allAreSet()
     Tells whether all the parameters are set and ready for execution.
public boolean checkNoDeclaredOutputParameters()
     Check that there are not output parameters defined by the parameter set.
void clearParameters()
     Sets all parameters to an uninitialized state.
ParameterValueSet getClone()
     Clone the ParameterValueSet and its contents.
public DataValueDescriptor getParameter(int position)
     Returns the parameter at the given position.
public int getParameterCount()
     Returns the number of parameters in this set.
public DataValueDescriptor getParameterForGet(int position)
     Get the DataValueDescriptor for an INOUT or OUT parameter.
Parameters:
  position - Zero based index of the parameter.
public DataValueDescriptor getParameterForSet(int position)
     Returns the parameter at the given position in order to set it.
public short getParameterMode(int parameterIndex)

public int getPrecision(int parameterIndex)
     Return the precision of the given parameter index in this pvs.
Parameters:
  parameterIndex - the first parameter is 1, the second is 2, ...
DataValueDescriptor getReturnValueForSet()
     Get the value of the return parameter in order to set it.
public int getScale(int parameterIndex)
     Return the scale of the given parameter index in this pvs.
Parameters:
  parameterIndex - the first parameter is 1, the second is 2, ...
public boolean hasReturnOutputParameter()
     Is there a return output parameter in this pvs.
void initialize(DataTypeDescriptor[] types)
     Initialize the parameter set by allocating DataValueDescriptor corresponding to the passed in type for each parameter.
void registerOutParameter(int parameterIndex, int sqlType, int scale)
     Mark the parameter as an output parameter.
Parameters:
  parameterIndex - The ordinal position of a parameter to setto the given value.
Parameters:
  sqlType - A type from java.sql.Types
Parameters:
  scale - the scale to use.
void setParameterAsObject(int parameterIndex, Object value)
     Set the value of this user defined parameter to the passed in Object.
void setParameterMode(int position, int mode)
     Set the mode of the parameter, called when setting up static method calls and stored procedures.
public void transferDataValues(ParameterValueSet pvstarget)
     Set the parameter values of the pvstarget to equal those set in this PVS. Used to transfer saved SPS parameters to the actual prepared statement parameters once associated parameters have been established.
void validate()
     Validate the parameters.

Method Detail
allAreSet
boolean allAreSet()(Code)
Tells whether all the parameters are set and ready for execution. OUT are not required to be set. true if all parameters are set, false if at least oneparameter is not set.

checkNoDeclaredOutputParameters
public boolean checkNoDeclaredOutputParameters()(Code)
Check that there are not output parameters defined by the parameter set. If there are unknown parameter types they are forced to input types. i.e. Cloudscape static method calls with parameters that are array. true if a declared Java Procedure INOUT or OUT parameter is in the set, false otherwise.

clearParameters
void clearParameters()(Code)
Sets all parameters to an uninitialized state. An exception will be thrown if the caller tries to execute a PreparedStatement when one or more parameters is uninitialized (i.e. has not had setParameterValue() called on it.

getClone
ParameterValueSet getClone()(Code)
Clone the ParameterValueSet and its contents. ParameterValueSet A clone of the ParameterValueSet and its contents.

getParameter
public DataValueDescriptor getParameter(int position) throws StandardException(Code)
Returns the parameter at the given position. The parameter at the given position.
exception:
  StandardException - Thrown on error

getParameterCount
public int getParameterCount()(Code)
Returns the number of parameters in this set. The number of parameters in this set.

getParameterForGet
public DataValueDescriptor getParameterForGet(int position) throws StandardException(Code)
Get the DataValueDescriptor for an INOUT or OUT parameter.
Parameters:
  position - Zero based index of the parameter. Parameter's value holder.
throws:
  StandardException - Position out of range or the parameter is not INOUT or OUT.

getParameterForSet
public DataValueDescriptor getParameterForSet(int position) throws StandardException(Code)
Returns the parameter at the given position in order to set it. Setting via an unknown object type must use setParameterAsObject() to ensure correct typing. The parameter at the given position.
exception:
  StandardException - Thrown on error

getParameterMode
public short getParameterMode(int parameterIndex)(Code)
Return the mode of the parameter according to JDBC 3.0 ParameterMetaData
Parameters:
  parameterIndex - the first parameter is 1, the second is 2, ...

getPrecision
public int getPrecision(int parameterIndex)(Code)
Return the precision of the given parameter index in this pvs.
Parameters:
  parameterIndex - the first parameter is 1, the second is 2, ... precision

getReturnValueForSet
DataValueDescriptor getReturnValueForSet() throws StandardException(Code)
Get the value of the return parameter in order to set it.
exception:
  StandardException - if a database-access error occurs.

getScale
public int getScale(int parameterIndex)(Code)
Return the scale of the given parameter index in this pvs.
Parameters:
  parameterIndex - the first parameter is 1, the second is 2, ... scale

hasReturnOutputParameter
public boolean hasReturnOutputParameter()(Code)
Is there a return output parameter in this pvs. A return parameter is from a CALL statement of the following syntax: ? = CALL myMethod(). Note that a return output parameter is NOT the same thing as an output parameter; it is a special type of output parameter. true if it has a return parameter

initialize
void initialize(DataTypeDescriptor[] types)(Code)
Initialize the parameter set by allocating DataValueDescriptor corresponding to the passed in type for each parameter.
Parameters:
  types - expected to match the number of parameters.

registerOutParameter
void registerOutParameter(int parameterIndex, int sqlType, int scale) throws StandardException(Code)
Mark the parameter as an output parameter.
Parameters:
  parameterIndex - The ordinal position of a parameter to setto the given value.
Parameters:
  sqlType - A type from java.sql.Types
Parameters:
  scale - the scale to use. -1 means ignore scale
exception:
  StandardException - on error

setParameterAsObject
void setParameterAsObject(int parameterIndex, Object value) throws StandardException(Code)
Set the value of this user defined parameter to the passed in Object.
exception:
  StandardException - Thrown on error

setParameterMode
void setParameterMode(int position, int mode)(Code)
Set the mode of the parameter, called when setting up static method calls and stored procedures. Otherwise the parameter type will default to an IN parameter.

transferDataValues
public void transferDataValues(ParameterValueSet pvstarget) throws StandardException(Code)
Set the parameter values of the pvstarget to equal those set in this PVS. Used to transfer saved SPS parameters to the actual prepared statement parameters once associated parameters have been established. Assumes pvstarget is the same length as this.
Parameters:
  pvstarget - ParameterValueSet which will recieve the values
exception:
  StandardException - values not compatible

validate
void validate() throws StandardException(Code)
Validate the parameters. This is done for situations where we cannot validate everything in the setXXX() calls. In particular, before we do an execute() on a CallableStatement, we need to go through the parameters and make sure that all parameters are set up properly. The motivator for this is that setXXX() can be called either before or after registerOutputParamter(), we cannot be sure we have the types correct until we get to execute().
exception:
  StandardException - if the parameters aren't valid

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.