Class ExportSheetBuilder

java.lang.Object
io.vertigo.quarto.exporter.model.ExportSheetBuilder
All Implemented Interfaces:
io.vertigo.core.lang.Builder<ExportSheet>

public final class ExportSheetBuilder extends Object implements io.vertigo.core.lang.Builder<ExportSheet>
Parametre d'export pour les données de type DT. La particularité est que l'on fournit la liste des colonnes du DT a exporter, avec éventuellement des paramètres d'affichage particulier pour une colonne. PB : ajout methode addField pour support du champ ExportCustomField
Author:
pchretien, npiedeloup
  • Method Summary

    Modifier and Type
    Method
    Description
    addCustomField(io.vertigo.datamodel.data.definitions.DataFieldName fieldName, Function<io.vertigo.datamodel.data.model.DataObject,String> getter, io.vertigo.core.locale.LocaleMessageText overridedLabel)
     
    addField(io.vertigo.datamodel.data.definitions.DataFieldName fieldName)
    Ajoute un champs du Dt dans l'export, le label de la colonne sera celui indiqué dans le DT pour ce champs.
    addField(io.vertigo.datamodel.data.definitions.DataFieldName fieldName, io.vertigo.core.locale.LocaleMessageText overridedLabel)
     
    addField(io.vertigo.datamodel.data.definitions.DataFieldName fieldName, io.vertigo.datamodel.data.model.DtList<?> list, io.vertigo.datamodel.data.definitions.DataFieldName displayfield)
    Ajoute un champs du Dt dans l'export, le label de la colonne sera celui indiqué dans le DT pour ce champs.
    addField(io.vertigo.datamodel.data.definitions.DataFieldName fieldName, io.vertigo.datamodel.data.model.DtList<?> list, io.vertigo.datamodel.data.definitions.DataFieldName displayfield, io.vertigo.core.locale.LocaleMessageText overridedLabel)
     
    addField(io.vertigo.datamodel.data.definitions.DataFieldName fieldName, io.vertigo.datamodel.data.model.DtList<?> list, io.vertigo.datamodel.data.definitions.DataFieldName keyfield, io.vertigo.datamodel.data.definitions.DataFieldName displayfield, io.vertigo.core.locale.LocaleMessageText overridedLabel)
     
    Close sheet.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Method Details

    • addField

      public ExportSheetBuilder addField(io.vertigo.datamodel.data.definitions.DataFieldName fieldName)
      Ajoute un champs du Dt dans l'export, le label de la colonne sera celui indiqué dans le DT pour ce champs.
      Parameters:
      fieldName - ajout d'un champs du Dt à exporter
      Returns:
      ExportSheetBuilder
    • addField

      public ExportSheetBuilder addField(io.vertigo.datamodel.data.definitions.DataFieldName fieldName, io.vertigo.datamodel.data.model.DtList<?> list, io.vertigo.datamodel.data.definitions.DataFieldName displayfield)
      Ajoute un champs du Dt dans l'export, le label de la colonne sera celui indiqué dans le DT pour ce champs.
      Parameters:
      fieldName - ajout d'un champs du Dt à exporter
      list - Liste des éléments dénormés
      displayfield - Field du libellé à utiliser.
      Returns:
      ExportSheetBuilder
    • addField

      public ExportSheetBuilder addField(io.vertigo.datamodel.data.definitions.DataFieldName fieldName, io.vertigo.core.locale.LocaleMessageText overridedLabel)
      Parameters:
      fieldName - ajout d'un champs du Dt à exporter
      overridedLabel - nom spécifique à utiliser dans l'export, null si l'on souhaite utiliser celui indiqué dans le DT pour ce champs
      Returns:
      ExportSheetBuilder
    • addField

      public ExportSheetBuilder addField(io.vertigo.datamodel.data.definitions.DataFieldName fieldName, io.vertigo.datamodel.data.model.DtList<?> list, io.vertigo.datamodel.data.definitions.DataFieldName displayfield, io.vertigo.core.locale.LocaleMessageText overridedLabel)
      Parameters:
      fieldName - ajout d'un champs du Dt à exporter
      list - Liste des éléments dénormés
      displayfield - Field du libellé à utiliser.
      overridedLabel - nom spécifique à utiliser dans l'export, null si l'on souhaite utiliser celui indiqué dans le DT pour ce champs
      Returns:
      ExportSheetBuilder
    • addField

      public ExportSheetBuilder addField(io.vertigo.datamodel.data.definitions.DataFieldName fieldName, io.vertigo.datamodel.data.model.DtList<?> list, io.vertigo.datamodel.data.definitions.DataFieldName keyfield, io.vertigo.datamodel.data.definitions.DataFieldName displayfield, io.vertigo.core.locale.LocaleMessageText overridedLabel)
      Parameters:
      fieldName - ajout d'un champs du Dt à exporter
      list - Liste des éléments dénormés
      keyfield - Field du libellé à utiliser.
      displayfield - Field du libellé à utiliser.
      overridedLabel - nom spécifique à utiliser dans l'export, null si l'on souhaite utiliser celui indiqué dans le DT pour ce champs
      Returns:
      ExportSheetBuilder
    • addCustomField

      public ExportSheetBuilder addCustomField(io.vertigo.datamodel.data.definitions.DataFieldName fieldName, Function<io.vertigo.datamodel.data.model.DataObject,String> getter, io.vertigo.core.locale.LocaleMessageText overridedLabel)
      Parameters:
      fieldName - obligatoire pour compatibilite avec autres types de ExportField mais pas utilise, la valeur est extraite par le getter
      getter -
      overridedLabel -
      Returns:
    • build

      public ExportSheet build()
      Specified by:
      build in interface io.vertigo.core.lang.Builder<ExportSheet>
    • endSheet

      public ExportBuilder endSheet()
      Close sheet.
      Returns:
      ExportBuilder