KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > hsqldb > rowio > RowOutputInterface


1 /* Copyright (c) 2001-2005, The HSQL Development Group
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * Neither the name of the HSQL Development Group nor the names of its
15  * contributors may be used to endorse or promote products derived from this
16  * software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
22  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31
32 package org.hsqldb.rowio;
33
34 import org.hsqldb.CachedRow;
35 import org.hsqldb.Table;
36 import org.hsqldb.lib.HashMappedList;
37 import org.hsqldb.lib.HsqlByteArrayOutputStream;
38
39 /**
40  * Public interface for writing the data for a database row.
41  *
42  * @author sqlbob@users (RMP)
43  * @author fredt@users
44  * @version 1.7.2
45  * @since 1.7.0
46  */
47 public interface RowOutputInterface {
48
49     void writeEnd();
50
51     void writeSize(int size);
52
53     void writeType(int type);
54
55     void writeString(String JavaDoc value);
56
57     void writeShortData(short i);
58
59     void writeIntData(int i);
60
61     void writeIntData(int i, int position);
62
63     void writeLongData(long i);
64
65     void writeRow(Object JavaDoc[] data, Table t);
66
67     void writeData(Object JavaDoc[] data, Table t);
68
69     void writeData(int l, int[] types, Object JavaDoc[] data, HashMappedList cols,
70                    int[] primarykeys);
71
72     // independent of the this object, calls only a static method
73 int getSize(CachedRow row);
74
75     // returns the underlying HsqlByteArrayOutputStream
76 HsqlByteArrayOutputStream getOutputStream();
77
78     // resets the byte[] buffer, ready for processing new row
79 void reset();
80
81     // returns the current size
82 int size();
83 }
84
Popular Tags