Interface DataTemplating<D>


public interface DataTemplating<D>
Aspect providing extended means for representing information on a data object.
Since:
5.2.5
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Set of parameters to be used with the given template.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    Aspect providing extended means for representing information on a data object.
  • Method Summary

    Modifier and Type
    Method
    Description
    getTemplate(D object, @NotNull Language language)
    Provides the template to be used for extended data representation.
    void
    registerParameters(@NotNull DataTemplating.ParameterSet parameters, D object, @NotNull Language language)
    Asks to register needed parameters to the given set.
  • Field Details

  • Method Details

    • getTemplate

      String getTemplate(@NotNull D object, @NotNull @NotNull Language language)
      Provides the template to be used for extended data representation.

      Parameters may be embedded using the form ${parametername} and will be replaced according to the parameter set provided by the aspect implementor.

      Parameters:
      object - The object to be represented.
      language - The language to get the template for.
      Returns:
      An (HTML) string of the prepared template.
      Since:
      5.2.5
    • registerParameters

      void registerParameters(@NotNull @NotNull DataTemplating.ParameterSet parameters, @NotNull D object, @NotNull @NotNull Language language)
      Asks to register needed parameters to the given set.

      (Special treatments).

      Parameters:
      parameters - The parameters container to register parameters with.
      object - The object to ask for parameter values.
      language - The language to get the values in.
      Since:
      5.2.5