Class Csvw2RdfConvertor

Privateinput

Privatelocation

PrivatenumberParser

Privateoptions

PrivateoutputStream

Privateused

Private StaticdefaultWKs

Private StaticnormalizeWsTypes

PrivatecolumnTitlesToNames

• columnTitlesToNames(defaultLang: string, ctx: TableContext): void

  Parameters

  • defaultLang: string
  • ctx: TableContext

  Returns void

PrivateconvertInner

• convertInner(): Promise<void>

  Returns Promise<void>

PrivateconvertRowCell

• convertRowCell(
      defaultSubj: BlankNode,
      rowNode: BlankNode,
      colNum: number,
      rowsOffset: number,
      colsOffset: number,
      ctx: TableContext,
  ): void

  Converts a cell of the current row to RDF.

  Parameters

  • defaultSubj: BlankNode

    Default subject
  • rowNode: BlankNode

    The row node
  • colNum: number

    The column number.
  • rowsOffset: number

    The offset of the rows.
  • colsOffset: number

    The offset of the columns.
  • ctx: TableContext

  Returns void

PrivateconvertTable

• convertTable(ctx: TableContext): Promise<NamedNode<string> | BlankNode>

  Converts a table to RDF.

  Parameters

  • ctx: TableContext

  Returns Promise<NamedNode<string> | BlankNode>

PrivateconvertTableRow

• convertTableRow(
      rowNum: number,
      rowsOffset: number,
      ctx: TableContext,
  ): BlankNode

  Converts table row to RDF by row number.

  Parameters

  • rowNum: number

    The row number.
  • rowsOffset: number

    The offset of the rows.
  • ctx: TableContext

  Returns BlankNode

PrivateconvertTableRowValues

• convertTableRowValues(
      rowNode: BlankNode,
      rowsOffset: number,
      ctx: TableContext,
  ): void

  Converts the values of a table row to RDF.

  Parameters

  • rowNode: BlankNode
  • rowsOffset: number
  • ctx: TableContext

  Returns void

PrivatecreateNode

• createNode(input: { "@id"?: string }): NamedNode<string> | BlankNode

  Creates a named node or a blank node based on the input.

  Parameters

  • input: { "@id"?: string }

    Input object

  Returns NamedNode<string> | BlankNode

PrivatecreateOutputStream

• createOutputStream(): Readable

  Returns Readable

PrivatecreateRDFList

• createRDFList(values: (NamedNode<string> | Literal)[]): BlankNode

  Creates an RDF list https://ontola.io/blog/ordered-data-in-rdf based on rules provided at https://w3c.github.io/csvw/csv2rdf/#json-ld-to-rdf.

  Parameters

  • values: (NamedNode<string> | Literal)[]

    Values of the list

  Returns BlankNode

  The head of the rdf list

PrivatedatatypeToLiteral

• datatypeToLiteral(value: string, dtUri: string, lang?: string): Literal

  Convert string value to RDF literal based on the datatype URI.

  Parameters

  • value: string

    string value to be converted
  • dtUri: string

    datatype URI
  • Optionallang: string

    language tag

  Returns Literal

  RDF literal

PrivateemitExternalProps

• emitExternalProps(
      object: { notes?: unknown },
      node: NamedNode<string> | BlankNode,
  ): void

  Parameters

  • object: { notes?: unknown }
  • node: NamedNode<string> | BlankNode

  Returns void

PrivateemitTriple

• emitTriple(
      first: NamedNode<string> | BlankNode,
      second: NamedNode,
      third: NamedNode<string> | BlankNode | Literal,
  ): void

  Emits a triple to the output stream.

  Parameters

  • first: NamedNode<string> | BlankNode
  • second: NamedNode
  • third: NamedNode<string> | BlankNode | Literal

  Returns void

PrivategetSrcRowsOffset

• getSrcRowsOffset(ctx: TableContext): number

  Parameters

  • ctx: TableContext

  Returns number

PrivategetValueLength

• getValueLength(value: string, dtUri: string): number

  Parameters

  • value: string
  • dtUri: string

  Returns number

PrivategetWellKnownUris

• getWellKnownUris(url: string): Promise<Template[]>

  Retrieves URI templates from well-known URI file.

  Parameters

  • url: string

    /.well-known/csvm is resolved relative to this url

  Returns Promise<Template[]>

  URI templates of metadata locations

PrivateheaderRowToTitles

• headerRowToTitles(
      vals: string[],
      defaultLang: string,
      firstRow: boolean,
      ctx: TableContext,
  ): void

  Parameters

  • vals: string[]
  • defaultLang: string
  • firstRow: boolean
  • ctx: TableContext

  Returns void

PrivateinterpretDatatype

• interpretDatatype(
      value: string,
      dtUri: string,
      dt: CsvwDatatype,
      ctx: TableContext,
  ): null | string | string[]

  Inteprets the datatype of a value based on the current column description.

  Parameters

  • value: string

    string value to be interpreted
  • dtUri: string
  • dt: CsvwDatatype
  • ctx: TableContext

  Returns null | string | string[]

  Correctly built RDF literal

PrivateisValueNull

• isValueNull(value: string, ctx: TableContext): boolean

  Check if value should be considered null based on the current column description.

  Parameters

  • value: string

    string value to be checked
  • ctx: TableContext

  Returns boolean

  true if the value is null, false otherwise

PrivatenormalizeDatatype

• normalizeDatatype(ctx: TableContext): [string, CsvwDatatype]

  Get expanded datatype URI and description for the current column.

  Parameters

  • ctx: TableContext

  Returns [string, CsvwDatatype]

  [datatype URI, datatype description]

PrivatenormalizeValue

• normalizeValue(
      value: string,
      dtype: string,
      ctx: TableContext,
  ): null | string | string[]

  Handle whitespace normalization for the given value and datatype.

  Parameters

  • value: string

    string value to be normalized
  • dtype: string

    datatype URI
  • ctx: TableContext

  Returns null | string | string[]

  normalized value

PrivateprepareTemplates

• prepareTemplates(ctx: TableContext): void

  Prepares URI templates for the conversion.

  Parameters

  • ctx: TableContext

  Returns void

PrivateprocessCsvHeader

• processCsvHeader(
      stream: AsyncIterator<string[]>,
      ctx: TableContext,
  ): Promise<undefined | string[]>

  Processes the header of a CSV file and its embedded metadata.

  Parameters

  • stream: AsyncIterator<string[]>

    Input stream
  • ctx: TableContext

  Returns Promise<undefined | string[]>

  The first row of the current table if there is no header and there are no columns defined in the table schema. This row is used to determine the column count and must be passed to the Csvw2RdfConvertor#convertTableRow method.

PrivateprocessMicrosyntax

• processMicrosyntax(
      defaultLang: string,
      headerRowCount: number,
      physicalColCount: undefined | number,
      stream: AsyncIterator<string[]>,
      ctx: TableContext,
  ): Promise<undefined | string[]>

  Processes the microsyntax of the CSV file. This currently includes only column titles.

  Parameters

  • defaultLang: string

    default language of the csv file
  • headerRowCount: number

    number of header rows
  • physicalColCount: undefined | number

    number of nonvirtual columns defined in the table schema or undefined if the table schema has no columns defined
  • stream: AsyncIterator<string[]>

    CSV stream
  • ctx: TableContext

  Returns Promise<undefined | string[]>

PrivatereformatBoolean

• reformatBoolean(value: string, dt: CsvwDatatype): string

  Parameters

  • value: string
  • dt: CsvwDatatype

  Returns string

PrivatereformatDate

• reformatDate(value: string, dtUri: string, dt: CsvwDatatype): string

  Parameters

  • value: string
  • dtUri: string
  • dt: CsvwDatatype

  Returns string

PrivatereformatValue

• reformatValue(
      value: string,
      dtUri: string,
      dt: CsvwDatatype,
      ctx: TableContext,
  ): null | string

  Reformat string value into a valid string representation of the datatype.

  Parameters

  • value: string

    string value to be converted
  • dtUri: string

    datatype URI
  • dt: CsvwDatatype

    datatype description
  • ctx: TableContext

  Returns null | string

  the reformatted value

PrivateresolveMetadata

• resolveMetadata(csvUrl: string): Promise<[DescriptorWrapper, string]>

  Locates metadata for tabular data, see https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#locating-metadata for more information.

  Parameters

  • csvUrl: string

    CSV file url

  Returns Promise<[DescriptorWrapper, string]>

  URL of metadata file for the given CSV file

PrivatesetDefaults

• setDefaults(options?: Csvw2RdfOptions): Required<Csvw2RdfOptions>

  Sets default values to options if no value is provided.

  Parameters

  • Optionaloptions: Csvw2RdfOptions

  Returns Required<Csvw2RdfOptions>

  Corrected options

PrivatetemplateUri

• templateUri(
      template: Template,
      srcCol: number,
      srcRow: number,
      baseIri: string,
      ctx: TableContext,
  ): NamedNode

  Expands a template URI.

  Parameters

  • template: Template

    Template to be expanded
  • srcCol: number

    Source column number (Csvw2RdfConvertor#location column + CsvwDialectDescription#skipColumns)
  • srcRow: number

    Source row number (Csvw2RdfConvertor#location row + CsvwDialectDescription#headerRowCount + CsvwDialectDescription#skipRows)
  • baseIri: string

    Base IRI
  • ctx: TableContext

  Returns NamedNode

  Expanded URI node

PrivatevalidateDateMinMax

• validateDateMinMax(value: Date, dtUri: string, dt: CsvwDatatype): boolean

  Parameters

  • value: Date
  • dtUri: string
  • dt: CsvwDatatype

  Returns boolean

PrivatevalidateDuplicateColumns

• validateDuplicateColumns(columns: CsvwColumnDescription[]): void

  Parameters

  • columns: CsvwColumnDescription[]

  Returns void

PrivatevalidateValueLength

• validateValueLength(value: string, dtUri: string, dt: CsvwDatatype): boolean

  Parameters

  • value: string
  • dtUri: string
  • dt: CsvwDatatype

  Returns boolean

PrivateverifyMetadataUrl

• verifyMetadataUrl(
      url: string,
      csvUrl: string,
  ): Promise<null | [DescriptorWrapper, string]>

  Verify that the metadata URL is valid and contains a table description that matches the CSV file.

  Parameters

  • url: string

    url to the descriptor
  • csvUrl: string

    url to the CSV file

  Returns Promise<null | [DescriptorWrapper, string]>

  either descriptor and url or null if the descriptor is not valid