Package ch.so.agi.gretl.internal.duckdb

Record Class XlsxExportSpec

java.lang.Object
java.lang.Record
ch.so.agi.gretl.internal.duckdb.XlsxExportSpec
All Implemented Interfaces:
DuckDbExportSpec, DuckDbFileExportSpec
public record XlsxExportSpec(String name, String query, Path file, String sheet, boolean header, int sheetRowLimit, boolean overwrite) extends Record implements DuckDbFileExportSpec

  • Constructor Summary

    Constructors
    Constructor
    Description
    XlsxExportSpec(String name, String query, Path file, String sheet, boolean header, int sheetRowLimit, boolean overwrite)
    Creates an instance of a XlsxExportSpec record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Path
    file()
    Returns the value of the file record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    header()
    Returns the value of the header record component.
    String
    inputSignature()
     
    String
    name()
    Returns the value of the name record component.
    boolean
    overwrite()
    Returns the value of the overwrite record component.
    String
    query()
    Returns the value of the query record component.
    List<String>
    requiredExtensions()
     
    String
    sheet()
    Returns the value of the sheet record component.
    int
    sheetRowLimit()
    Returns the value of the sheetRowLimit record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • XlsxExportSpec

      public XlsxExportSpec(String name, String query, Path file, String sheet, boolean header, int sheetRowLimit, boolean overwrite)
      Creates an instance of a XlsxExportSpec record class.
      Parameters:
      name - the value for the name record component
      query - the value for the query record component
      file - the value for the file record component
      sheet - the value for the sheet record component
      header - the value for the header record component
      sheetRowLimit - the value for the sheetRowLimit record component
      overwrite - the value for the overwrite record component

  • Method Details

    • requiredExtensions

      public List<String> requiredExtensions()
      Specified by:
      requiredExtensions in interface DuckDbExportSpec

    • inputSignature

      public String inputSignature()
      Specified by:
      inputSignature in interface DuckDbExportSpec

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Specified by:
      name in interface DuckDbExportSpec
      Returns:
      the value of the name record component

    • query

      public String query()
      Returns the value of the query record component.
      Specified by:
      query in interface DuckDbExportSpec
      Returns:
      the value of the query record component

    • file

      public Path file()
      Returns the value of the file record component.
      Specified by:
      file in interface DuckDbFileExportSpec
      Returns:
      the value of the file record component

    • sheet

      public String sheet()
      Returns the value of the sheet record component.
      Returns:
      the value of the sheet record component

    • header

      public boolean header()
      Returns the value of the header record component.
      Returns:
      the value of the header record component

    • sheetRowLimit

      public int sheetRowLimit()
      Returns the value of the sheetRowLimit record component.
      Returns:
      the value of the sheetRowLimit record component

    • overwrite

      public boolean overwrite()
      Returns the value of the overwrite record component.
      Specified by:
      overwrite in interface DuckDbFileExportSpec
      Returns:
      the value of the overwrite record component