KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > daffodilwoods > daffodildb > server > sql99 > dql > resultsetmetadata > _AllColumnRowReader


1 package com.daffodilwoods.daffodildb.server.sql99.dql.resultsetmetadata;
2
3 import com.daffodilwoods.daffodildb.server.sql99.dql.execution.*;
4 import com.daffodilwoods.daffodildb.utils.comparator.*;
5 import com.daffodilwoods.database.resource.*;
6
7 /**
8  * It acts as row reader in the case when resultset is of Updatable type. It is
9  * needed for performing modifications through the resultset taken on the select
10  * query.
11  * <p>Title: </p>
12  * <p>Description: </p>
13  * <p>Copyright: Copyright (c) 2003</p>
14  * <p>Company: </p>
15  * @author unascribed
16  * @version 1.0
17  */
18
19 public interface _AllColumnRowReader extends _RowReader{
20
21    /**
22     * It is used to obtain the value of column of passed table at passed index
23     * from the passed row. It is required in listener work to compute the
24     * functional columns at client side.
25     * @param tableInfo
26     * @param columnIndex
27     * @param row
28     * @return
29     * @throws DException
30     */
31
32    Object JavaDoc getObject(_TableInfo tableInfo, int columnIndex, Object JavaDoc row) throws DException ;
33
34    /**
35     * It is used to obtain the value of column of passed table
36     * from the passed row. It is required in listener work to compute the
37     * functional columns at client side.
38     * @param tableInfo
39     * @param columnName
40     * @param row
41     * @return
42     * @throws DException
43     */
44
45    Object JavaDoc getObject(_TableInfo tableInfo, String JavaDoc columnName, Object JavaDoc row) throws DException ;
46
47    /**
48     * It returns the values of primary key condition's columns from the row. It
49     * is required in listener work.
50     * @param row
51     * @return
52     * @throws DException
53     */
54
55    Object JavaDoc[] getPrimaryKeyConditionalColumnValues(Object JavaDoc []row) throws DException ;
56
57    /**
58     * It allows user to obtain the blank row. It is required in listener work
59     * at client side. It helps in inserting a new row.
60     * @return
61     * @throws DException
62     */
63
64    Object JavaDoc getBlankRow() throws DException;
65
66    /**
67     * Sets the value of passed column at appropriate position in the row. It is
68     * used in listener work at client side.
69     * @param columnName
70     * @param value
71     * @param row
72     * @throws DException
73     */
74
75    void setObject(String JavaDoc columnName, Object JavaDoc value, Object JavaDoc row) throws DException ;
76
77    /**
78     * Sets the value of passed column of table at appropriate position in the
79     * row. It is used in listener work at client side.
80     * @param tableInfo
81     * @param columnIndex
82     * @param value
83     * @param row
84     * @throws DException
85     */
86
87    void setObject(_TableInfo tableInfo, int columnIndex, Object JavaDoc value, Object JavaDoc row) throws DException ;
88
89    /**
90     * Returns a comparator to compare the value of keys for different rows. It
91     * is used to place the row at appropriate position at client side.
92     * @return
93     * @throws DException
94     */
95
96    SuperComparator getComparator() throws DException;
97
98    /**
99     * Returns the indexes of key columns. It is used at client side to check
100     * whether there is a need to reposition the row in resultset.
101     * @return
102     * @throws DException
103     */
104
105    int[] getKeyColumnIndexes() throws DException;
106
107    /**
108     * Returns the key of the row. It is needed at client side to get the actual
109     * position of the row at client side.
110     * @param row
111     * @return
112     * @throws DException
113     */
114
115    Object JavaDoc getKey(Object JavaDoc row) throws DException;
116
117    /**
118     * It is used to obtain the clone of the row at client side. It is needed
119     * while inserting new rows at client side.
120     * @param row
121     * @return
122     * @throws DException
123     */
124
125    public Object JavaDoc getRowClone(Object JavaDoc row) throws DException;
126
127    /**
128     * Returns the name of column of table at passed index.
129     * @param tableInfo
130     * @param index
131     * @return
132     * @throws DException
133     */
134
135    String JavaDoc getColumnName(_TableInfo tableInfo, int index) throws DException ;
136
137    /**
138     * Sets the value of columns at passed indexes from old row to new row.
139     * @param oldRow
140     * @param newRow
141     * @param columnIndexes
142     * @throws DException
143     */
144
145    public void setObjects(Object JavaDoc oldRow, Object JavaDoc newRow, int[] columnIndexes) throws DException;
146 }
147
Popular Tags