Java Doc for CachedRowSetX.java in  » IDE-Netbeans » visualweb.api.designer » com » sun » sql » rowset » 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 » IDE Netbeans » visualweb.api.designer » com.sun.sql.rowset 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


com.sun.sql.rowset.CachedRowSetX

All known Subclasses:   com.sun.sql.rowset.CachedRowSetXImpl5,
CachedRowSetX
public interface CachedRowSetX extends CachedRowSet(Code)
The extened interface that all implementations of com.sun.sql.rowset.CachedRowSetX must implement.

1.0 Overview

An extension to the CachedRowSet interface.

A com.sun.sql.rowset.CachedRowSetX object differs from a CachedRowSet object in the following ways:

  • An isExecuted() method will return true if the com.sun.sql.rowset.CachedRowSetX is in a state where navigation and getters and setters can be called on rows returned from the database (i.e., returns true if execute or populate has been called.
  • The following "advanced" properties have been added. These properties are useful in the case of incomplete or incorrect information being supplied by JDBC drivers.
    Note: In most cases, these advanced properties do not need to be set (i.e., they can be left set to their default null value (or false in the case of printStatements). For the cases where the advanced properties must be used, it is helpful to set the printStatements property to true first. In that way, one can then determine what advanced properties must be set. By setting the catalog and schema for the table to be upadted and by explicitly setting cataloag, table, schema and column names for each column, one can explicitly set what columns will participate in inserts, updates and deletes. Futher control can be gained by setting the updatableColumns and insertableColumns properties. Note: if updatableColumns is set and insertableColumns is not set, it is assumed that updateableColumns applies to both updates and inserts.
    • catalogName: the name of the catalog that contains the table referred to by tableName
    • schemaName: the name of the schema that contains the table referred to by tableName
    • columnCatalogNames: an array of String , one for each column, which contains the name of catalog of the corresponding column (each element can also be null
    • columnSchemaNames: an array of String , one for each column, which contains the name of the schema of the corresponding column (each element can also be null
    • columnTableNames: an array of String , one for each column, which contains the name of the table of the corresponding column (each element can also be null
    • columnNames: an array of String , one for each column, which contains the name of the corresponding column (each element can also be null
    • insertableColumns: an array of boolean, one for each column, which contains true if the corresponding column can be inserted, else it contains false/code>
    • updatableColumns: an array of boolean, one for each column, which contains true if the corresponding column can be updated, else it contains false/code>
    • printStatements: a boolean{/code> that when true will result in internally generated INSERT, UPDATE, and DELETE SQL statements being written to System.out. This output is useful in determining why inserts,updates and/or deletes are falling and in deciding what advanced properties to set in order to address the problems.
  • PropertyChangeListener support
    The following are bound properties:
    • command
    • dataSourceName
    • maxRows
    • password
    • type
    • url
    • username
  • support to use the com.sun.sql.rowset.CachedRowSetX after calling close on it.
  • by default, a com.sun.sql.rowset.CachedRowSetX 's properties are set to:
    • command: null
    • escapeProcessing: true
    • keyColumns: null
    • (ignored)
    • maxFieldSize: 0
    • maxRows: 0
    • password: null
    • readOnly: true (ignored)
    • showDeleted: false
    • typeMap: null
    • url: null
    • username: null
  • the readOnly property is currently not used
  • it is well defined how property changes affect the state of a com.sun.sql.rowset.CachedRowSetX
    • autoCommit: nothing is invalidated
    • command: release() is called
    • concurrency: nohting is invalidated
    • escapeProcessing: nothing is invalidated
    • maxFieldSize: nothing is invalidated
    • maxRows: nothing is invalidated
    • password: nothing is invalidated
    • readOnly: nothing is invalidated
    • showDeleted: nothing is invalidated
    • transactionIsolation: nothing is invalidated
    • type: nothing is invalidated
    • typeMap: nothing is invalidated
    • url: release() is called
    • username: release() is called
  • calling close will never throw a SQLException




Method Summary
public  voidaddPropertyChangeListener(PropertyChangeListener listener)
     Add a PropertyChangeListener to the listener list.
public  voidaddPropertyChangeListener(String propertyName, PropertyChangeListener listener)
     Add a PropertyChangeListener for a specific property.
public  StringgetCatalogName()
     Returns the catalog in which the table referred to by the tableName property resides.
public  String[]getColumnCatalogNames()
     Returns an array of String .
public  StringgetColumnCatalogNames(int index)
     Returns a String which contains the catalog name set for the column or null.
public  String[]getColumnNames()
     Returns an array of String .
public  StringgetColumnNames(int index)
     Returns a String which contains the column name set for the column or null.
public  String[]getColumnSchemaNames()
     Returns an array of String .
public  StringgetColumnSchemaNames(int index)
     Returns a String which contains the schema name set for the column or null.
public  String[]getColumnTableNames()
     Returns an array of String .
public  StringgetColumnTableNames(int index)
     Returns a String which contains the table name set for the column or null.
public  boolean[]getInsertableColumns()
     Returns an array of boolean{/code>.
public  booleangetInsertableColumns(int index)
     Returns a boolean{/code> of true if the column should be inserted when when adding rows or null.
public  booleangetPrintStatements()
     Returns the printStatements property.
public  StringgetSchemaName()
     Returns the schema in which the table referred to by the tableName property resides.
public  boolean[]getUpdatableColumns()
     Returns an array of boolean{/code>.
public  booleangetUpdatableColumns(int index)
     Returns a boolean{/code> of true if the column should be updated when when updating rows or null.
public  booleanisExecuted()
    
public  voidremovePropertyChangeListener(PropertyChangeListener listener)
     Remove a PropertyChangeListener from the listener list.
public  voidremovePropertyChangeListener(String propertyName, PropertyChangeListener listener)
     Remove a PropertyChangeListener for a specific property.
public  voidsetCatalogName(String catalogName)
     Sets the identifier for catalog of the table referred to in the tableName property.
public  voidsetColumnCatalogNames(String[] columnCatalogNames)
     Set the columnCatalogNames property.
public  voidsetColumnCatalogNames(int index, String columnCatalogName)
     Set the columnCatalogNames property.
public  voidsetColumnNames(String[] columnNames)
     Set the columnNames property.
public  voidsetColumnNames(int index, String columnName)
     Set the columnNames property.
public  voidsetColumnSchemaNames(String[] columnSchemaNames)
     Set the columnSchemaNames property.
public  voidsetColumnSchemaNames(int index, String columnSchemaName)
     Set the columnSchemaNames property.
public  voidsetColumnTableNames(String[] columnTableNames)
     Set the columnTableNames property.
public  voidsetColumnTableNames(int index, String columnTableName)
     Set the columnTableNames property.
public  voidsetInsertableColumns(boolean[] insertableColumns)
     Set the insertableColumns property.
public  voidsetInsertableColumns(int index, boolean insertableColumn)
     Set the insertableColumns property.
public  voidsetPrintStatements(boolean printStatements)
     Sets the printStatements property. If this property is true, SQL Insert, UPDATE and DELETE statements will be written to System.out.
public  voidsetSchemaName(String schemaName)
     Sets the identifier for schema of the table referred to in the tableName property.
public  voidsetUpdatableColumns(boolean[] updatableColumns)
     Set the updatableColumns property.
public  voidsetUpdatableColumns(int index, boolean updatableColumn)
     Set the updatableColumns property.



Method Detail
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)(Code)
Add a PropertyChangeListener to the listener list. The listener is registered for all bound properties.
Parameters:
  listener - The PropertyChangeListener to be added



addPropertyChangeListener
public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)(Code)
Add a PropertyChangeListener for a specific property. The listener will be invoked only on a change of the specific property.
Parameters:
  propertyName - The name of the property to listen on.
Parameters:
  listener - The PropertyChangeListener to be added



getCatalogName
public String getCatalogName()(Code)
Returns the catalog in which the table referred to by the tableName property resides.

a String object giving the name of the catalog that containsthe table referred to by tableName

Note: This method is called by com.sun.sql.rowset.internal.CachedRowSetXWriter.


See Also:   javax.sql.RowSetMetaData.getCatalogName



getColumnCatalogNames
public String[] getColumnCatalogNames()(Code)
Returns an array of String . If setColumnCatalogNames was never called, null is returned, else the value set when calling setColumnCatalogNames{/code> is returned. See setColumnCatalogNames for details.

Note, the column is zero based whereas most jdbc calls are one based.

Note: This method is called by com.sun.sql.rowset.internal.CachedRowSetXWriter .

an array of String objects or null




getColumnCatalogNames
public String getColumnCatalogNames(int index)(Code)
Returns a String which contains the catalog name set for the column or null.

Note, the column is zero based whereas most jdbc calls are one based.

a String object or null
throws:
  NullPointerException - if columnCatalogNames was never set.
throws:
  ArrayIndexOutOfBoundsException - if index is >=columnCatalogName.length




getColumnNames
public String[] getColumnNames()(Code)
Returns an array of String . If setColumnNames was never called, null is returned, else the value set when calling setColumnNames{/code> is returned. See setColumnNames for details.

Note, the column is zero based whereas most jdbc calls are one based.

Note: This method is called by com.sun.sql.rowset.internal.CachedRowSetXWriter .

an array of String objects or null




getColumnNames
public String getColumnNames(int index)(Code)
Returns a String which contains the column name set for the column or null.

Note, the column is zero based whereas most jdbc calls are one based.

a String object or null
throws:
  NullPointerException - if columnNames was never set.
throws:
  ArrayIndexOutOfBoundsException - if index is >=columnName.length




getColumnSchemaNames
public String[] getColumnSchemaNames()(Code)
Returns an array of String . If setColumnSchemaNames was never called, null is returned, else the value set when calling setColumnSchemaNames{/code> is returned. See setColumnSchemaNames for details.

Note, the column is zero based whereas most jdbc calls are one based.

Note: This method is called by com.sun.sql.rowset.internal.CachedRowSetXWriter .

an array of String objects or null




getColumnSchemaNames
public String getColumnSchemaNames(int index)(Code)
Returns a String which contains the schema name set for the column or null.

Note, the column is zero based whereas most jdbc calls are one based.

a String object or null
throws:
  NullPointerException - if columnSchemaNames was never set.
throws:
  ArrayIndexOutOfBoundsException - if index is >=columnSchemaName.length




getColumnTableNames
public String[] getColumnTableNames()(Code)
Returns an array of String . If setColumnTableNames was never called, null is returned, else the value set when calling setColumnTableNames{/code> is returned. See setColumnTableNames for details.

Note, the column is zero based whereas most jdbc calls are one based.

Note: This method is called by com.sun.sql.rowset.internal.CachedRowSetXWriter .

an array of String objects or null




getColumnTableNames
public String getColumnTableNames(int index)(Code)
Returns a String which contains the table name set for the column or null.

Note, the column is zero based whereas most jdbc calls are one based.

a String object or null
throws:
  NullPointerException - if columnTableNames was never set.
throws:
  ArrayIndexOutOfBoundsException - if index is >=columnTableName.length




getInsertableColumns
public boolean[] getInsertableColumns()(Code)
Returns an array of boolean{/code>. If setInsertableColumns was never called, null is returned, else the value set when calling setInsertableColumns{/code> is returned. See setInsertableColumns for details.

Note, the column is zero based whereas most jdbc calls are one based.

Note: This method is called by com.sun.sql.rowset.internal.CachedRowSetXWriter .

an array of boolean{/code> objects or null




getInsertableColumns
public boolean getInsertableColumns(int index)(Code)
Returns a boolean{/code> of true if the column should be inserted when when adding rows or null.

Note, the column is zero based whereas most jdbc calls are one based.

a boolean/code> object or null
throws:
  NullPointerException - if insertableColumns was never set.
throws:
  ArrayIndexOutOfBoundsException - if index is >=insertableColumns.length




getPrintStatements
public boolean getPrintStatements()(Code)
Returns the printStatements property. a boolean{/code> object which, if true, causes SQL statements to be written toSystem.out.

Note: This method is called by com.sun.sql.rowset.internal.CachedRowSetXWriter.




getSchemaName
public String getSchemaName()(Code)
Returns the schema in which the table referred to by the tableName property resides.

a String object giving the name of the catalog that containsthe table referred to by tableName

Note: This method is called by com.sun.sql.rowset.internal.CachedRowSetXWriter.


See Also:   javax.sql.RowSetMetaData.getCatalogName



getUpdatableColumns
public boolean[] getUpdatableColumns()(Code)
Returns an array of boolean{/code>. If setUpdatableColumns was never called, null is returned, else the value set when calling setUpdatebleColumns{/code> is returned. See setUpdatableColumns for details.

Note, the column is zero based whereas most jdbc calls are one based.

Note: This method is called by com.sun.sql.rowset.internal.CachedRowSetXWriter .

an array of boolean{/code> objects or null




getUpdatableColumns
public boolean getUpdatableColumns(int index)(Code)
Returns a boolean{/code> of true if the column should be updated when when updating rows or null.

Note, the column is zero based whereas most jdbc calls are one based.

a boolean{/code> object or null
throws:
  NullPointerException - if updatableColumns was never set.
throws:
  ArrayIndexOutOfBoundsException - if index is >=updatableColumns.length




isExecuted
public boolean isExecuted() throws SQLException(Code)
Returns true if this rowset is in an executed state a boolean true if the com.sun.sql.rowset.CachedRowSetXis in a state where navigation and getters and setters can be called on rowsreturned from the database (i.e., returns true if execute()or populate has been called.
exception:
  SQLException - if a database access error occurs



removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)(Code)
Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all bound properties.
Parameters:
  listener - The PropertyChangeListener to be removed



removePropertyChangeListener
public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)(Code)
Remove a PropertyChangeListener for a specific property.
Parameters:
  propertyName - The name of the property that was listened on.
Parameters:
  listener - The PropertyChangeListener to be removed



setCatalogName
public void setCatalogName(String catalogName)(Code)
Sets the identifier for catalog of the table referred to in the tableName property. The writer uses this name to determine which table to use when comparing the values in the data source with the com.sun.sql.rowset.CachedRowSetX object's values during a synchronization attempt. The catalogName property also indicates where modified values from this com.sun.sql.rowset.CachedRowSetX object should be written.

The implementation of this com.sun.sql.rowset.CachedRowSetX object may obtain the the name internally from the com.sun.sql.rowset.RowSetMetaDataXImpl object.

Note: This method is called by com.sun.sql.rowset.internal.CachedRowSetXWriter .


Parameters:
  catalogName - a String object identifying the catalog of the tablefrom which this com.sun.sql.rowset.CachedRowSetX object was derived; can benull or an empty String
See Also:   javax.sql.RowSetMetaData.setCatalogName
See Also:   javax.sql.RowSetWriter



setColumnCatalogNames
public void setColumnCatalogNames(String[] columnCatalogNames)(Code)
Set the columnCatalogNames property.
Parameters:
  columnCatalogNames - an array of String, one for each column, which containsthe name of catalog of the corresponding column (each element can also benull

Note, the column is zero based whereas most jdbc calls are one based.




setColumnCatalogNames
public void setColumnCatalogNames(int index, String columnCatalogName)(Code)
Set the columnCatalogNames property.
Parameters:
  index - the index of the array to set (zero based)
Parameters:
  columnCatalogName - the name of catalog for the column (can also be null
throws:
  NullPointerException - if columnCatalogNames was never set.
throws:
  ArrayIndexOutOfBoundsException - if index is >=columnCatalogName.length

Note, the column is zero based whereas most jdbc calls are one based.




setColumnNames
public void setColumnNames(String[] columnNames)(Code)
Set the columnNames property.
Parameters:
  columnNames - an array of String, one for each column, which containsthe name of column (each element can also be null

Note, the column is zero based whereas most jdbc calls are one based.




setColumnNames
public void setColumnNames(int index, String columnName)(Code)
Set the columnNames property.
Parameters:
  index - the index of the array to set (zero based)
Parameters:
  columnName - for the column (can also be null
throws:
  NullPointerException - if columnNames was never set.
throws:
  ArrayIndexOutOfBoundsException - if index is >=columnName.length

Note, the column is zero based whereas most jdbc calls are one based.




setColumnSchemaNames
public void setColumnSchemaNames(String[] columnSchemaNames)(Code)
Set the columnSchemaNames property.
Parameters:
  columnSchemaNames - an array of String, one for each column, which containsthe name of schema of the corresponding column (each element can also benull

Note, the column is zero based whereas most jdbc calls are one based.




setColumnSchemaNames
public void setColumnSchemaNames(int index, String columnSchemaName)(Code)
Set the columnSchemaNames property.
Parameters:
  index - the index of the array to set (zero based)
Parameters:
  columnSchemaName - the name of schema for the column (can also be null
throws:
  NullPointerException - if columnSchemaNames was never set.
throws:
  ArrayIndexOutOfBoundsException - if index is >=columnSchemaName.length

Note, the column is zero based whereas most jdbc calls are one based.




setColumnTableNames
public void setColumnTableNames(String[] columnTableNames)(Code)
Set the columnTableNames property.
Parameters:
  columnTableNames - an array of String, one for each column, which containsthe name of table of the corresponding column (each element can also benull

Note, the column is zero based whereas most jdbc calls are one based.




setColumnTableNames
public void setColumnTableNames(int index, String columnTableName)(Code)
Set the columnTableNames property.
Parameters:
  index - the index of the array to set (zero based)
Parameters:
  columnTableName - the name of table for the column (can also be null
throws:
  NullPointerException - if columnTableNames was never set.
throws:
  ArrayIndexOutOfBoundsException - if index is >=columnTableName.length

Note, the column is zero based whereas most jdbc calls are one based.




setInsertableColumns
public void setInsertableColumns(boolean[] insertableColumns)(Code)
Set the insertableColumns property.
Parameters:
  insertableColumns - an array of boolean one for each column, which containsa boolean indicating whether or not the column should be inserted when addingrows to the com.sun.sql.rowset.CachedRowSetX

Note, the column is zero based whereas most jdbc calls are one based.




setInsertableColumns
public void setInsertableColumns(int index, boolean insertableColumn)(Code)
Set the insertableColumns property.
Parameters:
  index - the index of the array to set (zero based)
Parameters:
  insertableColumn - true if column should be inserted for new rows
throws:
  NullPointerException - if insertableColumns was never set.
throws:
  ArrayIndexOutOfBoundsException - if index is >=insertableColumns.length

Note, the column is zero based whereas most jdbc calls are one based.




setPrintStatements
public void setPrintStatements(boolean printStatements)(Code)
Sets the printStatements property. If this property is true, SQL Insert, UPDATE and DELETE statements will be written to System.out. This property is intended to be set when debugging problems inserting, updating and deleting. With the information gained from examining the output, it is intended that one can set the other advanced properties on the com.sun.sql.rowset.CachedRowSetX to "fix" the SQL statements being generated. In this way, some JDBC driver problems can be overcome.


Parameters:
  printStatements - a boolean{/code> object which determines whetherSQL Insert, UPDATE and DELETE statements arewritten to System.out



setSchemaName
public void setSchemaName(String schemaName)(Code)
Sets the identifier for schema of the table referred to in the tableName property. The writer uses this name to determine which table to use when comparing the values in the data source with the com.sun.sql.rowset.CachedRowSetX object's values during a synchronization attempt. The schemaName property also indicates where modified values from this com.sun.sql.rowset.CachedRowSetX object should be written.

The implementation of this com.sun.sql.rowset.CachedRowSetX object may obtain the the name internally from the com.sun.sql.rowset.RowSetMetaDataXImpl object.
Parameters:
  schemaName - a String object identifying the schema of the tablefrom which this com.sun.sql.rowset.CachedRowSetX object was derived; can benull or an empty String
See Also:   javax.sql.RowSetMetaData.setSchemaName
See Also:   javax.sql.RowSetWriter




setUpdatableColumns
public void setUpdatableColumns(boolean[] updatableColumns)(Code)
Set the updatableColumns property.
Parameters:
  updatableColumns - an array of boolean, one for each column, which containsa boolean indicating whether or not the column should be updated when updatingrows to the com.sun.sql.rowset.CachedRowSetX

Note, the column is zero based whereas most jdbc calls are one based.




setUpdatableColumns
public void setUpdatableColumns(int index, boolean updatableColumn)(Code)
Set the updatableColumns property.
Parameters:
  index - the index of the array to set (zero based)
Parameters:
  updatableColumn - true if column should be updated when rows are updated
throws:
  NullPointerException - if updatableColumns was never set.
throws:
  ArrayIndexOutOfBoundsException - if index is >=updatableColumns.length

Note, the column is zero based whereas most jdbc calls are one based.




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