analytics-catalog-domain/me.ahoo.wow.analytics.catalog.domain.dataset/DatasetState

DatasetState

A dataset of the catalog: its name, its working definition and the sources it reads, and its published versions, of which queries read the current one (published).

Constructors

DatasetState

constructor()

Properties

context

var context: String

current

var current: Int

The version queries read: 0 before the first publication.

definition

var definition: DatasetDefinition?

dropped

var dropped: Boolean

Whether a retired dataset's views were dropped.

exists

val exists: Boolean

Whether the dataset exists: it was drafted.

name

var name: String

problems

var problems: List<String>

Why the published definition needs revision, while the dataset DatasetStatus.NEEDS_REVISION.

requested

var requested: DatasetDefinition?

The definition whose publication awaits an approver, and why it does; null when none does.

requestReasons

var requestReasons: List<String>

sources

var sources: List<String>

The ids of the catalog's sources the definition reads.

status

var status: DatasetStatus

stillServing

var stillServing: Boolean

Whether a dataset that needs revision still serves its published version, whose view still holds.

title

var title: String?

versions

var versions: List<DatasetVersion>

Every published version, oldest first.

Functions

nextVersion

fun nextVersion(): Int

The version a publication creates next.

onSourcing

fun onSourcing(event: DatasetDrafted)

fun onSourcing(event: DatasetNeedsRevision)

fun onSourcing(event: DatasetPublicationRefused)

fun onSourcing(event: DatasetPublicationRequested)

fun onSourcing(event: DatasetPublished)

fun onSourcing(event: DatasetRetired)

fun onSourcing(event: DatasetRevised)

fun onSourcing(event: DatasetRevisionCleared)

fun onSourcing(event: DatasetRolledBack)

fun onSourcing(event: DatasetViewsDropped)

published

fun published(): DatasetVersion?

The version queries read, or null before the first publication.

serving

fun serving(): DatasetArtifact?

The artifact queries read, or null when none is published, the dataset is retired, or it needs revision and its published version no longer holds.

version

fun version(version: Int): DatasetVersion?

The published version, or null when there is none.