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

ReportStructure

class ReportStructure(val queryFragment: QueryFragment, val initColumns: Map<String, ReportColumn>, val reportName: String, val rowActions: List<ReportRowAction> = emptyList(), val defaultRowAction: ReportRowAction? = null, val mainActions: List<ReportMainAction> = emptyList(), val quickSearchMapper: (String) -> QueryFragment?? = null)

Definicja struktury raportu - schemat określająca zapytania, kolumny i akcje.

ReportStructure to główna klasa konfiguracyjna systemu raportowania, która:

Definiuje zapytanie SQL dla pobierania danych
Konfiguruje kolumny z ich typami, filtrami i opcjami sortowania
Określa akcje dostępne dla wierszy i całego raportu
Automatycznie dodaje kolumny specjalne (akcje) do struktury

Kolumny dzielą się na:

Zwykłe kolumny: Definiowane przez developera, mapują dane z bazy
Kolumny specjalne: Generowane automatycznie (np. kolumna akcji)

Parameters

queryFragment

Zapytanie SQL do pobrania danych raportu.

initColumns

Mapa kolumn zdefiniowanych przez developera (klucz = nazwa kolumny w SQL).

reportName

Unikalna nazwa raportu (używana do zapisywania konfiguracji).

rowActions

Lista akcji dostępnych dla każdego wiersza.

defaultRowAction

Domyślna akcja wykonywana po podwójnym kliknięciu wiersza.

mainActions

Lista akcji głównych (np. "Dodaj nowy").

quickSearchMapper

Opcjonalna funkcja mapująca tekst wyszukiwania na fragment zapytania.

Constructors

ReportStructure

constructor(queryFragment: QueryFragment, initColumns: Map<String, ReportColumn>, reportName: String, rowActions: List<ReportRowAction> = emptyList(), defaultRowAction: ReportRowAction? = null, mainActions: List<ReportMainAction> = emptyList(), quickSearchMapper: (String) -> QueryFragment?? = null)

Properties

columns

lateinit var columns: Map<String, ReportColumn>

defaultRowAction

val defaultRowAction: ReportRowAction?

initColumns

private val initColumns: Map<String, ReportColumn>

mainActions

val mainActions: List<ReportMainAction>

manageableColumnKeys

val manageableColumnKeys: List<String>

Zwraca listę kluczy kolumn, które mogą być zarządzane przez użytkownika w panelu konfiguracji (ukrywanie, zmiana kolejności). Pomija kolumny specjalne (np. akcje).

queryFragment

val queryFragment: QueryFragment

quickSearchMapper

private val quickSearchMapper: (String) -> QueryFragment??

reportName

val reportName: String

rowActions

val rowActions: List<ReportRowAction>

Functions

buildDefaultQuickSearchFilter

private fun buildDefaultQuickSearchFilter(searchQuery: String): QueryFragment

getAllColumns

fun getAllColumns(): Map<String, ReportColumn>

Zwraca wszystkie kolumny zdefiniowane w tej strukturze

getColumn

fun getColumn(name: String): ReportColumn

Zwraca kolumnę o danej nazwie

getQuickSearchFilter

fun getQuickSearchFilter(searchQuery: String): QueryFragment

Zwraca fragment zapytania dla szybkiego wyszukiwania. Jeśli zdefiniowano quickSearchMapper, używa go. W przeciwnym razie buduje domyślny filtr po wszystkich filtrowalnych kolumnach.

initSpecialColumns

fun initSpecialColumns()