1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
/*
* Copyright (c) 2021 AtLarge Research
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package org.opendc.trace
/**
* Base class for writing workload traces.
*/
public interface TableWriter : AutoCloseable {
/**
* Start a new row in the table.
*/
public fun startRow()
/**
* Flush the current row to the table.
*/
public fun endRow()
/**
* Resolve the index of the specified [column] for this writer.
*
* @param column The column to lookup.
* @return The zero-based index of the column or a negative value if the column is not present in this table.
*/
public fun resolve(column: TableColumn<*>): Int
/**
* Determine whether the [TableReader] supports the specified [column].
*/
public fun hasColumn(column: TableColumn<*>): Boolean = resolve(column) >= 0
/**
* Set [column] to [value].
*
* @param index The zero-based index of the column to set the value for.
* @param value The value to set the column to.
* @throws IllegalArgumentException if the column is not valid for this method.
*/
public fun set(index: Int, value: Any)
/**
* Set [column] to boolean [value].
*
* @param index The zero-based index of the column to set the value for.
* @param value The boolean value to set the column to.
* @throws IllegalArgumentException if the column is not valid for this method.
*/
public fun setBoolean(index: Int, value: Boolean)
/**
* Set [column] to integer [value].
*
* @param index The zero-based index of the column to set the value for.
* @param value The integer value to set the column to.
* @throws IllegalArgumentException if the column is not valid for this method.
*/
public fun setInt(index: Int, value: Int)
/**
* Set [column] to long [value].
*
* @param index The zero-based index of the column to set the value for.
* @param value The long value to set the column to.
* @throws IllegalArgumentException if the column is not valid for this method.
*/
public fun setLong(index: Int, value: Long)
/**
* Set [column] to double [value].
*
* @param index The zero-based index of the column to set the value for.
* @param value The double value to set the column to.
* @throws IllegalArgumentException if the column is not valid for this method.
*/
public fun setDouble(index: Int, value: Double)
/**
* Set [column] to [value].
*
* @param column The column to set the value for.
* @param value The value to set the column to.
* @throws IllegalArgumentException if the column is not valid for this method.
*/
public fun <T : Any> set(column: TableColumn<T>, value: T): Unit = set(resolve(column), value)
/**
* Set [column] to boolean [value].
*
* @param column The column to set the value for.
* @param value The boolean value to set the column to.
* @throws IllegalArgumentException if the column is not valid for this method.
*/
public fun setBoolean(column: TableColumn<Boolean>, value: Boolean): Unit = setBoolean(resolve(column), value)
/**
* Set [column] to integer [value].
*
* @param column The column to set the value for.
* @param value The integer value to set the column to.
* @throws IllegalArgumentException if the column is not valid for this method.
*/
public fun setInt(column: TableColumn<Int>, value: Int): Unit = setInt(resolve(column), value)
/**
* Set [column] to long [value].
*
* @param column The column to set the value for.
* @param value The long value to set the column to.
* @throws IllegalArgumentException if the column is not valid for this method.
*/
public fun setLong(column: TableColumn<Long>, value: Long): Unit = setLong(resolve(column), value)
/**
* Set [column] to double [value].
*
* @param column The column to set the value for.
* @param value The double value to set the column to.
* @throws IllegalArgumentException if the column is not valid for this method.
*/
public fun setDouble(column: TableColumn<Double>, value: Double): Unit = setDouble(resolve(column), value)
/**
* Flush any buffered content to the underlying target.
*/
public fun flush()
/**
* Close the writer so that no more rows can be written.
*/
public override fun close()
}
|
