CollectionContentsExporter

SPI to provide file export to table views.

API

CollectionContentsExporter.java
interface CollectionContentsExporter {
  void createExport(DataTable dataTable, File tempFile)     (1)
  Blob exportToBlob(DataTable dataTable, String name)     (2)
  CommonMimeType getMimeType()
  String getTitleLabel()     (3)
  String getCssClass()     (4)
  int orderOfAppearanceInUiDropdown()     (5)
  boolean appliesTo(ObjectSpecification objectType)     (6)
}
1 createExport(DataTable, File)

Implementing exporters need to write given tabular data from DataTable into the File tempFile , which is provided by the framework for the duration of a single request cycle.
2 exportToBlob(DataTable, String)

Writes given tabular data into a Blob of given name.
3 getTitleLabel()
4 getCssClass()
5 orderOfAppearanceInUiDropdown()

An ordinal, that governs the order of appearance in the UI dropdown.
6 appliesTo(ObjectSpecification)

Whether this exporter applies to given objectType . If false , this exporter is not provided to the end user.

Members

createExport(DataTable, File)

Implementing exporters need to write given tabular data from DataTable into the File tempFile , which is provided by the framework for the duration of a single request cycle.

exportToBlob(DataTable, String)

Writes given tabular data into a Blob of given name.

getTitleLabel()

getCssClass()

orderOfAppearanceInUiDropdown()

An ordinal, that governs the order of appearance in the UI dropdown.

  • 1000..1999 reserved for different table presentations

  • 2000..2999 reserved for different table exports

Lowest comes first.

appliesTo(ObjectSpecification)

Whether this exporter applies to given objectType . If false , this exporter is not provided to the end user.