package api

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. trait ClientAPIProtocol extends AnyRef

    Client API Protocol, all concrete API requests use this

  2. abstract class ClientHttpRequest extends Request

    Represents any request sent to the Sparql endpoint via HTTP, which may include Sparql statements or graph-store protocol operations.

  3. abstract class ClientHttpResponse extends Response
  4. case class ClientMappedQuery[T <: SparqlResult](mapper: ResultMapper[T]) extends MappedQuery[T] with Product with Serializable

    Client-provided result mapper.

  5. case class DropGraph(graphIri: Option[IRI], context: Option[Any] = None) extends GraphStoreRequest with Product with Serializable

    Represents an operation to drop a single graph via the graph-store protocol.

    Represents an operation to drop a single graph via the graph-store protocol.

    graphIri

    the graph IRI to drop, if not specified this denotes the DEFAULT graph

    See also

    https://www.w3.org/TR/2013/REC-sparql11-http-rdf-update-20130321/#http-delete

  6. abstract class ErrorHandler extends AnyRef
  7. trait ErrorHandlerSupport extends AnyRef
  8. case class GetGraph(graphIri: Option[IRI], context: Option[Any] = None) extends GraphStoreRequest with Product with Serializable

    Represents the operation to retrieve a single graph via the graph-store protocol.

    Represents the operation to retrieve a single graph via the graph-store protocol.

    graphIri

    the graph IRI to get, if not specified this denotes the DEFAULT graph

    See also

    https://www.w3.org/TR/2013/REC-sparql11-http-rdf-update-20130321/#http-get

  9. trait GraphStoreProtocol extends ClientAPIProtocol

    Implementation of the graph-store API messages.

  10. abstract class GraphStoreRequest extends ClientHttpRequest with GraphStoreProtocol
  11. case class GraphStoreResponse(request: GraphStoreRequest, success: Boolean, statusCode: Int, statusText: String, model: Option[Model] = None) extends ClientHttpResponse with GraphStoreProtocol with Product with Serializable

    The response entity for graph store operations.

    The response entity for graph store operations.

    request

    the request object

    success

    true if the operation was successful

    statusCode

    the HTTP status code of the response

    statusText

    the HTTP status reason text

    model

    the response RDF graph (model) if available

  12. abstract class InsertGraph extends GraphStoreRequest

    Represents an operation to insert graph(s) via the graph-store protocol.

    Represents an operation to insert graph(s) via the graph-store protocol.

    See also

    https://www.w3.org/TR/2013/REC-sparql11-http-rdf-update-20130321/#http-post

    https://www.w3.org/TR/2013/REC-sparql11-http-rdf-update-20130321/#http-put

  13. case class InsertGraphFromModel(graphModel: Model, graphIri: Option[IRI] = None, mergeGraphs: Boolean = false, context: Option[Any] = None) extends InsertGraph with Product with Serializable

    Used to insert an in-memory RDF model into the triple store.

    Used to insert an in-memory RDF model into the triple store.

    graphModel

    the graph model

    graphIri

    optional graph IRI, defaults to None

    mergeGraphs

    indicates if the inserted data should be merged data already in the specified graph in the database, if set to false the previously stored data in the graph will be replaced with the payload, defaults to false

    context

    an optional context to be carried along the flow

  14. case class InsertGraphFromPath(path: Path, modelFormat: RDFFormat, graphIri: Option[IRI] = None, mergeGraphs: Boolean = false, context: Option[Any] = None) extends InsertGraph with Product with Serializable

    Used to insert RDF contents from a file or another resource into the triple store.

    Used to insert RDF contents from a file or another resource into the triple store.

    path

    the local filesystem path of the file to use

    modelFormat

    the RDF format to use, supporting all formats available in org.eclipse.rdf4j.rio.Rio

    graphIri

    an optional graph IRI, will insert into the default graph if no graph is specified. NB: if the incoming RDF is in "quads" format, i.e. NQUADS or JSON-LD, the graph in the RDF is ignored and instead the graphIri property is used.

    mergeGraphs

    indicates if the inserted data should be merged data already in the specified graph in the database, if set to false the previously stored data in the graph will be replaced with the payload, defaults to false

    context

    an optional context to be carried along the flow

  15. case class InsertGraphFromURL(url: URL, modelFormat: RDFFormat, graphIri: Option[IRI] = None, mergeGraphs: Boolean = false, context: Option[Any] = None) extends InsertGraph with Product with Serializable

    Used to insert RDF contents from a file or another resource into the triple store.

    Used to insert RDF contents from a file or another resource into the triple store.

    url

    the URL of the file to use

    modelFormat

    the RDF format to use, supporting all formats available in org.eclipse.rdf4j.rio.Rio

    graphIri

    an optional graph IRI, will insert into the default graph if no graph is specified. NB: if the incoming RDF is in "quads" format, i.e. NQUADS or JSON-LD, the graph in the RDF is ignored and instead the graphIri property is used.

    mergeGraphs

    indicates if the inserted data should be merged data already in the specified graph in the database, if set to false the previously stored data in the graph will be replaced with the payload, defaults to false

    context

    an optional context to be carried along the flow

  16. trait MappedQuery[T <: SparqlResult] extends QueryType
  17. abstract class PagingParams extends AnyRef
  18. case class PingResponse(success: Boolean = true) extends ClientHttpResponse with SparqlClientProtocol with Product with Serializable

    "Is-Alive" response

  19. class PrefixMapping extends AnyRef

    Inspired by Jena's PrefixMappingImpl class, this class does more or les the same.

    Inspired by Jena's PrefixMappingImpl class, this class does more or les the same.

    See http://svn.apache.org/repos/asf/jena/trunk/jena-core/src/main/java/com/hp/hpl/jena/shared/impl/PrefixMappingImpl.java

  20. case class QueryPaging(offset: Option[Long], limit: Option[Long]) extends PagingParams with Product with Serializable
  21. case class QuerySolution(values: Map[String, QuerySolutionValue]) extends Product with Serializable

    The default query solution, used to unmarshal the 'application/sparql-results+json' server response.

  22. case class QuerySolutionValue(type: String, datatype: Option[String] = None, value: String = null) extends Product with Serializable
  23. trait QueryType extends AnyRef
  24. trait Request extends ClientAPIProtocol

    Request

  25. trait Response extends ClientAPIProtocol

    Response

  26. trait ResultMapper[T <: SparqlResult] extends SolutionMapper[T]
  27. case class ResultSet(head: ResultSetVars, results: ResultSetResults) extends SparqlResult with Product with Serializable
  28. case class ResultSetResults(bindings: List[QuerySolution]) extends Product with Serializable
  29. case class ResultSetVars(vars: List[String]) extends Product with Serializable
  30. sealed trait SparqlClientError extends AnyRef

    Error messages

  31. trait SparqlClientProtocol extends ClientAPIProtocol
  32. case class SparqlClientRequestFailed(message: String) extends RuntimeException with SparqlClientError with Product with Serializable
  33. case class SparqlClientRequestFailedWithError(message: String, throwable: Throwable) extends RuntimeException with SparqlClientError with Product with Serializable
  34. abstract class SparqlConstruct extends SparqlStatement
  35. trait SparqlConstructFactory extends AnyRef
  36. case class SparqlErrorResult(error: Throwable, code: Int, message: String) extends SparqlResult with Product with Serializable

    Error result

  37. case class SparqlModelResult(model: Model) extends SparqlResult with Product with Serializable

    A result representing an RDF Model

    A result representing an RDF Model

    model

    the RDF model

  38. case class SparqlQuery(query: String, httpMethod: HttpMethod = HttpMethods.GET, queryType: QueryType = DefaultMappedQuery, bindings: Map[String, Value] = Map.empty, defaultGraphs: List[IRI] = Nil, namedGraphs: List[IRI] = Nil, limit: Option[Long] = None, offset: Option[Long] = None, reasoning: Option[Boolean] = None, timeout: Option[Long] = None)(implicit _pm: PrefixMapping) extends SparqlStatement with Product with Serializable

    SPARQL Query to be executed, supports both mapped and streaming queries.

    SPARQL Query to be executed, supports both mapped and streaming queries.

    The streaming option also allows for full akka-streams integration support with the knowledge graph, which is useful for large results (e.g. reports)

    query

    the query to be executed

    queryType

    the type of query, defaults to DefaultMappedQuery

    bindings

    the request bindings

    defaultGraphs

    the default graphs passed as query parameters (correspond to FROM <graph> SPARQL statement)

    namedGraphs

    the named graphs passed as query parameters (correspont to FROM NAMED <graph> SPARQL statement)

    limit

    an optional limit to be passed as a query parameter

    offset

    an optional offset to be passed as a query parameter

    reasoning

    an optional reasoning flag to be passed as a query parameter

    timeout

    an optional per-query specific timeout to be passed as as query parameter

  39. case class SparqlRequest(statement: SparqlStatement, context: Option[Any] = None) extends ClientHttpRequest with SparqlClientProtocol with Product with Serializable

    Represents a single Sparql request to be sent to the triple store.

    Represents a single Sparql request to be sent to the triple store.

    statement

    the sparql statement string, any | margins will be stripped automatically

    context

    an optional context to be carried along the flow

  40. case class SparqlResponse(request: SparqlRequest, success: Boolean = true, status: StatusCode = StatusCodes.OK, result: List[SparqlResult] = Nil, error: Option[SparqlClientError] = None) extends ClientHttpResponse with SparqlClientProtocol with Product with Serializable

    Represents a response from the triple store for a Sparql request.

    Represents a response from the triple store for a Sparql request.

    request

    the underlying request object is returned with the response

    success

    true if the sparql statement execution succeeded

    status

    the HTTP status of the result

    result

    results

    error

    optional error message, if available

  41. trait SparqlResult extends AnyRef
  42. abstract class SparqlStatement extends ClientHttpRequest

    SparqlStatement is the interface representing all SPARQL statements.

    SparqlStatement is the interface representing all SPARQL statements. Create a subclass of SparqlStatement for each and every statement that you send to the SparqlClient.

    By the way, this also goes for some non SPARQL statements such as some Graph API statements

  43. abstract class SparqlUpdate extends SparqlStatement
  44. case class StreamedQuery(desiredContentType: ContentType = `application/sparql-results+json`) extends QueryType with Product with Serializable

    For queries that return a streamed source of the triple stores response directly, which is suitable for large batch jobs and long lasting operations.

  45. case class StreamingSparqlResult(dataStream: Source[ByteString, Any], contentType: Option[ContentType]) extends SparqlResult with Product with Serializable
  46. case class SystemExitErrorHandler(exitCode: Int) extends ErrorHandler with Product with Serializable

Value Members

  1. object DefaultErrorHandler extends ErrorHandler
  2. object DefaultMappedQuery extends MappedQuery[ResultSet] with Product with Serializable

    Default Mapped Query, mapping to ResultSet object.

  3. object DropGraphM
  4. object GetGraphM
  5. object IgnoreAndLogErrorHandler extends ErrorHandler
  6. object InsertGraphFromModelM
  7. object InsertGraphFromPathM
  8. object InsertGraphFromURLM
  9. object NamespaceConstants

    Defines the most generic namespaces as constants

  10. object NoPaging extends PagingParams with Product with Serializable
  11. object PagingParams
  12. object PingRequest extends Request with Product with Serializable

    "Is-Alive" request

  13. object PrefixMapping
  14. object ResultSetMapper extends ResultMapper[ResultSet]
  15. object SparqlConstruct extends SparqlConstructFactory
  16. object SparqlFilterConstruct extends SparqlConstructFactory
  17. object SparqlSearchConstruct extends SparqlConstructFactory
  18. object SparqlUpdate

Ungrouped