fr.lirmm.graphik.graal.io.sparql.AbstractSparqlWriter Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) Inria Sophia Antipolis - Méditerranée / LIRMM
 * (Université de Montpellier & CNRS) (2014 - 2016)
 *
 * Contributors :
 *
 * Clément SIPIETER 
 * Mélanie KÖNIG
 * Swan ROCHER
 * Jean-François BAGET
 * Michel LECLÈRE
 * Marie-Laure MUGNIER 
 *
 *
 * This file is part of Graal .
 *
 * This software is governed by the CeCILL  license under French law and
 * abiding by the rules of distribution of free software.  You can  use,
 * modify and/ or redistribute the software under the terms of the CeCILL
 * license as circulated by CEA, CNRS and INRIA at the following URL
 * "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the
 * same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL license and that you accept its terms.
 */
package fr.lirmm.graphik.graal.io.sparql;

import java.io.IOException;
import java.io.Writer;

import fr.lirmm.graphik.graal.GraalConstant;
import fr.lirmm.graphik.graal.api.core.Atom;
import fr.lirmm.graphik.graal.api.core.Predicate;
import fr.lirmm.graphik.graal.api.core.Term;
import fr.lirmm.graphik.graal.api.io.AbstractWriter;
import fr.lirmm.graphik.graal.api.io.WriterException;
import fr.lirmm.graphik.util.Prefix;
import fr.lirmm.graphik.util.PrefixManager;
import fr.lirmm.graphik.util.URI;
import fr.lirmm.graphik.util.URIUtils;

/**
 * @author Clément Sipieter (INRIA) {@literal }
 *
 */
public class AbstractSparqlWriter extends AbstractWriter {

	private PrefixManager pm;

	// /////////////////////////////////////////////////////////////////////////
	// CONSTRUCTORS
	// /////////////////////////////////////////////////////////////////////////

	/**
	 * @param out
	 */
	public AbstractSparqlWriter(Writer out) {
		super(out);
		this.pm = new PrefixManager();
	}

	// /////////////////////////////////////////////////////////////////////////
	// PUBLIC METHODS
	// /////////////////////////////////////////////////////////////////////////

	public AbstractSparqlWriter write(Prefix prefix) throws IOException {
		this.pm.putPrefix(prefix);
		this.write("PREFIX ");
		this.write(prefix.getPrefixName());
		this.write(": <");
		this.write(prefix.getPrefix());
		this.writeln('>');

		return this;
	}

	public AbstractSparqlWriter writeComment(String comment) throws IOException {
		this.write("# ");
		this.writeln(comment);

		return this;
	}

	@Override
	public void write(char c) throws IOException {
		super.write(c);
	}

	@Override
	public void write(String str) throws IOException {
		super.write(str);
	}

	// /////////////////////////////////////////////////////////////////////////
	// PROTECTED METHODS
	// /////////////////////////////////////////////////////////////////////////

	protected void writeURI(URI uri) throws IOException {
		Prefix prefix = this.pm.getPrefixByValue(uri.getPrefix());
		if (prefix == null) {
			this.write('<');
			this.write(uri.toString());
			this.write('>');
		} else {
			this.write(prefix.getPrefixName() + ":" + uri.getLocalname());
		}
	}

	/**
	 * @param a
	 * @throws IOException
	 */
	protected void writeAtom(Atom a) throws IOException {
		this.write("\t");
		this.write(a.getTerm(0));
		this.write(' ');

		if (a.getPredicate().getArity() == 1) {
			this.write("a ");
			this.write(a.getPredicate());
		} else if (a.getPredicate().getArity() == 2) {
			this.write(a.getPredicate());
			this.write(' ');
			this.write(a.getTerm(1));
		} else {
			throw new WriterException("Unsupported predicate arity");
		}
	}

	/**
	 * @param predicate
	 * @throws IOException
	 */
	protected void write(Predicate predicate) throws IOException {
		this.writeIdentifier(predicate.getIdentifier());
	}

	protected void writeIdentifier(Object identifier) throws IOException {

		if (!(identifier instanceof URI)) {
			identifier = URIUtils.createURI(GraalConstant.INTERNAL_PREFIX, identifier.toString());
		}
		this.writeURI((URI) identifier);
	}

	/**
	 * @param t
	 * @throws IOException
	 */
	protected void write(Term t) throws IOException {
		if (Term.Type.VARIABLE.equals(t.getType())) {
			this.write('?');
			this.writeSimpleIdentifier(t.getIdentifier().toString());
		} else {
			this.writeIdentifier(t.getIdentifier());
		}
		this.write(' ');
	}

	protected void writeSimpleIdentifier(String identifier) throws IOException {
		char first = identifier.charAt(0);
		identifier = identifier.replaceAll("[^a-zA-Z0-9_]", "_");
		this.write(identifier);
	}

}