Scautable API
API
Generated with
Scautable API/io.github.quafadas/io.github.quafadas.scautable

io.github.quafadas.scautable

package io.github.quafadas.scautable

Members list

Type members

Classlikes

class BadTableException(message: String) extends Exception

Exception thrown when there are issues with Excel table structure

Exception thrown when there are issues with Excel table structure

Attributes

Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object CSV

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
CSV.type
object CSVWriterExtensions

Extension methods for writing NamedTuple collections to CSV format.

Extension methods for writing NamedTuple collections to CSV format.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object ColumnTyped

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object ConsoleFormat

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
class CsvIterator[K <: Tuple, V <: Tuple] extends Iterator[NamedTuple[K, V]]

A NamedTuple representation of a CSV file.

A NamedTuple representation of a CSV file.

It is a (lazy) iterator that reads a CSV file line by line and converts each line into a NamedTuple.

Attempting to use the iterator a second time will throw a StreamClosedException. Common usage

def csvIterator = CSV.resource("simple.csv")
val csvData = csvIterator.toSeq

Note that at this point, you are plugged right into the scala collections API.

csvData.filter(_.column("colA") == "foo").drop(10).take(5).map(_.column("colB"))

etc

Attributes

Supertypes
trait Iterator[NamedTuple[K, V]]
trait IterableOnceOps[NamedTuple[K, V], Iterator, Iterator[NamedTuple[K, V]]]
trait IterableOnce[NamedTuple[K, V]]
class Object
trait Matchable
class Any
Show all
trait Decoder[T]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Decoder

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Decoder.type
object Excel

Main Excel API object providing transparent inline methods for reading Excel files

Main Excel API object providing transparent inline methods for reading Excel files

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Excel.type
object ExcelDecoders

Excel-specific decoders that can handle numeric strings like "1.0" These decoders are designed to work with Excel's tendency to format integers as doubles (e.g., "1.0" instead of "1")

Excel-specific decoders that can handle numeric strings like "1.0" These decoders are designed to work with Excel's tendency to format integers as doubles (e.g., "1.0" instead of "1")

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
class ExcelIterator[K <: Tuple, V <: Tuple](filePath: String, sheetName: String, colRange: Option[String])(using decoder: RowDecoder[V]) extends Iterator[NamedTuple[K, V]]

Iterator for reading Excel files with compile-time type safety

Iterator for reading Excel files with compile-time type safety

Type parameters

K

Tuple type representing column names

V

Tuple type representing column value types

Value parameters

colRange

Optional cell range specification (e.g., "A1:C10")

decoder

Row decoder for converting string data to typed tuples

filePath

Path to the Excel file

sheetName

Name of the Excel sheet to read

Attributes

Supertypes
trait Iterator[NamedTuple[K, V]]
trait IterableOnceOps[NamedTuple[K, V], Iterator, Iterator[NamedTuple[K, V]]]
trait IterableOnce[NamedTuple[K, V]]
class Object
trait Matchable
class Any
Show all
object ExcelMacros

Compile-time macro functions for reading val initial = ColumnTypeInfo() val finalInfo = cells.foldLeft(initial)(updateTypeInfo) files These macros perform Excel file inspection at compile time to determine structure

Compile-time macro functions for reading val initial = ColumnTypeInfo() val finalInfo = cells.foldLeft(initial)(updateTypeInfo) files These macros perform Excel file inspection at compile time to determine structure

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object ExcelResourceManager

Utility object for managing Excel workbook resources and lifecycle

Utility object for managing Excel workbook resources and lifecycle

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object ExcelUtils

Common utilities and exceptions for Excel processing

Common utilities and exceptions for Excel processing

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
ExcelUtils.type
object ExcelWorkbookCache

Thread-safe cache for Excel workbook instances to avoid file contention and improve performance.

Thread-safe cache for Excel workbook instances to avoid file contention and improve performance.

This cache uses weak references to allow workbooks to be garbage collected when no longer needed, while providing significant performance improvements when multiple operations access the same Excel file.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
enum HeaderOptions

Options for handling headers in tabular data.

Options for handling headers in tabular data.

This enum provides different strategies for obtaining column headers when reading data from sources like CSV files or Excel spreadsheets.

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HeaderOptions

Companion object for HeaderOptions.

Companion object for HeaderOptions.

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object HtmlRenderer

This is a simple library to render a scala case class as an html table. It assumes the presence of a HtmlTableRender instance for each type in the case class.

This is a simple library to render a scala case class as an html table. It assumes the presence of a HtmlTableRender instance for each type in the case class.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object NamedTupleIteratorExtensions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object Stats

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Stats.type
Generated with