package render

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Package Members

  1. package tag

Type Members

  1. abstract class BaseCsvProductGenerator[T] extends StandardCsvGenerator[T] with CsvProductGenerator[T]

    Base class for generating CSV output for product types, such as case classes, by extending both StandardCsvGenerator and CsvProductGenerator.

    Base class for generating CSV output for product types, such as case classes, by extending both StandardCsvGenerator and CsvProductGenerator.

    This abstract class provides a common foundation for implementing CSV generation for specific types of products by combining the column name handling from StandardCsvGenerator with the field name extraction capabilities of CsvProductGenerator.

    T

    the type of the product for which this generator is responsible.

    See also

    CsvAttributes for CSV configuration options.

    StandardCsvGenerator for handling standard column name generation.

    CsvProductGenerator for field name extraction specific to product types.

  2. trait BaseCsvRenderer[-T] extends CsvRenderer[T]

    Trait BaseCsvRenderer[-T] which extends CsvRenderer[T] to render, as CSV, an instance of Product (typically a case class).

    Trait BaseCsvRenderer[-T] which extends CsvRenderer[T] to render, as CSV, an instance of Product (typically a case class).

    T

    the contravariant type of object to be rendered.

  3. trait CsvGenerator[-T] extends AnyRef

    Trait (typeclass) for generating headers for CSV output.

    Trait (typeclass) for generating headers for CSV output.

    CONSIDER why do we need this? It takes a lot of effort to set up, which is essentially the same as for CsvRenderer[T].

    NOTE: this is an unusual type class in that none of its methods reference type T.

    T

    the contravariant type of the objects to be rendered by CSV.

  4. trait CsvGenerators extends AnyRef

    The CsvGenerators class provides factory methods for creating CsvGenerator instances for different types of data structures.

    The CsvGenerators class provides factory methods for creating CsvGenerator instances for different types of data structures. These generators can be used to serialize data into CSV (Comma-Separated Values) format.

    The class includes methods to handle sequences, options, individual types, and products (case classes with varying numbers of fields). It supports up to 6-ary product types, allowing for type inference and customization of CSV behavior.

  5. trait CsvProduct[-T] extends CsvRenderer[T] with CsvGenerator[T]

    Type class which combines CsvRenderer and CsvGenerator

    Type class which combines CsvRenderer and CsvGenerator

    T

    the contravariant type of object to be rendered.

  6. trait CsvProductGenerator[T] extends CsvGenerator[T]

    Trait (typeclass) for generating headers for CSV output.

    Trait (typeclass) for generating headers for CSV output.

    NOTE: this is an unusual type class in that none of its methods reference type T.

    T

    the type of the objects to be rendered by CSV.

  7. trait CsvRenderer[-T] extends Renderer[T, String]

    Type class for rendering instances to CSV.

    Type class for rendering instances to CSV.

    T

    the contravariant type of object to be rendered.

  8. trait CsvRenderers extends AnyRef

    Trait to define various renderers for rendering instance of case classes (with their various parameters), containers (Seq and Option), etc.

    Trait to define various renderers for rendering instance of case classes (with their various parameters), containers (Seq and Option), etc. to CSV output.

    CONSIDER a mechanism to ensure that objects involving case classes are presented in the same order as specified by the header.

  9. case class CsvTableFileRenderer[T](path: Path)(implicit z1: CsvRenderer[T], z2: CsvGenerator[T], csvAttributes: CsvAttributes) extends CsvTableRenderer[T, FileWriter] with Product with Serializable

    Case class to help render a Table to a File in CSV format.

    Case class to help render a Table to a File in CSV format.

    TODO merge this with CsvTableEncryptedFileRenderer to avoid duplicate code.

    T

    the type of object to be rendered, must provide evidence of CsvRenderer[T] amd CsvGenerator[T].

    path

    the path to which the table will be written.

    csvAttributes

    implicit instance of CsvAttributes.

  10. abstract class CsvTableRenderer[T, O] extends Renderer[Table[T], Try[O]]

    Abstract class for rendering a tabular representation of type Table[T] to a sequentially writable format O, such as CSV, while utilizing implicit type classes for rendering cells and generating column names.

    Abstract class for rendering a tabular representation of type Table[T] to a sequentially writable format O, such as CSV, while utilizing implicit type classes for rendering cells and generating column names.

    This class simplifies the conversion of tabular data (Table[T]) into a structured format (O) with support for customization through attributes and allows seamless integration with CSV-specific typeclasses.

    T

    the type of elements contained within the table; must have implicit evidence for CsvRenderer and CsvGenerator.

    O

    the type of the writable output; must have implicit evidence for Writable.

  11. case class CsvTableStringRenderer[T]()(implicit z1: CsvRenderer[T], z2: CsvGenerator[T], csvAttributes: CsvAttributes) extends CsvTableRenderer[T, StringBuilder] with Product with Serializable

    Case class to help render a Table to a StringBuilder in CSV format.

    Case class to help render a Table to a StringBuilder in CSV format.

    T

    the type of object to be rendered; must provide evidence of CsvRenderer[T] amd CsvGenerator[T].

    csvAttributes

    implicit instance of CsvAttributes.

  12. trait HierarchicalRenderer[T] extends Renderer[T, Node]

    Definition of type class HierarchicalRenderer for the purpose of serializing objects of type T.

    Definition of type class HierarchicalRenderer for the purpose of serializing objects of type T. Since, in general, T will be a case class which may include parameters which are case classes, we render to a hierarchical type: Node.

    T

    the type of object to be rendered.

    Annotations
    @implicitNotFound()
  13. trait HierarchicalRenderers extends AnyRef

    Trait to define various renderers for rendering instance of case classes (with their various parameters), containers (Seq and Option), etc.

    Trait to define various renderers for rendering instance of case classes (with their various parameters), containers (Seq and Option), etc. to hierarchical output elements such as XML or HTML.

  14. abstract class JsonTableRenderer[T] extends Renderer[Table[T], String]

    Abstract Class JsonTableRenderer, which will render a Table[T] as a JsValue.

    Abstract Class JsonTableRenderer, which will render a Table[T] as a JsValue.

    T

    the underlying type of the Table (i.e., the Row type) for which there must be evidence of JsonWriter[T].

  15. abstract class ProductCsvRenderer[T <: Product] extends BaseCsvProductGenerator[T] with BaseCsvRenderer[T] with CsvProduct[T]

    Abstract class ProductCsvRenderer[T] which extends BaseCsvRenderer[T] and CsvGenerator[T] and CsvProduct[T] to render, as CSV, an instance of Product (typically a case class).

    Abstract class ProductCsvRenderer[T] which extends BaseCsvRenderer[T] and CsvGenerator[T] and CsvProduct[T] to render, as CSV, an instance of Product (typically a case class).

    T

    the contravariant type of object to be rendered.

  16. abstract class ProductHierarchicalRenderer[T <: Product] extends HierarchicalRenderer[T]

    Abstract class ProductHierarchicalRenderer

    Abstract class ProductHierarchicalRenderer

    T

    the type of object to be rendered.

  17. trait Renderer[-T, O] extends AnyRef

    Definition of trait Renderer for the purpose of serializing objects of type T as an object of type O.

    Definition of trait Renderer for the purpose of serializing objects of type T as an object of type O. This trait may be used as a type class for either T or O (or both).

    NOTE: this trait has no direct relationship with TableRenderable.

    T

    the (contravariant) type of object to be rendered.

    O

    the type of the serialization result.

    Annotations
    @implicitNotFound()
  18. class StandardCsvGenerator[T] extends CsvGenerator[T]

    The StandardCsvGenerator class extends the CsvGenerator trait to provide functionality for generating standardized CSV output.

    The StandardCsvGenerator class extends the CsvGenerator trait to provide functionality for generating standardized CSV output. It utilizes implicit CsvAttributes for configuring the delimiter and quote character used in the CSV representation.

    T

    the type of the objects for which this generator creates column names.

  19. trait TableRenderable[X] extends AnyRef

    Polymorphic trait which defines the behavior of some sort of collection with an underlying type X and which can be rendered.

    Polymorphic trait which defines the behavior of some sort of collection with an underlying type X and which can be rendered.

    CONSIDER: do we really need this trait? This trait is not, strictly speaking, a typeclass because X does not appear as a parameter or result of any of the methods. However, it cannot be sealed which implies that it is used as a typeclass.

    NOTE: this trait has no direct relationship with Renderer. CONSIDER a refactoring of the whole set of traits.

    X

    the underlying type of this TableRenderable.

  20. abstract class TaggedHierarchicalRenderer[T] extends HierarchicalRenderer[T]

    Abstract class TaggedHierarchicalRenderer.

    Abstract class TaggedHierarchicalRenderer.

    T

    the type of object to be rendered.

  21. trait UntaggedHierarchicalRenderer[T] extends HierarchicalRenderer[T]

    CONSIDER having style defined as an Option[String]

    CONSIDER having style defined as an Option[String]

    T

    the type of object to be rendered.

Value Members

  1. object CsvGenerator extends CsvGenerators

    Companion object for the CsvGenerator type class providing implicit instances for various types.

    Companion object for the CsvGenerator type class providing implicit instances for various types.

    The implicit generators defined here are standard implementations used to generate CSV headers for specific data types. These generators are derived from predefined instances in the CsvGenerators object.

    Implicit instances: - Integer values (Int), using CsvGenerators.CsvGeneratorInt - String values (String), using CsvGenerators.CsvGeneratorString - Boolean values (Boolean), using CsvGenerators.CsvGeneratorBoolean - Double-precision floating-point numbers (Double), using CsvGenerators.CsvGeneratorDouble - Arbitrarily large integers (BigInt), using CsvGenerators.CsvGeneratorBigInt - Long integer values (Long), using CsvGenerators.CsvGeneratorLong - URL values from the java.net package (java.net.URL), using CsvGenerators.CsvGeneratorURL

  2. object CsvGenerators
  3. object CsvRenderer extends CsvRenderers

    An object that provides type class support for rendering data as CSV (Comma-Separated Values).

    An object that provides type class support for rendering data as CSV (Comma-Separated Values).

    The CsvRenderer object is designed to define implicit instances of CsvRenderer for specific types, allowing those types to be rendered to a CSV format string. It relies on the Renderer type class, which generalizes rendering objects of type T into objects of type O (in this case, strings).

    This object can include predefined implicit renderers (e.g., Row renderer) that leverage attributes (Map[String, String]) to modify the output or handle special behaviors for CSV attributes.

  4. object CsvRenderers

    The CsvRenderers object provides a collection of implicit StandardCsvRenderer implementations for common data types.

    The CsvRenderers object provides a collection of implicit StandardCsvRenderer implementations for common data types. These renderers are used to convert data of specific types into CSV (Comma-Separated Values) format according to the defined rendering logic.

  5. object CsvTableFileRenderer extends Serializable

    Singleton companion object providing a factory method to create instances of CsvTableFileRenderer.

    Singleton companion object providing a factory method to create instances of CsvTableFileRenderer.

    This object simplifies the instantiation of CsvTableFileRenderer, allowing the user to provide a File directly, which is internally converted to a Path. Implicit instances of CsvRenderer, CsvGenerator, and CsvAttributes are required to define CSV rendering logic, header generation, and formatting options.

  6. object HierarchicalRenderer

    Object HierarchicalRenderer provides a collection of implicit instances and type definitions for the UntaggedHierarchicalRenderer trait, allowing for hierarchical serialization of various primitive and common types such as String, Boolean, Int, Long, BigInt, Double, and LocalDate.

    Object HierarchicalRenderer provides a collection of implicit instances and type definitions for the UntaggedHierarchicalRenderer trait, allowing for hierarchical serialization of various primitive and common types such as String, Boolean, Int, Long, BigInt, Double, and LocalDate.

    These implicit objects define how to render instances of their respective types into a hierarchical structure (Node) by extending the generic UntaggedHierarchicalRenderer which implements the HierarchicalRenderer interface.

Ungrouped