Module is.codion.framework.model

Package is.codion.framework.model

Interface EntityExport.ExportAttributes

Enclosing interface:

EntityExport

public static interface EntityExport.ExportAttributes

Attribute settings for exporting entity data with denormalized foreign key references.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntityExport.ExportAttributes.Builder	Builds EntityExport.ExportAttributes

Method Summary

Modifier and Type	Method	Description
Optional<EntityExport.ExportAttributes>	attributes(ForeignKey foreignKey)	Returns an EntityExport.ExportAttributes instance for the given foreign key, or an empty optional if this foreign key should not be traversed
Comparator<Attribute<?>>	comparator()
EntityType	entityType()
Collection<Attribute<?>>	include()

Method Details

entityType

EntityType entityType()

Returns:

the entity type

include

Collection<Attribute<?>> include()

Returns:

the attributes to include in the export

comparator

Comparator<Attribute<?>> comparator()

Returns:

the comparator used to order exported attributes

attributes

Optional<EntityExport.ExportAttributes> attributes(ForeignKey foreignKey)

Returns an EntityExport.ExportAttributes instance for the given foreign key, or an empty optional if this foreign key should not be traversed

Parameters:

foreignKey - the foreign key

Returns:

an EntityExport.ExportAttributes instance for the given foreign key