KSLCore/ksl.utilities.io.report.ast/ReportNode

ReportNode

A sealed hierarchy of format-agnostic AST nodes representing report content.

The tree is assembled by the DSL (ksl.utilities.io.report.dsl.ReportBuilder) and traversed by ReportVisitor implementations (renderers). Each node implements accept for double-dispatch, ensuring compile-time completeness in every renderer.

Structural nodes (recurse into children):

Document — root of the tree; carries the report title
Section — collapsible/titled group of child nodes; may be nested

Content leaf nodes (carry data, no children):

Heading — titled heading at a given level (1–6)
Paragraph — free-form text
StatPropertyTable — vertical Property | Value sheet for a single StatisticIfc
StatTable — horizontal comparison table for List<StatisticIfc>
WeightedStatPropertyTable— vertical Property | Value sheet for a single WeightedStatistic
WeightedStatTable — horizontal table for List<WeightedStatistic>
DataTable — general-purpose pre-formatted string table
PlotNode — a PlotIfc plot with an optional caption
RawText — verbatim pre-formatted text block
PageBreak — logical page/section separator

Inheritors

WeightedStatPropertyTable

Constructors

ReportNode

protected constructor()

Types

DataTable

data class DataTable(val headers: List<String>, val rows: List<List<String>>, val caption: String? = null) : ReportNode

A general-purpose tabular node for pre-formatted string data.

Document

data class Document(val title: String, val children: List<ReportNode>, val defaultOutputDir: Path? = null, val defaultPlotDir: Path? = null) : ReportNode

The root node of a report document.

Heading

data class Heading(val text: String, val level: Int = 1) : ReportNode

A standalone heading at the given level.

PageBreak

data object PageBreak : ReportNode

A logical page or section separator.

Paragraph

data class Paragraph(val text: String) : ReportNode

A free-form paragraph of text.

PlotNode

data class PlotNode(val plot: PlotIfc, val caption: String? = null) : ReportNode

A plot node wrapping any PlotIfc implementation.

RawText

data class RawText(val content: String) : ReportNode

A verbatim pre-formatted text block (analogous to <pre> in HTML).

Section

data class Section(val title: String?, val children: List<ReportNode>) : ReportNode

A titled, collapsible group of child nodes. Sections may be nested to any depth; renderers are responsible for tracking depth and adjusting heading levels accordingly.

StatPropertyTable

data class StatPropertyTable(val stat: StatisticIfc, val caption: String? = null, val confidenceLevel: Double = 0.95) : ReportNode

A vertical Property | Value property sheet for a single StatisticIfc.

StatTable

data class StatTable(val stats: List<StatisticIfc>, val caption: String? = null, val confidenceLevel: Double = 0.95, val detail: Boolean = false) : ReportNode

A horizontal summary/comparison table for any List of StatisticIfc instances.

WeightedStatPropertyTable

data class WeightedStatPropertyTable(val stat: WeightedStatistic, val caption: String? = null) : ReportNode

A vertical Property | Value property sheet for a single WeightedStatistic.

WeightedStatTable

data class WeightedStatTable(val stats: List<WeightedStatistic>, val caption: String? = null) : ReportNode

A horizontal comparison table for a List of WeightedStatistic instances.

Functions

abstract fun accept(visitor: ReportVisitor)

Double-dispatch entry point — each node calls the appropriate visitor method.