Module is.codion.framework.model

Package is.codion.framework.model

Interface EntityExport.Builder

Enclosing interface:

EntityExport

public static interface EntityExport.Builder

Builds a EntityExport

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntityExport.Builder.EntitiesStep	Specifies the entities to export
static interface	EntityExport.Builder.EntityTypeStep	Specifies the entity type
static interface	EntityExport.Builder.ExportAttributesStep	Specifies the export attributes
static interface	EntityExport.Builder.OutputStep	Specifies the export output

Method Summary

Modifier and Type	Method	Description
EntityExport.Builder	cancel(ObservableState cancel)	export() throws a CancelException in case this state is activated
void	export()	Performs the export
EntityExport.Builder	processed(Consumer<Entity> processed)

Method Details

processed

EntityExport.Builder processed(Consumer<Entity> processed)

Parameters:

processed - receives each entity after it's been processed

Returns:

this EntityExport.Builder

cancel

EntityExport.Builder cancel(ObservableState cancel)

export() throws a CancelException in case this state is activated

Parameters:

cancel - indicates whether the export should be cancelled

Returns:

this EntityExport.Builder

export

void export()

Performs the export

A referenced entity is fetched only when the entity being exported does not already carry it, with every attribute the export requires.

Throws:

CancelException - in case cancel(ObservableState) is activated

IllegalStateException - in case no attributes are included, an export of nothing being a configuration error

EntityNotFoundException - in case a foreign key references a row which does not exist, which aborts the export rather than exporting an empty cell