Raptor RDF Syntax Library Manual

Dave Beckett

http://www.dajobe.org/

Manual for Raptor 2.0.0

Copyright © 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Dave Beckett

Copyright © 2001, 2002, 2003, 2004, 2005 University of Bristol

This documentation is Free Software / Open Source - you can redistribute it and/or modify it under the same licenses as Raptor. It is licensed under the following three licenses as alternatives:

GNU Lesser General Public License (LGPL) V2.1 or any newer version
GNU General Public License (GPL) V2 or any newer version
Apache License, V2.0 or any newer version

You may not use this documentation except in compliance with at least one of the above three licenses. See the Raptor site for the full license terms.

Raptor Overview

I. Raptor Tutorial

Initialising and Finishing using the Library

Listing built-in functionality

Parsing syntaxes to RDF Triples

Introduction

Create the Parser object

Parser options

Set RDF statement callback handler

Set parsing log message handlers

Set the identifier creator handler

Set namespace declared handler

Set the parsing strictness

Provide syntax content to parse

Parse the content from a URI (raptor_parser_parse_uri())
Parse the content of a URI using an existing WWW connection (raptor_parser_parse_uri_with_connection())
Parse the content of a C FILE* (raptor_parser_parse_file_stream())
Parse the content of a file URI (raptor_parser_parse_file())
Parse chunks of syntax content provided by the application (raptor_parser_parse_start() and raptor_parser_parse_chunk())

Restrict parser network access

Filtering parser network requests with option RAPTOR_OPTION_NO_NET
Filtering parser network requests with raptor_www_set_uri_filter()
Filtering parser network requests with raptor_parser_set_uri_filter()
Setting timeout for parser network requests with option RAPTOR_OPTION_WWW_TIMEOUT

Querying parser static information

Querying parser run-time information

Aborting parsing

Destroy the parser

Parsing example code

Serializing RDF triples to a syntax

Introduction

Create the Serializer object

Serializer options

Declare namespaces

Set error and warning handlers

Provide a destination for the serialized syntax

Serialize to a filename (raptor_serializer_start_to_filename())
Serialize to a string (raptor_serializer_start_to_string())
Serialize to a FILE* file handle (raptor_serializer_start_to_file_handle())
Serialize to an raptor_iostream (raptor_serializer_start_to_iostream())

Get or construct RDF Statements (Triples)

Send RDF Triples to serializer

Querying serializer run-time information

Destroy the serializer

Serializing example code

II. Raptor Reference Manual

Parsers in Raptor (syntax to triples)

Introduction
GRDDL parser (name grddl)
Guess parser (name guess)
JSON parser (name json)
N-Triples parser (name ntriples)
RDFa parser - (name rdfa)
RDF/XML parser - default (name rdfxml)
RSS Tag Soup parser (name rss-tag-soup)
TRiG parser (name trig)
Turtle Terse RDF Triple Language parser (name turtle)

Serializers in Raptor (triples to syntax)

Introduction
Atom 1.0 serializer (name atom)
JSON serializers (name json and name json-triples)
N-Quads serializer - default (name nquads)
N-Triples serializer - default (name ntriples)
RDF/XML serializer (name rdfxml)
RDF/XML (Abbreviated) serializer (name rdfxml-abbrev)
RDF/XML (XMP Profile) serializer (name rdfxml-xmp)
Turtle serializer (name turtle)
RSS 1.0 serializer (name rss-1.0)
GraphViz dot serializer (name dot)

Initialisation — Library startup, shutdown and configuration.

General — General library constants and utility functions

Memory — Memory handling functions

AVL Trees — AVL Trees

Constants — Constant values and strings

Options — Class options

I/O Stream — Providing streaming I/O writing to files, strings or user code.

Locator — Location information for errors, warnings and messages.

Parser — RDF parsers - from a syntax to RDF triples

SAX2 — SAX2 XML Parsing API with namespaces and base URI support.

Sequence — Ordered sequence of items.

Serializer — RDF serializers - from RDF triples to a syntax

String buffer — Append-only strings.

Triples — RDF Triples

Unicode — Unicode and UTF-8 utility functions.

URI — URI class and relative URI computation

WWW — Retrieval of URI content from the web.

XML Namespaces — Namespaces in XML include stacks of Namespaces

XML QName — XML Namespace-qualified names.

XML — XML and XML Writer

Syntax Formats supported in Raptor

Introduction
MIME Types by Parser
MIME Types by Serializer
MIME Types Index

API Changes

Introduction
New functions, types and enums in raptor2 2.0.0
Deleted functions, types and enums in raptor2 2.0.0
Renamed function and enums in raptor2 2.0.0
Changed functions and types in raptor2 2.0.0