Java Doc for DataStoreInterface.java in  » J2EE » Sofia » com » salmonllc » 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
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 » J2EE » Sofia » com.salmonllc.sql 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


com.salmonllc.sql.DataStoreInterface

All known Subclasses:   com.salmonllc.sql.DataStoreProxy,  com.salmonllc.sql.DataStore,
DataStoreInterface
public interface DataStoreInterface extends DataStoreQBEInterface(Code)
This interface is implemented by both the DataStore and DataStoreProxy and is useful for components that need to retrieve data but need to user the DataStore and DataStoreProxy interchangably




Method Summary
public  voidaddBucket(String internalname, int type)
     This method adds a bucket to the DataStoreBuffer.
public  booleanallDataRetrieved()
     This method indicates whether all the data in the result set that is to be returned by the last retrieve statement has in fact been retrieved.
public  voidcancelRetrieve()
     This method was created in VisualAge.
public  intcompareRows(int row1, int row2, int[] cols)
     This method will compare the contents of two rows using the specified column list.
public  intcompareRows(int row1, int row2, String[] cols)
     This method will compare the contents of two rows using the specified column list.
public  booleandeleteRow()
     This deletes the current row in the DataStoreBuffer.
public  booleandeleteRow(int row)
     This deletes the row in the DataStoreBuffer.
public  voiddestroy()
     This method will destroy the remote data store on the data server.
public  intestimateRowsRetrieved()
     Use this method to get the amount of rows that will be retrieved when a data store retrieve is executed.
public  intestimateRowsRetrieved(String criteria)
     Use this method to get the amount of rows that will be retrieved when a data store retrieve is executed.
public  voidexport(int format, boolean includeHeaders, java.io.PrintWriter p)
     Exports the rows of the data store in the format specified. format: Can be EXPORT_XML, EXPORT_HTML or EXPORT_TAB_DELIMITED; includeHeaders: True if the output should contain column headings.
public  voidfilter(String filter)
     This method will remove all rows from the buffer that don't match the criteria and place them in the datastore's filter buffer. The method is passed a String containing the filter expression that will be used.
public  intfind(int start, int end)
     This method finds the next row in the result set that matches the criteria entered and is within the start and end range.
public  booleanfindFirst()
     This method finds the firs row in the result set that matches the criteria entered and makes it the current row.
public  booleanfindLast()
     This method finds the last row in the result set that matches the criteria entered and makes it the current row.
public  booleanfindNext()
     This method finds the next row in the result set that matches the criteria entered and makes it the current row.
public  booleanfindPrior()
     This method finds the next row in the result set that matches the criteria entered and makes it the current row.
public  ObjectgetAny(int column)
     This method return a Object value from the current row of the data store buffer.
public  ObjectgetAny(int row, int column)
     This method return a Object value from the data store buffer.
public  ObjectgetAny(int row, String column)
     This method return a Object value from the data store buffer.
public  ObjectgetAny(String column)
     This method return a Object value from the current row of the data store buffer.
public  byte[]getByteArray(int column)
     This method return a byte array value from the current row in the data store buffer.
public  byte[]getByteArray(int row, int column)
     This method return a byte array value from the data store buffer.
public  byte[]getByteArray(int row, String column)
     This method return a byte array value from the data store buffer.
public  byte[]getByteArray(String column)
     This method return a byte array value from the current row in the data store buffer.
public  booleangetCheckConcurrency()
     Use this method to get whether or not the datastore will do a concurrency check when rows are updated and deleted.
public  intgetColumnCount()
     This method returns the number of columns in the datastore.
public  intgetColumnDataType(int column)
     This method returns the Data Type for a particular column.
public  intgetColumnDataType(String column)
     This method returns the Data Type for a particular column.
public  String[]getColumnList()
     This method returns a list with the names of all the columns in the data store.
public  StringgetColumnName(int col)
     This method returns the name of the column in the data store given its index.
public  booleangetConcurrencyCheckColumn(int col)
     This method is used to get whether a column should be used in the update, delete concurrency check.
public  booleangetConcurrencyCheckColumn(String col)
     This method is used to get whether a column should be used in the update, delete concurrency check.
public  StringgetCriteria()
     This method is used to get selection criteria filtering for the result set of the datastore.
public  DataStoreRowgetDataStoreRow(int rowNo, int buffer)
     This method gets the specified row from the DataStore.
Parameters:
  rowNo - The number of the row to get.
Parameters:
  buffer - The datastore buffer to look in.
public  java.sql.DategetDate(int column)
     This method return a date value from current row of the data store buffer.
public  java.sql.DategetDate(int row, int column)
     This method return a date value from the data store buffer.
public  java.sql.DategetDate(int row, String column)
     This method return a date value from the data store buffer.
public  java.sql.DategetDate(String column)
     This method return a date value from current row of the data store buffer.
public  TimestampgetDateTime(int column)
     This method return a date value from current row of the data store buffer.
public  TimestampgetDateTime(int row, int column)
     This method return a date value from the data store buffer.
public  TimestampgetDateTime(int row, String column)
     This method return a date value from the data store buffer.
public  java.sql.TimestampgetDateTime(String column)
     This method return a datetime value from current row of the data store buffer.
public  StringgetDefaultTable()
    
public  intgetDeletedCount()
     This method returns the current number of rows that will be deleted when the datastores update method is called.
public  booleangetDistinct()
     This method will return whether the distinct flag in the data store is set.
public  doublegetDouble(int column)
     This method return a double value from the current row in data store buffer.
public  doublegetDouble(int row, int column)
     This method return a double value from the data store buffer.
public  doublegetDouble(int row, String column)
     This method return a double value from the data store buffer.
public  doublegetDouble(String column)
     This method return a double value from the current row in data store buffer.
public  intgetFilteredCount()
     This method returns the current number of rows in the DataStores filter buffer.
public  floatgetFloat(int column)
     This method return a float value from the current row in the data store buffer.
public  floatgetFloat(int row, int column)
     This method return a float value from the data store buffer.
public  floatgetFloat(int row, String column)
     This method return a float value from the data store buffer.
public  floatgetFloat(String column)
     This method return a float value from the current row in the data store buffer.
public  StringgetFormat(int col)
     This method returns a the format string for a date, time, datetime or numeric type column.
public  StringgetFormat(String col)
     This method returns a the format string for a date, time, datetime or numeric type column.
public  StringgetFormattedString(int column)
     This method return a string value from the data store buffer.
public  StringgetFormattedString(int row, int column)
     This method return a string value from the data store buffer.
public  StringgetFormattedString(int row, String column)
     This method return a string value from the data store buffer.
public  StringgetFormattedString(String column)
     This method return a string value from the data store buffer.
public  StringgetGroupBy()
     This method returns the column list in the group by clause.
public  StringgetHaving()
     This method returns the having clause for the datastore.
public  intgetInt(int column)
     This method return a integer value from the current row in the data store buffer.
public  intgetInt(int row, int column)
     This method return a integer value from the data store buffer.
public  intgetInt(int row, String column)
     This method return a integer value from the data store buffer.
public  intgetInt(String column)
     This method return a integer value from the current row in data store buffer.
public  intgetJoinColumnCount(int joinNo)
     This method returns the number of columns in a particular join.
public  intgetJoinCount()
     This method returns the number of joins in the datastore.
public  StringgetJoinLeftColumn(int joinNo, int colNo)
     This method returns a column on the left side of the join.
public  booleangetJoinOuter(int joinNo)
     This method returns the true if a particular join is outer.
public  intgetJoinRelationType(int joinNo)
     This method returns the relation type of the join.
public  StringgetJoinRightColumn(int joinNo, int colNo)
     This method returns a column on the right side of the join.
public  longgetLong(int column)
     This method return a long value from the current row in the data store buffer.
public  longgetLong(int row, int column)
     This method return a long value from the data store buffer.
public  longgetLong(int row, String column)
     This method return a long value from the data store buffer.
public  longgetLong(String column)
     This method return a long value from the data store buffer.
public  intgetMaxRows()
     This method will return the maximum number of rows that the datastore will retrieve.
public  StringgetOrderBy()
     This method returns the order by clause for the datastore.
public  PropertiesgetProperties()
     This method creates a properties object containing the definition of the data store.
public  StringgetRemoteID()
    
public  intgetRow()
     This method returns the current row in the result set.
public  intgetRowCount()
     This method returns the current number of rows in the DataStores data buffer.
public  intgetRowStatus()
     This method returns the status flag of the current row.
public  intgetRowStatus(int row)
     This method returns the status flag of the specified row.
Parameters:
  row - The row in the datastore buffer.
public  shortgetShort(int column)
     This method return a short value from the current row in the data store buffer.
public  shortgetShort(int row, int column)
     This method return a short value from the data store buffer.
public  shortgetShort(int row, String column)
     This method return a short value from the data store buffer.
public  shortgetShort(String column)
     This method return a short value from the current row in the data store buffer.
public  StringgetString(int column)
     This method return a string value from the data store buffer.
public  StringgetString(int row, int column)
     This method return a string value from the data store buffer.
public  StringgetString(int row, String column)
     This method return a String value from the data store buffer.
public  StringgetString(String column)
     This method return a string value from the data store buffer.
public  String[]getTableList(boolean updateable)
     This method returns an array of all the tables referenced in the datastore.
public  java.sql.TimegetTime(int column)
     This method return a time value from current row of the data store buffer.
public  java.sql.TimegetTime(int row, int column)
     This method return a time value from the data store buffer.
public  java.sql.TimegetTime(int row, String column)
     This method return a time value from the data store buffer.
public  java.sql.TimegetTime(String column)
     This method return a time value from current row of the data store buffer.
public  booleangetTrimStrings()
    
public  intgetUpdateMethod()
     Gets the update method for the datastore.
public  intgetUseBindColumn(int col)
     This method is used to get whether a column should use bind variables for inserts and updates.
public  intgetUseBindColumn(String col)
     This method is used to get whether a column should use bind variables for inserts and updates.
public  booleangetUseBindForUpdate()
     Use this method to get whether or not the datastore will use bind variables as the default for updating or inserting columns.
public  booleangotoFirst()
     This method makes the current row the first one in the result set.
public  booleangotoLast()
     This method makes the current row the last one in the result set.
public  booleangotoNext()
     This method increments the current row in the result set.
public  booleangotoPrior()
     This method decrements the current row in the result set.
public  booleangotoRow(int row)
     This method makes a specific row the current one in the result set.
public  intinsertRow()
     Inserts a blank row at the end of the DataStoreBuffer.
public  intinsertRow(int atPosition)
      * Inserts a blank row at the specified position of the DataStore's result set buffer.
public  booleanisFormattedStringValid(int column, String value)
     This method will return true if the passed string value if a valid entry for the column based on the String format specified for the column via the setFormat method.
public  booleanisFormattedStringValid(String column, String value)
     This method will return true if the passed string value if a valid entry for the column based on the String format specified for the column via the setFormat method.
public  booleanisPrimaryKey(int col)
    
public  booleanisPrimaryKey(String col)
    
public  booleanisUpdateable(int col)
    
public  booleanisUpdateable(String col)
    
public  booleanping()
     This method will ping the server for this particular data store.
public  booleanremoveRow()
     This removes the current row from the DataStore buffer.
public  booleanremoveRow(int row)
     This removes the row from the DataStore buffer.
public  voidreset()
     This method will clear all rows in the dataStore.
public  voidresetStatus()
     This method will clear the row status flags and clear the deleted buffer in the DataStoreBuffer.
public  voidretrieve()
     Executes the sql statement and retrieves to data.
public  voidsetAny(int row, int column, Object value)
     This method sets a value in the data store's internal buffer.
public  voidsetAny(int column, Object value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetAny(int row, String column, Object value)
     This method sets a value in the data store's internal buffer.
public  voidsetAny(String column, Object value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetByteArray(int column, byte[] value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetByteArray(int row, int column, byte[] value)
     This method sets a value in the data store's internal buffer.
public  voidsetByteArray(int row, String column, byte[] value)
     This method sets a value in the data store's internal buffer.
public  voidsetByteArray(String column, byte[] value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetDataStoreRow(int rowNo, int buffer, DataStoreRow row)
     This method sets the specified row in the DataStore.
public  voidsetDate(int row, int column, java.sql.Date value)
     This method sets a value in the data store's internal buffer.
public  voidsetDate(int row, String column, java.sql.Date value)
     This method sets a value in the data store's internal buffer.
public  voidsetDate(int column, java.sql.Date value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetDate(String column, java.sql.Date value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetDateTime(int row, int column, java.sql.Timestamp value)
     This method sets a value in the data store's internal buffer.
public  voidsetDateTime(int row, String column, java.sql.Timestamp value)
     This method sets a value in the data store's internal buffer.
public  voidsetDateTime(int column, java.sql.Timestamp value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetDateTime(String column, java.sql.Timestamp value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetDistinct(boolean distinct)
     This method will set the distinct flag in the data store.
public  voidsetDouble(int column, double value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetDouble(int row, int column, double value)
     This method sets a value in the data store's internal buffer.
public  voidsetDouble(int row, String column, double value)
     This method sets a value in the data store's internal buffer.
public  voidsetDouble(String column, double value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetFindExpression(String exp)
     This method will set the expression used to find rows in the datastore.
public  voidsetFloat(int column, float value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetFloat(int row, int column, float value)
     This method sets a value in the data store's internal buffer.
public  voidsetFloat(int row, String column, float value)
     This method sets a value in the data store's internal buffer.
public  voidsetFloat(String column, float value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetFormat(int col, String format)
     This method sets a the format string for a date, time, datetime or numeric type column.
public  voidsetFormat(String col, String format)
     This method sets a the format string for a date, time, datetime or numeric type column.

Date Formats

Symbol Meaning Presentation Example
------ ------- ------------ -------
G era designator (Text) AD
y year (Number) 1996
M month in year (Text & Number) July & 07
d day in month (Number) 10
h hour in am/pm (1~12) (Number) 12
H hour in day (0~23) (Number) 0
m minute in hour (Number) 30
s second in minute (Number) 55
S millisecond (Number) 978
E day in week (Text) Tuesday
D day in year (Number) 189
F day of week in month (Number) 2 (2nd Wed in July)
w week in year (Number) 27
W week in month (Number) 2
a am/pm marker (Text) PM
k hour in day (1~24) (Number) 24
K hour in am/pm (0~11) (Number) 0
z time zone (Text) Pacific Standard Time
' escape for text (Delimiter)
'' single quote (Literal) '

Numeric Formats

Symbol Meaning
------ -------
0 a digit
# a digit, zero shows as absent
.
public  voidsetFormattedString(int row, int column, String value)
    
public  voidsetFormattedString(int column, String value)
    
public  voidsetFormattedString(int row, String column, String value)
    
public  voidsetFormattedString(String column, String value)
    
public  voidsetInt(int row, int column, int value)
     This method sets a value in the data store's internal buffer.
public  voidsetInt(int row, String column, int value)
     This method sets a value in the data store's internal buffer.
public  voidsetInt(String column, int value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetLong(int row, int column, long value)
     This method sets a value in the data store's internal buffer.
public  voidsetLong(int column, long value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetLong(int row, String column, long value)
     This method sets a value in the data store's internal buffer.
public  voidsetLong(String column, long value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetOrderBy(String orderBy)
    
public  voidsetPrimaryKey(int col, boolean pkey)
    
public  voidsetPrimaryKey(String col, boolean pkey)
    
public  voidsetProperties(Properties p)
     This method builds the datastore from the information in the properties object.
public  voidsetRemoteID(String remoteID)
    
public  booleansetRowStatus(int status)
     This method sets the status flag of the current row.
public  booleansetRowStatus(int row, int status)
     This method sets the status flag of the specified row.
public  voidsetShort(int row, int column, short value)
     This method sets a value in the data store's internal buffer.
public  voidsetShort(int row, String column, short value)
     This method sets a value in the data store's internal buffer.
public  voidsetShort(int column, short value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetShort(String column, short value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetString(int row, int column, String value)
     This method sets a value in the data store's internal buffer.
public  voidsetString(int column, String value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetString(int row, String column, String value)
     This method sets a value in the data store's internal buffer.
public  voidsetString(String column, String value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetTime(int row, int column, java.sql.Time value)
     This method sets a value in the data store's internal buffer.
public  voidsetTime(int row, String column, java.sql.Time value)
     This method sets a value in the data store's internal buffer.
public  voidsetTime(int column, java.sql.Time value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsetTime(String column, java.sql.Time value)
     This method sets a value in the data store's internal buffer at the current row.
public  voidsort(int[] col, int dir)
     This method will sort the rows in the data store on an array of columns. col[] A array of column numbers to sort on.
public  voidsort(Object[] obj, int dir)
     This method will sort the rows in the data store on an array of columns. obj[] A array of objects to sort on.
public  voidsort(String col, int dir)
     This method will sort the rows in the data store on an array of columns. col[] A String array of column names to sort on.
public  voidsort(int col, int dir)
     This method will sort the rows in the data store on a particular column.
Parameters:
  col - The column number of the column to sort on.
Parameters:
  dir - The direction to sort on.
public  voidsort(DataStoreEvaluator eval, int dir)
     This method will sort the rows in the data store using an expression.
public  voidsort(String col, int dir)
     This method will sort the rows in the data store on a particular column.
Parameters:
  col - The name of the column to sort on.
Parameters:
  dir - The direction to sort on.
public  intunDeleteRow(int row)
     This method will take a row from the datastores deleted buffer and move it back to the standard buffer.
Parameters:
  row - The number of the row to undelete.
public  voidupdate()
     This method will cause the database to reflect the changes made in the data store's buffer.
public  voidwaitForCancel()
    
public  voidwaitForRetrieve()
     This method will block until all the data from the last retrieve method call has been loaded into the DataStore's internal buffer.



Method Detail
addBucket
public void addBucket(String internalname, int type)(Code)
This method adds a bucket to the DataStoreBuffer. The bucket will be filled in with nulls when the datastore is retrieved.
Parameters:
  internalname - The name of the bucket to add to the datastore.
Parameters:
  type - The type of the column to add to the datastore. This must be one of the "TYPE" constants in the class.


allDataRetrieved
public boolean allDataRetrieved()(Code)
This method indicates whether all the data in the result set that is to be returned by the last retrieve statement has in fact been retrieved. true if all the data has been retrieved and false if the retrieve is still in progress.


cancelRetrieve
public void cancelRetrieve()(Code)
This method was created in VisualAge.


compareRows
public int compareRows(int row1, int row2, int[] cols)(Code)
This method will compare the contents of two rows using the specified column list. It will return < 0 if row1 is less then row2, 0 if they are equal and > 0 if row1 is greater than row2
Parameters:
  row1 - the first row to check
Parameters:
  row2 - the next row to check
Parameters:
  cols - An array of column numbers to use for the comparison


compareRows
public int compareRows(int row1, int row2, String[] cols)(Code)
This method will compare the contents of two rows using the specified column list. It will return < 0 if row1 is less then row2, 0 if they are equal and > 0 if row1 is greater than row2
Parameters:
  row1 - the first row to check
Parameters:
  row2 - the next row to check
Parameters:
  cols - An array of column names to use for the comparison


deleteRow
public boolean deleteRow()(Code)
This deletes the current row in the DataStoreBuffer. This will generate a delete statment that will remove the row from the database when the update method is called. true if the row is deleted and false if not.


deleteRow
public boolean deleteRow(int row)(Code)
This deletes the row in the DataStoreBuffer. This will generate a delete statment that will remove the row from the database when the update method is called.
Parameters:
  row - The number of the row to delete. True if the row is deleted and false if not.


destroy
public void destroy() throws Exception(Code)
This method will destroy the remote data store on the data server. All resources on the server will be reclaimed.


estimateRowsRetrieved
public int estimateRowsRetrieved() throws Exception(Code)
Use this method to get the amount of rows that will be retrieved when a data store retrieve is executed.


estimateRowsRetrieved
public int estimateRowsRetrieved(String criteria) throws Exception(Code)
Use this method to get the amount of rows that will be retrieved when a data store retrieve is executed.
Parameters:
  criteria - The selection criteria to use for the select.


export
public void export(int format, boolean includeHeaders, java.io.PrintWriter p)(Code)
Exports the rows of the data store in the format specified. format: Can be EXPORT_XML, EXPORT_HTML or EXPORT_TAB_DELIMITED; includeHeaders: True if the output should contain column headings. p: The PrintWriter to send the output to.


filter
public void filter(String filter) throws DataStoreException(Code)
This method will remove all rows from the buffer that don't match the criteria and place them in the datastore's filter buffer. The method is passed a String containing the filter expression that will be used. Examples:
 ds.filter("table1.column1 == 'xxxx'); 

 ds.filter("table1.column1.substring(2,3) == table1.column2");

 ds.filter("table1.column1.substring(2,3) == table1.column2 || table1.column3.startsWith('xxx')");

Parameters:
  filter - The criteria to filter on. Enter a value of null to clear the filter.
See Also:   DataStoreEvaluator


find
public int find(int start, int end) throws DataStoreException(Code)
This method finds the next row in the result set that matches the criteria entered and is within the start and end range. Returns the first row matching the criteria within the range or -1 if none are found.
See Also:   DataStore.setFindExpression


findFirst
public boolean findFirst() throws DataStoreException(Code)
This method finds the firs row in the result set that matches the criteria entered and makes it the current row. Returns false if no rows are found that match the criteria.
See Also:   DataStoreBuffer.setFindExpression


findLast
public boolean findLast() throws DataStoreException(Code)
This method finds the last row in the result set that matches the criteria entered and makes it the current row. Returns false if no rows are found that match the criteria.
See Also:   DataStoreBuffer.setFindExpression


findNext
public boolean findNext() throws DataStoreException(Code)
This method finds the next row in the result set that matches the criteria entered and makes it the current row. Returns false if no rows are found that match the criteria.
See Also:   DataStoreBuffer.setFindExpression


findPrior
public boolean findPrior() throws DataStoreException(Code)
This method finds the next row in the result set that matches the criteria entered and makes it the current row. Returns false if no rows are found that match the criteria.
See Also:   DataStoreBuffer.setFindExpression


getAny
public Object getAny(int column) throws DataStoreException(Code)
This method return a Object value from the current row of the data store buffer. The Object value
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column number in the data store buffer.


getAny
public Object getAny(int row, int column) throws DataStoreException(Code)
This method return a Object value from the data store buffer. The Object value
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column number in the data store buffer.


getAny
public Object getAny(int row, String column) throws DataStoreException(Code)
This method return a Object value from the data store buffer. The Object value
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column name (in the form table.column) in the data store buffer.


getAny
public Object getAny(String column) throws DataStoreException(Code)
This method return a Object value from the current row of the data store buffer. The Object value
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column name in the data store buffer.


getByteArray
public byte[] getByteArray(int column) throws DataStoreException(Code)
This method return a byte array value from the current row in the data store buffer. The byte array
Parameters:
  column - The column number in the data store buffer.


getByteArray
public byte[] getByteArray(int row, int column) throws DataStoreException(Code)
This method return a byte array value from the data store buffer. The byte array
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column number in the data store buffer.


getByteArray
public byte[] getByteArray(int row, String column) throws DataStoreException(Code)
This method return a byte array value from the data store buffer. The byte array
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column name (in the form table.column) in the data store buffer.


getByteArray
public byte[] getByteArray(String column) throws DataStoreException(Code)
This method return a byte array value from the current row in the data store buffer. The byte array
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column name (in the form table.column) in the data store buffer.


getCheckConcurrency
public boolean getCheckConcurrency()(Code)
Use this method to get whether or not the datastore will do a concurrency check when rows are updated and deleted.


getColumnCount
public int getColumnCount()(Code)
This method returns the number of columns in the datastore.


getColumnDataType
public int getColumnDataType(int column) throws DataStoreException(Code)
This method returns the Data Type for a particular column.
Parameters:
  column - The column number in the data store buffer.


getColumnDataType
public int getColumnDataType(String column) throws DataStoreException(Code)
This method returns the Data Type for a particular column.
Parameters:
  column - The column name in the data store buffer.


getColumnList
public String[] getColumnList()(Code)
This method returns a list with the names of all the columns in the data store.


getColumnName
public String getColumnName(int col) throws DataStoreException(Code)
This method returns the name of the column in the data store given its index.


getConcurrencyCheckColumn
public boolean getConcurrencyCheckColumn(int col) throws DataStoreException(Code)
This method is used to get whether a column should be used in the update, delete concurrency check.


getConcurrencyCheckColumn
public boolean getConcurrencyCheckColumn(String col) throws DataStoreException(Code)
This method is used to get whether a column should be used in the update, delete concurrency check.


getCriteria
public String getCriteria()(Code)
This method is used to get selection criteria filtering for the result set of the datastore.


getDataStoreRow
public DataStoreRow getDataStoreRow(int rowNo, int buffer) throws DataStoreException(Code)
This method gets the specified row from the DataStore.
Parameters:
  rowNo - The number of the row to get.
Parameters:
  buffer - The datastore buffer to look in. Valid values are BUFFER_STANDARD, BUFFER_DELETED, BUFFER_FILTERED.


getDate
public java.sql.Date getDate(int column) throws DataStoreException(Code)
This method return a date value from current row of the data store buffer. The DateTime Value
Parameters:
  column - The column number in the data store buffer.


getDate
public java.sql.Date getDate(int row, int column) throws DataStoreException(Code)
This method return a date value from the data store buffer. The DateTime Value
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column number in the data store buffer.


getDate
public java.sql.Date getDate(int row, String column) throws DataStoreException(Code)
This method return a date value from the data store buffer. The DateTime Value
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column name in the data store buffer.


getDate
public java.sql.Date getDate(String column) throws DataStoreException(Code)
This method return a date value from current row of the data store buffer. The DateTime Value
Parameters:
  column - The column name in the data store buffer.


getDateTime
public Timestamp getDateTime(int column) throws DataStoreException(Code)
This method return a date value from current row of the data store buffer. The DateTime Value
Parameters:
  column - The column number in the data store buffer.


getDateTime
public Timestamp getDateTime(int row, int column) throws DataStoreException(Code)
This method return a date value from the data store buffer. The DateTime Value
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column number in the data store buffer.


getDateTime
public Timestamp getDateTime(int row, String column) throws DataStoreException(Code)
This method return a date value from the data store buffer. The DateTime Value
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column name in the data store buffer.


getDateTime
public java.sql.Timestamp getDateTime(String column) throws DataStoreException(Code)
This method return a datetime value from current row of the data store buffer. The DateTime Value
Parameters:
  column - The column name in the data store buffer.


getDefaultTable
public String getDefaultTable()(Code)
This method returns the default table for the datastore
Parameters:
  table - The default table for this DataStore


getDeletedCount
public int getDeletedCount()(Code)
This method returns the current number of rows that will be deleted when the datastores update method is called. int


getDistinct
public boolean getDistinct()(Code)
This method will return whether the distinct flag in the data store is set. The flag indicates that the distinct keyword should be placed at the beginning of a select statement.


getDouble
public double getDouble(int column) throws DataStoreException(Code)
This method return a double value from the current row in data store buffer. The double value.
Parameters:
  column - The column number in the in the data store buffer.


getDouble
public double getDouble(int row, int column) throws DataStoreException(Code)
This method return a double value from the data store buffer. The double value.
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column number in the in the data store buffer.


getDouble
public double getDouble(int row, String column) throws DataStoreException(Code)
This method return a double value from the data store buffer. The double value.
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column name in the form table.column in the data store buffer


getDouble
public double getDouble(String column) throws DataStoreException(Code)
This method return a double value from the current row in data store buffer. The double value.
Parameters:
  column - The column name in the form table.column in the data store buffer


getFilteredCount
public int getFilteredCount()(Code)
This method returns the current number of rows in the DataStores filter buffer. the number of rows in the filter buffer.


getFloat
public float getFloat(int column) throws DataStoreException(Code)
This method return a float value from the current row in the data store buffer. The long value.
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column number in the data store buffer.


getFloat
public float getFloat(int row, int column) throws DataStoreException(Code)
This method return a float value from the data store buffer. The long value.
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column number in the data store buffer.


getFloat
public float getFloat(int row, String column) throws DataStoreException(Code)
This method return a float value from the data store buffer. The long value.
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column name in the data store buffer.


getFloat
public float getFloat(String column) throws DataStoreException(Code)
This method return a float value from the current row in the data store buffer. The long value.
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column name in the data store buffer.


getFormat
public String getFormat(int col) throws DataStoreException(Code)
This method returns a the format string for a date, time, datetime or numeric type column.
Parameters:
  col - The column number to get the format for.
See Also:   DataStore.getFormattedString
See Also:   DataStore.setFormattedString


getFormat
public String getFormat(String col) throws DataStoreException(Code)
This method returns a the format string for a date, time, datetime or numeric type column.
Parameters:
  col - The column name to get the format for.
See Also:   DataStore.getFormattedString
See Also:   DataStore.setFormattedString


getFormattedString
public String getFormattedString(int column) throws DataStoreException(Code)
This method return a string value from the data store buffer. If the column is numeric, date, time or datetime it will first be formatted into a String based on the pattern specified in the setFormat method.


See Also:   DataStore.setFormat


getFormattedString
public String getFormattedString(int row, int column) throws DataStoreException(Code)
This method return a string value from the data store buffer. If the column is numeric, date, time or datetime it will first be formatted into a String based on the pattern specified in the setFormat method.


See Also:   DataStore.setFormat


getFormattedString
public String getFormattedString(int row, String column) throws DataStoreException(Code)
This method return a string value from the data store buffer. If the column is numeric, date, time or datetime it will first be formatted into a String based on the pattern specified in the setFormat method.


See Also:   DataStore.setFormat


getFormattedString
public String getFormattedString(String column) throws DataStoreException(Code)
This method return a string value from the data store buffer. If the column is numeric, date, time or datetime it will first be formatted into a String based on the pattern specified in the setFormat method.


See Also:   DataStore.setFormat


getGroupBy
public String getGroupBy()(Code)
This method returns the column list in the group by clause.


getHaving
public String getHaving()(Code)
This method returns the having clause for the datastore.


getInt
public int getInt(int column) throws DataStoreException(Code)
This method return a integer value from the current row in the data store buffer. The integer value.
Parameters:
  column - The column number in the data store buffer


getInt
public int getInt(int row, int column) throws DataStoreException(Code)
This method return a integer value from the data store buffer. The integer value.
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column number in the data store buffer


getInt
public int getInt(int row, String column) throws DataStoreException(Code)
This method return a integer value from the data store buffer. The integer value.
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column name in the form table.column in the data store buffer


getInt
public int getInt(String column) throws DataStoreException(Code)
This method return a integer value from the current row in data store buffer. The integer value.
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column name in the form table.column in the data store buffer


getJoinColumnCount
public int getJoinColumnCount(int joinNo)(Code)
This method returns the number of columns in a particular join.


getJoinCount
public int getJoinCount()(Code)
This method returns the number of joins in the datastore.


getJoinLeftColumn
public String getJoinLeftColumn(int joinNo, int colNo)(Code)
This method returns a column on the left side of the join.


getJoinOuter
public boolean getJoinOuter(int joinNo)(Code)
This method returns the true if a particular join is outer.


getJoinRelationType
public int getJoinRelationType(int joinNo)(Code)
This method returns the relation type of the join. (RELATION_ONE_TO_ONE, RELATION_ONE_TO_MANY, RELATION_MANY_TO_ONE)


getJoinRightColumn
public String getJoinRightColumn(int joinNo, int colNo)(Code)
This method returns a column on the right side of the join.


getLong
public long getLong(int column) throws DataStoreException(Code)
This method return a long value from the current row in the data store buffer. The long value.
Parameters:
  column - The column number in the data store buffer.


getLong
public long getLong(int row, int column) throws DataStoreException(Code)
This method return a long value from the data store buffer. The long value.
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column number in the data store buffer.


getLong
public long getLong(int row, String column) throws DataStoreException(Code)
This method return a long value from the data store buffer. The long value.
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column name in the data store buffer.


getLong
public long getLong(String column) throws DataStoreException(Code)
This method return a long value from the data store buffer. The long value.
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column name in the data store buffer.


getMaxRows
public int getMaxRows()(Code)
This method will return the maximum number of rows that the datastore will retrieve. If the max is set to -1, the datastore will retrieve all rows in the result set. Otherwise it will stop retrieving when the max is reached.


getOrderBy
public String getOrderBy()(Code)
This method returns the order by clause for the datastore.


getProperties
public Properties getProperties()(Code)
This method creates a properties object containing the definition of the data store.


getRemoteID
public String getRemoteID()(Code)
Used to get the remote id for the datastore


getRow
public int getRow()(Code)
This method returns the current row in the result set. The current row in the result set or -1 if the result set is empty.


getRowCount
public int getRowCount()(Code)
This method returns the current number of rows in the DataStores data buffer. If a retrieve is in progress this value will change as the rows are retrieved. the number of rows in the buffer.


getRowStatus
public int getRowStatus()(Code)
This method returns the status flag of the current row. -1 if the row is not in the buffer or the status if it is (Valid values: STATUS_NOT_MODIFIED, STATUS_MODIFIED, STATUS_NEW, STATUS_NEW_MODIFIED).


getRowStatus
public int getRowStatus(int row)(Code)
This method returns the status flag of the specified row.
Parameters:
  row - The row in the datastore buffer. -1 if the row is not in the buffer or the status if it is. (Valid values: STATUS_NOT_MODIFIED, STATUS_MODIFIED, STATUS_NEW, STATUS_NEW_MODIFIED).


getShort
public short getShort(int column) throws DataStoreException(Code)
This method return a short value from the current row in the data store buffer. The short value.
Parameters:
  column - The column number in the data store buffer.


getShort
public short getShort(int row, int column) throws DataStoreException(Code)
This method return a short value from the data store buffer. The short value.
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column number in the data store buffer.


getShort
public short getShort(int row, String column) throws DataStoreException(Code)
This method return a short value from the data store buffer. The short value.
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column name in the form table.column in the data store buffer


getShort
public short getShort(String column) throws DataStoreException(Code)
This method return a short value from the current row in the data store buffer. The short value.
Parameters:
  column - The column name in the form table.column in the data store buffer


getString
public String getString(int column) throws DataStoreException(Code)
This method return a string value from the data store buffer. The String Value
Parameters:
  row - The row number in the data store buffer
Parameters:
  column - The column number in the data store buffer


getString
public String getString(int row, int column) throws DataStoreException(Code)
This method return a string value from the data store buffer. The String Value
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column number in the data store buffer.


getString
public String getString(int row, String column) throws DataStoreException(Code)
This method return a String value from the data store buffer. The String value
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column name (in the form table.column) in the data store buffer.


getString
public String getString(String column) throws DataStoreException(Code)
This method return a string value from the data store buffer. The String Value
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column name (in the form table.column) in the data store buffer.


getTableList
public String[] getTableList(boolean updateable)(Code)
This method returns an array of all the tables referenced in the datastore.
Parameters:
  updateable - True if the table list should only include updateable tables and false if it should include all.


getTime
public java.sql.Time getTime(int column) throws DataStoreException(Code)
This method return a time value from current row of the data store buffer. The time Value
Parameters:
  column - The column number in the data store buffer.


getTime
public java.sql.Time getTime(int row, int column) throws DataStoreException(Code)
This method return a time value from the data store buffer. The time Value
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column number in the data store buffer.


getTime
public java.sql.Time getTime(int row, String column) throws DataStoreException(Code)
This method return a time value from the data store buffer. The Time Value
Parameters:
  row - The row number in the data store buffer.
Parameters:
  column - The column name in the data store buffer.


getTime
public java.sql.Time getTime(String column) throws DataStoreException(Code)
This method return a time value from current row of the data store buffer. The Time Value
Parameters:
  column - The column name in the data store buffer.


getTrimStrings
public boolean getTrimStrings()(Code)
Use this method to get whether the DataStore will trim (remove trailing spaces) from columns retrieved from the database;


getUpdateMethod
public int getUpdateMethod()(Code)
Gets the update method for the datastore.
See Also:   DataStore.setUpdateMethod


getUseBindColumn
public int getUseBindColumn(int col) throws DataStoreException(Code)
This method is used to get whether a column should use bind variables for inserts and updates. Valid values and BIND_TRUE, BIND_FALSE and BIND_DEFAULT (Use default for datastore)


getUseBindColumn
public int getUseBindColumn(String col) throws DataStoreException(Code)
This method is used to get whether a column should use bind variables for inserts and updates. Valid values and BIND_TRUE, BIND_FALSE and BIND_DEFAULT (Use default for datastore)


getUseBindForUpdate
public boolean getUseBindForUpdate()(Code)
Use this method to get whether or not the datastore will use bind variables as the default for updating or inserting columns.


gotoFirst
public boolean gotoFirst()(Code)
This method makes the current row the first one in the result set. Returns fals if the result set is empty.


gotoLast
public boolean gotoLast()(Code)
This method makes the current row the last one in the result set. Returns fals if the result set is empty.


gotoNext
public boolean gotoNext()(Code)
This method increments the current row in the result set. Returns false if the result set is empty or the current row is the last.


gotoPrior
public boolean gotoPrior()(Code)
This method decrements the current row in the result set. Returns false if the result set is empty or the current row is the first.


gotoRow
public boolean gotoRow(int row)(Code)
This method makes a specific row the current one in the result set. Returns false if the result set is empty or the row passed is beyond the bounds of the result set.
Parameters:
  row - The row in the result set to make current.


insertRow
public int insertRow()(Code)
Inserts a blank row at the end of the DataStoreBuffer. Returns the number of the row added.


insertRow
public int insertRow(int atPosition)(Code)
 * Inserts a blank row at the specified position of the DataStore's result set buffer. Returns the number of the row added.  


isFormattedStringValid
public boolean isFormattedStringValid(int column, String value) throws DataStoreException(Code)
This method will return true if the passed string value if a valid entry for the column based on the String format specified for the column via the setFormat method.
See Also:   DataStoreBuffer.setFormat


isFormattedStringValid
public boolean isFormattedStringValid(String column, String value) throws DataStoreException(Code)
This method will return true if the passed string value if a valid entry for the column based on the String format specified for the column via the setFormat method.
See Also:   DataStoreBuffer.setFormat


isPrimaryKey
public boolean isPrimaryKey(int col) throws DataStoreException(Code)
This method returns whether a column is part of the primary key


isPrimaryKey
public boolean isPrimaryKey(String col) throws DataStoreException(Code)
This method returns whether a column is part of the primary key


isUpdateable
public boolean isUpdateable(int col) throws DataStoreException(Code)
This method returns whether a column is updateable


isUpdateable
public boolean isUpdateable(String col) throws DataStoreException(Code)
This method returns whether a column is updateable


ping
public boolean ping() throws Exception(Code)
This method will ping the server for this particular data store. Pinging from time to time will prevent the server session from expiring. true if the ping succeeds and false if not.


removeRow
public boolean removeRow()(Code)
This removes the current row from the DataStore buffer. This will not generate a delete statment that will remove the row from the database when the update method is called. True if the row is remove and false if not.


removeRow
public boolean removeRow(int row)(Code)
This removes the row from the DataStore buffer. This will not generate a delete statment that will remove the row from the database when the update method is called.
Parameters:
  row - The number of the row to remove. True if the row is remove and false if not.


reset
public void reset()(Code)
This method will clear all rows in the dataStore.


resetStatus
public void resetStatus()(Code)
This method will clear the row status flags and clear the deleted buffer in the DataStoreBuffer.


retrieve
public void retrieve() throws java.sql.SQLException, DataStoreException(Code)
Executes the sql statement and retrieves to data. The data is retrieved in a new thread so the beginning of the result set can be accessed before all the data has been retrieved. You do not need to pass a database connection to this version of retrieve, but in order to use it the DataStore must be created with a constructor that passes an application (not the no args constructor).


setAny
public void setAny(int row, int column, Object value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column


setAny
public void setAny(int column, Object value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setAny
public void setAny(int row, String column, Object value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setAny
public void setAny(String column, Object value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column


setByteArray
public void setByteArray(int column, byte[] value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setByteArray
public void setByteArray(int row, int column, byte[] value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setByteArray
public void setByteArray(int row, String column, byte[] value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setByteArray
public void setByteArray(String column, byte[] value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column


setDataStoreRow
public void setDataStoreRow(int rowNo, int buffer, DataStoreRow row) throws DataStoreException(Code)
This method sets the specified row in the DataStore. The DataStoreRow must be compatible with the internal structure of the datastore (eg created with the getDataStoreRow method from the same datastore). To create a blank row in the datastore call the insertRow method and then getDataStoreRow.
Parameters:
  rowNo - The number of the row to get.
Parameters:
  buffer - The datastore buffer to look in. Valid values are BUFFER_STANDARD, BUFFER_DELETED, BUFFER_FILTERED.
Parameters:
  row - The row to set


setDate
public void setDate(int row, int column, java.sql.Date value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setDate
public void setDate(int row, String column, java.sql.Date value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setDate
public void setDate(int column, java.sql.Date value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setDate
public void setDate(String column, java.sql.Date value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column


setDateTime
public void setDateTime(int row, int column, java.sql.Timestamp value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setDateTime
public void setDateTime(int row, String column, java.sql.Timestamp value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setDateTime
public void setDateTime(int column, java.sql.Timestamp value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setDateTime
public void setDateTime(String column, java.sql.Timestamp value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column


setDistinct
public void setDistinct(boolean distinct)(Code)
This method will set the distinct flag in the data store.
Parameters:
  distinct - if the flag is set to true the generated select statement will begin with a select distinct.


setDouble
public void setDouble(int column, double value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setDouble
public void setDouble(int row, int column, double value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setDouble
public void setDouble(int row, String column, double value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setDouble
public void setDouble(String column, double value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setFindExpression
public void setFindExpression(String exp) throws DataStoreException(Code)
This method will set the expression used to find rows in the datastore. It is used in conjunction with the findNext, findPrior, findFirst, findLast and find methods.
Parameters:
  exp - The expression to use in the find.
See Also:   DataStore.findNext
See Also:   DataStore.findPrior
See Also:   DataStore.findFirst
See Also:   DataStore.findLast
See Also:   DataStore.find
See Also:   DataStore.filter
See Also:   DataStoreEvaluator


setFloat
public void setFloat(int column, float value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setFloat
public void setFloat(int row, int column, float value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setFloat
public void setFloat(int row, String column, float value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setFloat
public void setFloat(String column, float value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setFormat
public void setFormat(int col, String format) throws DataStoreException(Code)
This method sets a the format string for a date, time, datetime or numeric type column.
Parameters:
  col - The column number to set the format for.
Parameters:
  format - The format to use in parsing or formatting the value
See Also:   DataStore.getFormattedString
See Also:   DataStore.setFormattedString


setFormat
public void setFormat(String col, String format) throws DataStoreException(Code)
This method sets a the format string for a date, time, datetime or numeric type column.

Date Formats

Symbol Meaning Presentation Example
------ ------- ------------ -------
G era designator (Text) AD
y year (Number) 1996
M month in year (Text & Number) July & 07
d day in month (Number) 10
h hour in am/pm (1~12) (Number) 12
H hour in day (0~23) (Number) 0
m minute in hour (Number) 30
s second in minute (Number) 55
S millisecond (Number) 978
E day in week (Text) Tuesday
D day in year (Number) 189
F day of week in month (Number) 2 (2nd Wed in July)
w week in year (Number) 27
W week in month (Number) 2
a am/pm marker (Text) PM
k hour in day (1~24) (Number) 24
K hour in am/pm (0~11) (Number) 0
z time zone (Text) Pacific Standard Time
' escape for text (Delimiter)
'' single quote (Literal) '

Numeric Formats

Symbol Meaning
------ -------
0 a digit
# a digit, zero shows as absent
. placeholder for decimal separator
, placeholder for grouping separator.
; separates formats.
- default negative prefix.
% multiply by 100 and show as percentage
? multiply by 1000 and show as per mille
¤ currency sign; replaced by currency symbol; if
doubled, replaced by international currency symbol.
If present in a pattern, the monetary decimal separator
is used instead of the decimal separator.
X any other characters can be used in the prefix or suffix
' used to quote special characters in a prefix or suffix.

Parameters:
  col - The column name to set the format for.
Parameters:
  format - The format to use in parsing or formatting the value
See Also:   DataStore.getFormattedString
See Also:   DataStore.setFormattedString


setFormattedString
public void setFormattedString(int row, int column, String value) throws DataStoreException(Code)
This method will set a parse a string value using the format specified in setFormat for this column and place it in the datastore if it is valid.

See Also:   DataStore.setFormat


setFormattedString
public void setFormattedString(int column, String value) throws DataStoreException(Code)
This method will set a parse a string value using the format specified in setFormat for this column and place it in the datastore if it is valid.

See Also:   DataStore.setFormat


setFormattedString
public void setFormattedString(int row, String column, String value) throws DataStoreException(Code)
This method will set a parse a string value using the format specified in setFormat for this column and place it in the datastore if it is valid.

See Also:   DataStore.setFormat


setFormattedString
public void setFormattedString(String column, String value) throws DataStoreException(Code)
This method will set a parse a string value using the format specified in setFormat for this column and place it in the datastore if it is valid.

See Also:   DataStore.setFormat


setInt
public void setInt(int row, int column, int value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setInt
public void setInt(int row, String column, int value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setInt
public void setInt(String column, int value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setLong
public void setLong(int row, int column, long value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setLong
public void setLong(int column, long value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setLong
public void setLong(int row, String column, long value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setLong
public void setLong(String column, long value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setOrderBy
public void setOrderBy(String orderBy)(Code)
Sets the order by clause of the DataStore's SQL Statement
Parameters:
  orderBy - The columns to use to sort the result set.


setPrimaryKey
public void setPrimaryKey(int col, boolean pkey) throws DataStoreException(Code)
This method is used to indicate whether a column is part of the primary key


setPrimaryKey
public void setPrimaryKey(String col, boolean pkey) throws DataStoreException(Code)
This method is used to indicate whether a column is part of the primary key


setProperties
public void setProperties(Properties p)(Code)
This method builds the datastore from the information in the properties object.


setRemoteID
public void setRemoteID(String remoteID)(Code)
Used to set the remote id for the datastore


setRowStatus
public boolean setRowStatus(int status)(Code)
This method sets the status flag of the current row.
Parameters:
  status - (STATUS_NOT_MODIFIED,STATUS_MODIFIED,STATUS_NEW,STATUS_NEW_MODIFIED) True if the row is in the buffer and false if not


setRowStatus
public boolean setRowStatus(int row, int status)(Code)
This method sets the status flag of the specified row.
Parameters:
  row - The row in the datastore buffer.
Parameters:
  status - (STATUS_NOT_MODIFIED,STATUS_MODIFIED,STATUS_NEW,STATUS_NEW_MODIFIED) True if the row is in the buffer and false if not


setShort
public void setShort(int row, int column, short value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setShort
public void setShort(int row, String column, short value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setShort
public void setShort(int column, short value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setShort
public void setShort(String column, short value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setString
public void setString(int row, int column, String value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setString
public void setString(int column, String value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setString
public void setString(int row, String column, String value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setString
public void setString(String column, String value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column


setTime
public void setTime(int row, int column, java.sql.Time value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setTime
public void setTime(int row, String column, java.sql.Time value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setTime
public void setTime(int column, java.sql.Time value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column.


setTime
public void setTime(String column, java.sql.Time value) throws DataStoreException(Code)
This method sets a value in the data store's internal buffer at the current row.
Parameters:
  row - The row number for the value to set.
Parameters:
  column - The column for the value to set.
Parameters:
  value - The data to place in the column


sort
public void sort(int[] col, int dir) throws DataStoreException(Code)
This method will sort the rows in the data store on an array of columns. col[] A array of column numbers to sort on. dir[] An integer array of the direction to sort on. Each element can contain either SORT_ASC or SORT_DESC.


sort
public void sort(Object[] obj, int dir) throws DataStoreException(Code)
This method will sort the rows in the data store on an array of columns. obj[] A array of objects to sort on. The array can contain Strings (column name), Integers (column numbers) or DataStoreEvaluators (expressions) dir[] An integer array of the direction to sort on. Each element can contain either SORT_ASC or SORT_DESC.


sort
public void sort(String col, int dir) throws DataStoreException(Code)
This method will sort the rows in the data store on an array of columns. col[] A String array of column names to sort on. dir[] An integer array of the direction to sort on. Each element can contain either SORT_ASC or SORT_DESC.


sort
public void sort(int col, int dir) throws DataStoreException(Code)
This method will sort the rows in the data store on a particular column.
Parameters:
  col - The column number of the column to sort on.
Parameters:
  dir - The direction to sort on. Either SORT_ASC or SORT_DESC.


sort
public void sort(DataStoreEvaluator eval, int dir) throws DataStoreException(Code)
This method will sort the rows in the data store using an expression.
Parameters:
  eval - A datastore evaluator containing the expression.
Parameters:
  dir - An integer indicating the sort direction valid values are SORT_ASC or SORT_DESC.


sort
public void sort(String col, int dir) throws DataStoreException(Code)
This method will sort the rows in the data store on a particular column.
Parameters:
  col - The name of the column to sort on.
Parameters:
  dir - The direction to sort on. Either SORT_ASC or SORT_DESC.


unDeleteRow
public int unDeleteRow(int row)(Code)
This method will take a row from the datastores deleted buffer and move it back to the standard buffer.
Parameters:
  row - The number of the row to undelete. Note: this is the row number of the row in the deleted buffer not the standard buffer. The number that the deleted row was moved to in the standard buffer or -1 if an error occurs.


update
public void update() throws DataStoreException, java.sql.SQLException(Code)
This method will cause the database to reflect the changes made in the data store's buffer.
exception:
  com.salmonllc.sql.DataStoreException - If a SQLError occurs while the datastore is updating.


waitForCancel
public void waitForCancel()(Code)
This method will block until a datastore cancel command is finished


waitForRetrieve
public void waitForRetrieve()(Code)
This method will block until all the data from the last retrieve method call has been loaded into the DataStore's internal buffer.


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