Interface Dialect

All Known Subinterfaces:
DialectForwarding<D>, DialectMutable, DialectMutableForwarding<D>
All Known Implementing Classes:
DialectForwardingBase, DialectImpl, DialectMutableForwardingBase, DialectMutableImpl
public interface Dialect
Resource view of the Dialect class according to https://www.w3.org/ns/csvw#class-definitions All attributes mapped.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    copyInto(DialectMutable dest, boolean copyNulls)
     
    String
    getCommentPrefix()
    An atomic property that sets the comment prefix flag to the single provided value, which MUST be a string.
    String
    getDelimiter()
    An atomic property that sets the delimiter flag to the single provided value, which MUST be a string.
    String
    getEncoding()
    An atomic property that sets the encoding flag to the single provided string value, which MUST be a defined in [encoding].
    Boolean
    getHeader()
    A boolean atomic property that, if `true`, sets the header row count flag to `1`, and if `false` to `0`, unless headerRowCount is provided, in which case the value provided for the header property is ignored.
    Long
    getHeaderRowCount()
    An numeric atomic property that sets the header row count flag to the single provided value, which must be a non-negative integer.
    default List<String>
    getLineTerminatorList()
    Attempts to parse the line terminators as a json array and return an array of the strings.
    String
    getLineTerminators()
    An atomic property that sets the line terminators flag to either an array containing the single provided string value, or the provided array.
    String
    getQuoteChar()
    An atomic property that sets the quote character flag to the single provided value, which must be a string or `null`.
    String
    getQuoteEscapeChar()
    Extension: Quote escape char
    Boolean
    getSkipBlankRows()
    An boolean atomic property that sets the `skip blank rows` flag to the single provided boolean value.
    Long
    getSkipColumns()
    An numeric atomic property that sets the `skip columns` flag to the single provided numeric value, which MUST be a non-negative integer.
    Boolean
    getSkipInitialSpace()
    A boolean atomic property that, if `true`, sets the trim flag to "start".
    Long
    getSkipRows()
    An numeric atomic property that sets the `skip rows` flag to the single provided numeric value, which MUST be a non-negative integer.
    String
    getTrim()
    An atomic property that, if the boolean `true`, sets the trim flag to `true` and if the boolean `false` to `false`.
    Boolean
    isDoubleQuote()
    A boolean atomic property that, if `true`, sets the escape character flag to `"`.

  • Method Details

    • getCommentPrefix

      String getCommentPrefix()
      An atomic property that sets the comment prefix flag to the single provided value, which MUST be a string.

    • getDelimiter

      String getDelimiter()
      An atomic property that sets the delimiter flag to the single provided value, which MUST be a string.

    • isDoubleQuote

      Boolean isDoubleQuote()
      A boolean atomic property that, if `true`, sets the escape character flag to `"`.

    • getEncoding

      String getEncoding()
      An atomic property that sets the encoding flag to the single provided string value, which MUST be a defined in [encoding]. The default is "utf-8".

    • getHeader

      Boolean getHeader()
      A boolean atomic property that, if `true`, sets the header row count flag to `1`, and if `false` to `0`, unless headerRowCount is provided, in which case the value provided for the header property is ignored.

    • getHeaderRowCount

      Long getHeaderRowCount()
      An numeric atomic property that sets the header row count flag to the single provided value, which must be a non-negative integer.

    • getLineTerminators

      String getLineTerminators()
      An atomic property that sets the line terminators flag to either an array containing the single provided string value, or the provided array.

    • getQuoteChar

      String getQuoteChar()
      An atomic property that sets the quote character flag to the single provided value, which must be a string or `null`.

    • getSkipBlankRows

      Boolean getSkipBlankRows()
      An boolean atomic property that sets the `skip blank rows` flag to the single provided boolean value.

    • getSkipColumns

      Long getSkipColumns()
      An numeric atomic property that sets the `skip columns` flag to the single provided numeric value, which MUST be a non-negative integer.

    • getSkipInitialSpace

      Boolean getSkipInitialSpace()
      A boolean atomic property that, if `true`, sets the trim flag to "start". If `false`, to `false`.

    • getSkipRows

      Long getSkipRows()
      An numeric atomic property that sets the `skip rows` flag to the single provided numeric value, which MUST be a non-negative integer.

    • getTrim

      String getTrim()
      An atomic property that, if the boolean `true`, sets the trim flag to `true` and if the boolean `false` to `false`. If the value provided is a string, sets the trim flag to the provided value, which must be one of "true", "false", "start" or "end". rdfs:range xsd:boolean rdfs:domain csvw:Dialect Holy cow... so let's just assume the literal strings "true"/"false" represent the corresponding boolean value and thus the range is string. Otherwise we'd either have to result to Object or use a BooleanOrString class.

    • getQuoteEscapeChar

      String getQuoteEscapeChar()
      Extension: Quote escape char

    • copyInto

      default void copyInto(DialectMutable dest, boolean copyNulls)

    • getLineTerminatorList

      default List<String> getLineTerminatorList()
      Attempts to parse the line terminators as a json array and return an array of the strings. If parsing fails then a single item with original string value is returned.