SPARQL Studio

Appearance

SPARQL Studio API / SparqlResults / Parser

Class: Parser ​

Defined in: sparql-results/src/parsers/index.ts:10

Parser class for handling query responses from various formats.

This class processes responses from SPARQL endpoints and converts them into standardized formats for further processing. It can handle JSON, XML, CSV, TSV, and Turtle responses, detecting the format either from content-type headers or by attempting to parse the content.

The parser can process:

  • Direct QueryResponse objects (regular fetch response with additional content property with the awaited response content)
  • ResponseSummary objects
  • Error objects
  • Raw response data

It provides methods to access parsed data in standardized formats, error information, and utilities to convert the data for storage or export.

Constructors ​

Constructor ​

new Parser(responseOrObject, executionTime?): Parser

Defined in: sparql-results/src/parsers/index.ts:90

Parameters ​

responseOrObject ​

any

executionTime? ​

number

Returns ​

Parser

Methods ​

setResponse() ​

setResponse(res): void

Defined in: sparql-results/src/parsers/index.ts:101

Parameters ​

res ​

QueryResponse

Returns ​

void

setSummary() ​

setSummary(summary): void

Defined in: sparql-results/src/parsers/index.ts:104

Parameters ​

summary ​

any

Returns ​

void

hasError() ​

hasError(): boolean

Defined in: sparql-results/src/parsers/index.ts:115

Returns ​

boolean

getError() ​

getError(): ErrorSummary | undefined

Defined in: sparql-results/src/parsers/index.ts:122

Returns ​

ErrorSummary | undefined

getContentType() ​

getContentType(): string | undefined

Defined in: sparql-results/src/parsers/index.ts:142

Returns ​

string | undefined

getAsJson() ​

getAsJson(): false | SparqlResults | undefined

Defined in: sparql-results/src/parsers/index.ts:147

Returns ​

false | SparqlResults | undefined

getResponseTime() ​

getResponseTime(): number | undefined

Defined in: sparql-results/src/parsers/index.ts:164

Returns ​

number | undefined

getVariables() ​

getVariables(): string[]

Defined in: sparql-results/src/parsers/index.ts:229

Returns ​

string[]

getBoolean() ​

getBoolean(): boolean | undefined

Defined in: sparql-results/src/parsers/index.ts:237

Returns ​

boolean | undefined

getBindings() ​

getBindings(): Binding[] | null

Defined in: sparql-results/src/parsers/index.ts:242

Returns ​

Binding[] | null

getStatements() ​

getStatements(): Quad[] | null

Defined in: sparql-results/src/parsers/index.ts:248

Returns ​

Quad[] | null

getOriginalResponseAsString() ​

getOriginalResponseAsString(): string

Defined in: sparql-results/src/parsers/index.ts:255

Returns ​

string

getType() ​

getType(): "json" | "xml" | "csv" | "tsv" | "ttl" | undefined

Defined in: sparql-results/src/parsers/index.ts:265

Returns ​

"json" | "xml" | "csv" | "tsv" | "ttl" | undefined

getStatus() ​

getStatus(): number | undefined

Defined in: sparql-results/src/parsers/index.ts:269

Returns ​

number | undefined

getAsStoreObject() ​

getAsStoreObject(maxResponseSize): ResponseSummary | undefined

Defined in: sparql-results/src/parsers/index.ts:277

Parameters ​

maxResponseSize ​

number

Returns ​

ResponseSummary | undefined

asCsv() ​

asCsv(): string | undefined

Defined in: sparql-results/src/parsers/index.ts:303

Returns ​

string | undefined