no.hasmac.rdf.io.nquad.NQuadsReader Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hasmac-json-ld Show documentation
A more performant JSON-LD 1.1 Processor & API forked from Titanium JSON-LD.
The newest version!
/*
 * Copyright 2020 APICATALOG and HASMAC.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * SPDX-License-Identifier: Apache-2.0
 */

package no.hasmac.rdf.io.nquad;

import no.hasmac.jsonld.uri.UriUtils;
import no.hasmac.rdf.Rdf;
import no.hasmac.rdf.RdfDataset;
import no.hasmac.rdf.RdfLiteral;
import no.hasmac.rdf.RdfNQuad;
import no.hasmac.rdf.RdfResource;
import no.hasmac.rdf.RdfValue;
import no.hasmac.rdf.io.RdfReader;
import no.hasmac.rdf.io.error.RdfReaderException;
import no.hasmac.rdf.io.nquad.Tokenizer.Token;
import no.hasmac.rdf.io.nquad.Tokenizer.TokenType;

import java.io.Reader;
import java.util.Arrays;

/**
 *
 * @see RDF 1.1. N-Quads
 *
 */
public final class NQuadsReader implements RdfReader {

    private final Tokenizer tokenizer;

    private RdfDataset dataset;

    public NQuadsReader(final Reader reader) {
        this.tokenizer = new Tokenizer(reader);
        this.dataset = null;
    }

    @Override
    public RdfDataset readDataset() throws RdfReaderException {

        if (dataset != null) {
            return dataset;
        }

        dataset = Rdf.createDataset();

        while (tokenizer.hasNext()) {

            // skip EOL and whitespace
            if (tokenizer.accept(Tokenizer.TokenType.END_OF_LINE)
                    || tokenizer.accept(Tokenizer.TokenType.WHITE_SPACE)
                    || tokenizer.accept(Tokenizer.TokenType.COMMENT)
                    ) {

                continue;
            }

            dataset.add(reaStatement());
        }

        return dataset;
    }

    private RdfNQuad reaStatement() throws RdfReaderException {

        RdfResource subject = readResource("Subject");

        skipWhitespace(0);

        RdfResource predicate = readResource("Predicate");

        skipWhitespace(0);

        RdfValue object = readObject();

        RdfResource graphName = null;

        skipWhitespace(0);

        if (TokenType.IRI_REF == tokenizer.token().getType()) {

            final String graphNameIri = tokenizer.token().getValue();

            assertAbsoluteIri(graphNameIri, "Graph name");

            graphName = Rdf.createIRI(graphNameIri);
            tokenizer.next();
            skipWhitespace(0);
        }

        if (TokenType.BLANK_NODE_LABEL == tokenizer.token().getType()) {

            graphName = Rdf.createBlankNode("_:".concat(tokenizer.token().getValue()));
            tokenizer.next();
            skipWhitespace(0);
        }

        if (TokenType.END_OF_STATEMENT != tokenizer.token().getType()) {
            unexpected(tokenizer.token(), TokenType.END_OF_STATEMENT);
        }

        tokenizer.next();

        skipWhitespace(0);

        // skip comment
        if (TokenType.COMMENT == tokenizer.token().getType()) {
            tokenizer.next();

        // skip end of line
        } else if (TokenType.END_OF_LINE != tokenizer.token().getType() && TokenType.END_OF_INPUT != tokenizer.token().getType()) {
            unexpected(tokenizer.token(), TokenType.END_OF_LINE, TokenType.END_OF_INPUT);
            tokenizer.next();
        }

        return Rdf.createNQuad(subject, predicate, object, graphName);
    }

    private RdfResource readResource(String name)  throws RdfReaderException {

        final Token token = tokenizer.token();

        if (TokenType.IRI_REF == token.getType()) {

            tokenizer.next();

            final String iri = token.getValue();

            assertAbsoluteIri(iri, name);

            return Rdf.createIRI(iri);
        }

        if (TokenType.BLANK_NODE_LABEL == token.getType()) {

            tokenizer.next();

            return Rdf.createBlankNode("_:".concat(token.getValue()));
        }

        return unexpected(token);
    }

    private RdfValue readObject()  throws RdfReaderException {

        Token token = tokenizer.token();

        if (TokenType.IRI_REF == token.getType()) {
            tokenizer.next();

            final String iri = token.getValue();

            assertAbsoluteIri(iri, "Object");

            return Rdf.createIRI(iri);
        }

        if (TokenType.BLANK_NODE_LABEL == token.getType()) {

            tokenizer.next();

            return Rdf.createBlankNode("_:".concat(token.getValue()));
        }

        return readLiteral();
    }

    private RdfLiteral readLiteral()  throws RdfReaderException {

        Token value = tokenizer.token();

        if (TokenType.STRING_LITERAL_QUOTE != value.getType()) {
            unexpected(value);
        }

        tokenizer.next();

        skipWhitespace(0);

        if (TokenType.LANGTAG == tokenizer.token().getType()) {

            String langTag = tokenizer.token().getValue();

            tokenizer.next();

            return Rdf.createLangString(value.getValue(), langTag);

        } else if (TokenType.LITERAL_DATA_TYPE == tokenizer.token().getType()) {

            tokenizer.next();
            skipWhitespace(0);

            Token attr = tokenizer.token();

            if (TokenType.IRI_REF == attr.getType()) {

                tokenizer.next();

                final String iri = attr.getValue();

                assertAbsoluteIri(iri, "DataType");

                return Rdf.createTypedString(value.getValue(), iri);
            }

            unexpected(attr);
        }

        return Rdf.createString(value.getValue());
    }


    private static  T unexpected(Token token, TokenType... types) throws RdfReaderException {
        throw new RdfReaderException(
                    "Unexpected token " + token.getType() + (token.getValue() != null ? "[" + token.getValue() + "]" : "" ) +  ". "
                    + "Expected one of " + Arrays.toString(types) + "."
                    );
    }

    private void skipWhitespace(int min) throws RdfReaderException {

        int count = 0;

        while (tokenizer.accept(TokenType.WHITE_SPACE)) {
            count++;
        }

        if (count < min) {
            unexpected(tokenizer.token());
        }
    }

    private static void assertAbsoluteIri(final String iri, final String what) throws RdfReaderException {
        if (UriUtils.isNotAbsoluteUri(iri, true)) {
            throw new RdfReaderException(what + " must be an absolute IRI [" + iri  +  "]. ");
        }
    }
}