diff options
| author | Fabian Mastenbroek <mail.fabianm@gmail.com> | 2021-09-02 11:50:43 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-02 11:50:43 +0200 |
| commit | 05f80bd9fb7caf765e3ebbb70d48d0d5e185bd42 (patch) | |
| tree | 5fa9501621ad327028c2f2e12c9c367f44f6aebe /opendc-trace/opendc-trace-api/src/main/kotlin/org/opendc/trace/TableReader.kt | |
| parent | 99f391d11db57c3db3f326958de8f66502969cdb (diff) | |
| parent | 5935531137a22fdb920921580d491f86adec65c9 (diff) | |
merge: Add generic trace reading library
This pull request adds a generic trace reading library to OpenDC.
The library has been designed to support a wide range of trace formats
and uses a streaming approach to improve performance of reading large traces.
* Add trace reading API
* Implement API for GWF format
* Implement API for SWF format
* Implement API for WTF format
* Implement API for Bitbrains format
* Implement API for Bitbrains Parquet format
**Breaking API Changes**
* `opendc-format` has been removed in favour of `opendc-trace-*`
Diffstat (limited to 'opendc-trace/opendc-trace-api/src/main/kotlin/org/opendc/trace/TableReader.kt')
| -rw-r--r-- | opendc-trace/opendc-trace-api/src/main/kotlin/org/opendc/trace/TableReader.kt | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/opendc-trace/opendc-trace-api/src/main/kotlin/org/opendc/trace/TableReader.kt b/opendc-trace/opendc-trace-api/src/main/kotlin/org/opendc/trace/TableReader.kt new file mode 100644 index 00000000..b5e7669f --- /dev/null +++ b/opendc-trace/opendc-trace-api/src/main/kotlin/org/opendc/trace/TableReader.kt @@ -0,0 +1,70 @@ +/* + * 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 reading entities from a workload trace table in streaming fashion. + */ +public interface TableReader : AutoCloseable { + /** + * Advance the stream until the next row is reached. + * + * @return `true` if the row is valid, `false` if there are no more rows. + */ + public fun nextRow(): Boolean + + /** + * Determine whether the [TableReader] supports the specified [column]. + */ + public fun hasColumn(column: TableColumn<*>): Boolean + + /** + * Obtain the value of the current column with type [T]. + */ + public fun <T> get(column: TableColumn<T>): T + + /** + * Read the specified [column] as boolean. + */ + public fun getBoolean(column: TableColumn<Boolean>): Boolean + + /** + * Read the specified [column] as integer. + */ + public fun getInt(column: TableColumn<Int>): Int + + /** + * Read the specified [column] as long. + */ + public fun getLong(column: TableColumn<Long>): Long + + /** + * Read the specified [column] as double. + */ + public fun getDouble(column: TableColumn<Double>): Double + + /** + * Closes the reader so that no further iteration or data access can be made. + */ + public override fun close() +} |
