Java Doc for BindVariable.java in  » Database-Client » iSQL-Viewer » org » isqlviewer » 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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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 Client » iSQL Viewer » org.isqlviewer 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.isqlviewer.BindVariable

BindVariable
public class BindVariable implements Comparable<BindVariable>(Code)
Represents parameterized data for bookmarks and historical items that are to be executed as a prepared statement.

Each parameter has an optional index to specify the order in the prepared statement to bound in. If the order is not specified it will be automatically set based on the order it was added to the bookmark.

Each parameter has the user data to be transformed into a specific object in the form of a string, the format options will represent a string of commands to transform the user data into the specific type.
author:
   Mark A. Kobold <mkobold at isqlviewer dot com>
version:
   1.0





Method Summary
public  intcompareTo(BindVariable o)
     Compares this parameter data to another for ordering by the index of the parameter.


Parameters:
  o - other bookmark parameter data to be comparaed against.

public  StringgetFormatOptions()
     Returns the formatting options to be applied to the user data.
public  intgetIndex()
     Gets the index of this parameter as part of the prepared statement.

This value will be a number of 1..n where n is total number of parameters for a bookmark.

public  intgetType()
     Get the SQL type that represents the intended data type for this parameter.

This should always be a value that is defined within the java.sql.Types interface.

public  StringgetUserData()
     Gets the user data that represents the actual data to be bound to the prepared statement.

If there are formatting options those commands will be applied to this content to transform it to the target data-type.

This value can be null if not specified.

public  voidsetFormatOptions(String formatOptions)
     Sets the formatting options and commands for the user data.
public  voidsetIndex(int index)
     Sets the parameter index for determining order for a prepared statement.


Parameters:
  index - order of the parameter binding.

public  voidsetType(int type)
     Sets the SQL data-type for the parameter.
public  voidsetUserData(String userData)
     Sets the user data to be bound to a prepared statement.



Method Detail
compareTo
public int compareTo(BindVariable o)(Code)
Compares this parameter data to another for ordering by the index of the parameter.


Parameters:
  o - other bookmark parameter data to be comparaed against. number indicating relative value as specificed by comparable.
See Also:   Comparable




getFormatOptions
public String getFormatOptions()(Code)
Returns the formatting options to be applied to the user data.

These commands are semi-colon ';' seperated commands that will be applied to the user data field of this object in order to transfor the user data in to the proper data type. formatting options and commands for the user data; can be null.




getIndex
public int getIndex()(Code)
Gets the index of this parameter as part of the prepared statement.

This value will be a number of 1..n where n is total number of parameters for a bookmark. if the value is anything else like 0 or less then actual index will be determined automatically by the bookmark this instance is added to. index of this parameter for order within a prepared statement.




getType
public int getType()(Code)
Get the SQL type that represents the intended data type for this parameter.

This should always be a value that is defined within the java.sql.Types interface. The Types interface defines the domain of inteded values for this field. the intended SQL data type for this parameter.
See Also:   java.sql.Types




getUserData
public String getUserData()(Code)
Gets the user data that represents the actual data to be bound to the prepared statement.

If there are formatting options those commands will be applied to this content to transform it to the target data-type.

This value can be null if not specified. It is not recommended to use the NULL Type for null values as that is not actually what the NULL type is for, so if a null date is needed that still use the DATE data-type. user data that represents the data to be bound to a prepared statement.




setFormatOptions
public void setFormatOptions(String formatOptions)(Code)
Sets the formatting options and commands for the user data.


Parameters:
  formatOptions - The formatOptions for the user data to set; use null to disable.




setIndex
public void setIndex(int index)(Code)
Sets the parameter index for determining order for a prepared statement.


Parameters:
  index - order of the parameter binding. within a prepared statement; use 0 or less to make index automatic.




setType
public void setType(int type)(Code)
Sets the SQL data-type for the parameter.


Parameters:
  type - data-type identifier as defined by java.sql.Types.
See Also:   java.sql.Types




setUserData
public void setUserData(String userData)(Code)
Sets the user data to be bound to a prepared statement.


Parameters:
  userData - that represents the data-type; can be null.




Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.