Module de.siegmar.fastcsv
Package de.siegmar.fastcsv.reader

Class NamedCsvRecordHandler

java.lang.Object
de.siegmar.fastcsv.reader.CsvCallbackHandler<NamedCsvRecord>
de.siegmar.fastcsv.reader.NamedCsvRecordHandler
public final class NamedCsvRecordHandler extends CsvCallbackHandler<NamedCsvRecord>
A callback handler that returns a NamedCsvRecord for each record.

This implementation is stateful and must not be reused.

  • Field Details

    • fieldModifier

      protected final FieldModifier fieldModifier
      The field modifier.

    • startingLineNumber

      protected long startingLineNumber
      The starting line number of the current record.

      See CsvCallbackHandler.beginRecord(long) and CsvRecord.getStartingLineNumber().

    • fields

      protected String[] fields
      The internal fields array.

    • recordSize

      protected int recordSize
      The total size (sum of all characters) of the current record.

    • fieldIdx

      protected int fieldIdx
      The current index in the internal fields array.

    • comment

      protected boolean comment
      Whether the current record is a comment.

    • emptyLine

      protected boolean emptyLine
      Whether the line is empty.

  • Constructor Details

    • NamedCsvRecordHandler

      public NamedCsvRecordHandler()
      Constructs a new NamedCsvRecordHandler with an empty header.

    • NamedCsvRecordHandler

      public NamedCsvRecordHandler(List<String> header)
      Constructs a new NamedCsvRecordHandler with the given header.
      Parameters:
      header - the header, must not be null or contain null elements
      Throws:
      NullPointerException - if null is passed

    • NamedCsvRecordHandler

      public NamedCsvRecordHandler(String... header)
      Constructs a new NamedCsvRecordHandler with the given header.
      Parameters:
      header - the header, must not be null or contain null elements
      Throws:
      NullPointerException - if null is passed

    • NamedCsvRecordHandler

      public NamedCsvRecordHandler(FieldModifier fieldModifier)
      Constructs a new NamedCsvRecordHandler with the given field modifier.
      Parameters:
      fieldModifier - the field modifier, must not be null
      Throws:
      NullPointerException - if null is passed

    • NamedCsvRecordHandler

      public NamedCsvRecordHandler(FieldModifier fieldModifier, List<String> header)
      Constructs a new NamedCsvRecordHandler with the given header and field modifier.
      Parameters:
      fieldModifier - the field modifier, must not be null
      header - the header, must not be null or contain null elements
      Throws:
      NullPointerException - if null is passed

    • NamedCsvRecordHandler

      public NamedCsvRecordHandler(FieldModifier fieldModifier, String... header)
      Constructs a new NamedCsvRecordHandler with the given header and field modifier.
      Parameters:
      fieldModifier - the field modifier, must not be null
      header - the header, must not be null or contain null elements
      Throws:
      NullPointerException - if null is passed

  • Method Details

    • buildRecord

      protected RecordWrapper<NamedCsvRecord> buildRecord()
      Description copied from class: CsvCallbackHandler
      Called at the end of each CSV record to build an object representation of the record.

      The returned wrapper is used by the CsvReader in order to determine how to process the record.

      Specified by:
      buildRecord in class CsvCallbackHandler<NamedCsvRecord>
      Returns:
      the record wrapper or null if the record should be ignored/skipped

    • beginRecord

      protected void beginRecord(long startingLineNumber)
      Called at the beginning of each record.

      The startingLineNumber is the line number where the record starts (starting with 1). See CsvRecord.getStartingLineNumber(). Resets the internal state of this handler.

      Specified by:
      beginRecord in class CsvCallbackHandler<T>
      Parameters:
      startingLineNumber - the line number where the record starts (starting with 1)

    • addField

      protected void addField(char[] buf, int offset, int len, boolean quoted)
      Called for each field in the record.

      A record can either be a comment or a regular record. If this method is called, the record is a regular record and cannot be a comment.

      The quoted parameter indicates whether the field was quoted. It is for informational purposes only. Any potential escape characters are already removed and the offset points to the first character after the opening quote and the len does not include the closing quote. Hence, a quoted field can be processed in the same way as an unquoted field. Some implementations need the information whether a field was quoted, e.g., for differentiating between null and empty fields (foo,,bar vs. foo,"",bar).

      The buf parameter is the internal buffer that contains the field value (among other data). Do not attempt to modify the buffer or store a reference to it. The buffer is reused for performance reasons. Passes the materialized (materializeField(char[], int, int)) and modified (modifyField(String, boolean)) value to addField(String, boolean).

      Specified by:
      addField in class CsvCallbackHandler<T>
      Parameters:
      buf - the internal buffer that contains the field value (among other data)
      offset - the offset of the field value in the buffer
      len - the length of the field value
      quoted - true if the field was quoted
      Throws:
      CsvParseException - if the addition exceeds the limit of record size or maximum fields count.

    • addField

      protected void addField(String value, boolean quoted)
      Adds the given value to the internal fields array.

      Extends the array if necessary and keeps track of the total record size and fields count.

      Parameters:
      value - the field value
      quoted - true if the field was quoted
      Throws:
      CsvParseException - if the addition exceeds the maximum fields count.

    • modifyField

      protected String modifyField(String value, boolean quoted)
      Modifies field value.
      Parameters:
      value - the field value
      quoted - true if the field was quoted
      Returns:
      the modified field value

    • materializeField

      protected String materializeField(char[] buf, int offset, int len)
      Materializes field from the given buffer.
      Parameters:
      buf - the internal buffer that contains the field value (among other data)
      offset - the offset of the field value in the buffer
      len - the length of the field value
      Returns:
      the materialized field value

    • setComment

      protected void setComment(char[] buf, int offset, int len)
      Called for each comment line.

      Note that the comment character is not included in the value.

      This method is not called if CsvReader.CsvReaderBuilder.commentStrategy(CommentStrategy) is set to CommentStrategy.NONE.

      There can only be one invocation of this method per record. A record can either be a comment or a regular record. If this method is called, the record is a comment and cannot be a regular record.

      The buf parameter is the internal buffer that contains the field value (among other data). Do not attempt to modify the buffer or store a reference to it. The buffer is reused for performance reasons. Passes the materialized (materializeComment(char[], int, int)) and modified (modifyComment(String)) value to setComment(String).

      Specified by:
      setComment in class CsvCallbackHandler<T>
      Parameters:
      buf - the internal buffer that contains the field value (among other data)
      offset - the offset of the field value in the buffer
      len - the length of the field value
      Throws:
      CsvParseException - if the addition exceeds the limit of record size.

    • setComment

      protected void setComment(String value)
      Sets the given value as the only field in the internal fields array.

      Keeps track of the total record size.

      Parameters:
      value - the comment value
      Throws:
      CsvParseException - if the addition exceeds the limit of record size.

    • modifyComment

      protected String modifyComment(String field)
      Modifies comment value.
      Parameters:
      field - the comment value
      Returns:
      the modified comment value

    • materializeComment

      protected String materializeComment(char[] buf, int offset, int len)
      Materializes comment from the given buffer.
      Parameters:
      buf - the internal buffer that contains the comment value (among other data)
      offset - the offset of the field value in the buffer
      len - the length of the field value
      Returns:
      the materialized field value

    • compactFields

      protected String[] compactFields()
      Builds a compact fields array (a copy of the internal fields array with the length of the current record).

      In contrast to the class property fields, the returned array does only contain the fields of the current record.

      Returns:
      the compact fields array

    • buildWrapper

      protected RecordWrapper<NamedCsvRecord> buildWrapper(NamedCsvRecord rec)
      Builds a record wrapper for the given record.
      Parameters:
      rec - the record, must not be null
      Returns:
      the record wrapper
      Throws:
      NullPointerException - if rec is null