report-engine/org.octavius.report.component/ReportStructureBuilder

ReportStructureBuilder

abstract class ReportStructureBuilder : KoinComponent

Abstrakcyjna fabryka do tworzenia struktur raportów.

Używa wzorca Template Method do zdefiniowania szkieletu procesu budowania raportu. Klasy dziedziczące implementują konkretne części:

Zapytanie SQL
Definicje kolumn
Akcje użytkownika

Przykład implementacji:

class UsersReportStructureBuilder : ReportStructureBuilder() {
    override fun getReportName() = "users"
    override fun buildQuery() = Query("SELECT id, name, email FROM users")
    override fun buildColumns() = mapOf(
        "id" to NumberColumn("ID"),
        "name" to StringColumn("Nazwa"),
        "email" to StringColumn("Email")
    )
}

Constructors

ReportStructureBuilder

constructor()

Properties

val dataAccess: DataAccess

Functions

fun build(): ReportStructure

Główna metoda budująca. Orkiestruje proces i nie powinna być nadpisywana.

abstract fun buildColumns(): Map<String, ReportColumn>

Buduje i zwraca mapę kolumn dla raportu.

buildDefaultRowAction

open fun buildDefaultRowAction(): ReportRowAction?

Buduje i zwraca domyślną akcję dla wierszy. Domyślnie zwraca null.

buildMainActions

open fun buildMainActions(): List<ReportMainAction>

Buduje i zwraca listę akcji dla menu "Dodaj". Domyślnie zwraca pustą listę.

abstract fun buildQuery(): QueryFragment

Buduje i zwraca obiekt Query dla raportu.

buildQuickSearch

open fun buildQuickSearch(searchQuery: String): QueryFragment?

Buduje fragment zapytania dla szybkiego wyszukiwania. Nadpisz tę metodę, aby dostarczyć niestandardową logikę wyszukiwania.

buildRowActions

open fun buildRowActions(): List<ReportRowAction>

Buduje i zwraca listę akcji dla wierszy. Domyślnie zwraca pustą listę, ponieważ nie każdy raport ma akcje.

private fun buildStructure(): ReportStructure

Metoda szablonowa, która składa raport z części dostarczonych przez metody abstrakcyjne.

open fun getKoin(): Koin

abstract fun getReportName(): String

Zwraca nazwę raportu.