N3.js 技术文档

1. 安装指南

Node.js 安装

N3.js 可以通过 npm 包管理器进行安装。在终端中运行以下命令：

npm install n3

安装完成后，可以通过以下方式引入 N3.js：

const N3 = require('n3');

浏览器安装

N3.js 可以通过 webpack 或 browserify 在浏览器中使用。如果你不熟悉这些工具，可以参考以下文档：

• webpack: Creating a Bundle – getting started
• Introduction to browserify

你还可以通过 CDN 加载 N3.js：

<script src="https://unpkg.com/n3/browser/n3.min.js"></script>

2. 项目使用说明

创建 triples/quads

N3.js 遵循 RDF.js 低级规范，提供了 N3.DataFactory 来创建 triples 和 quads。

const { DataFactory } = N3;
const { namedNode, literal, defaultGraph, quad } = DataFactory;

const myQuad = quad(
  namedNode('https://ruben.verborgh.org/profile/#me'), // Subject
  namedNode('http://xmlns.com/foaf/0.1/givenName'),    // Predicate
  literal('Ruben', 'en'),                              // Object
  defaultGraph(),                                      // Graph
);

console.log(myQuad.termType);              // Quad
console.log(myQuad.value);                 // ''
console.log(myQuad.subject.value);         // https://ruben.verborgh.org/profile/#me
console.log(myQuad.object.value);          // Ruben
console.log(myQuad.object.datatype.value); // http://www.w3.org/1999/02/22-rdf-syntax-ns#langString
console.log(myQuad.object.language);       // en

解析

从 RDF 文档解析为 quads

N3.Parser 可以将 Turtle、TriG、N-Triples 或 N-Quads 文档解析为 quads。

const tomAndJerry = `PREFIX c: <http://example.org/cartoons#>
  # Tom is a cat
  c:Tom a c:Cat.
  c:Jerry a c:Mouse;
    c:smarterThan c:Tom.`

const parser = new N3.Parser();

parser.parse(tomAndJerry, (error, quad, prefixes) => {
  if (quad)
    console.log(quad);
  else
    console.log("# That's all, folks!", prefixes);
});

从 RDF 流解析为 quads

N3.Parser 还可以解析 Node.js 流，返回 quads 数据。

const parser = new N3.Parser(),
      rdfStream = fs.createReadStream('cartoons.ttl');
parser.parse(rdfStream, console.log);

写入

从 quads 写入为字符串

N3.Writer 可以将 quads 序列化为 RDF 文档。

const writer = new N3.Writer({ prefixes: { c: 'http://example.org/cartoons#' } });
writer.addQuad(quad(
  namedNode('http://example.org/cartoons#Tom'),   // Subject
  namedNode('http://example.org/cartoons#name'),  // Predicate
  literal('Tom')                                  // Object
));
writer.end((error, result) => console.log(result));

从 quads 写入为 RDF 流

N3.Writer 还可以将 quads 写入 Node.js 流。

const writer = new N3.Writer(process.stdout, { end: false, prefixes: { c: 'http://example.org/cartoons#' } });
writer.addQuad(
  namedNode('http://example.org/cartoons#Tom'),                   // Subject
  namedNode('http://www.w3.org/1999/02/22-rdf-syntax-ns#type'),   // Predicate
  namedNode('http://example.org/cartoons#Cat')                    // Object
);
writer.addQuad(quad(
  namedNode('http://example.org/cartoons#Tom'),     // Subject
  namedNode('http://example.org/cartoons#name'),  // Predicate
  literal('Tom')                                    // Object
));
writer.end();

3. 项目 API 使用文档

N3.DataFactory

N3.DataFactory 提供了创建 triples 和 quads 的工厂函数。

N3.Parser

N3.Parser 用于解析 RDF 文档或流，返回 quads 数据。

N3.Writer

N3.Writer 用于将 quads 序列化为 RDF 文档或流。

N3.StreamParser

N3.StreamParser 是一个 Node.js 流和 RDF.js Sink 实现，用于流式解析 RDF 数据。

N3.StreamWriter

N3.StreamWriter 是一个 Node.js 流和 RDF.js Sink 实现，用于流式写入 RDF 数据。

4. 项目安装方式

Node.js 安装

通过 npm 安装：

npm install n3

浏览器安装

通过 webpack 或 browserify 打包，或通过 CDN 加载。