Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/* This file is part of the OWL API.
* The contents of this file are subject to the LGPL License, Version 3.0.
* Copyright 2014, The University of Manchester
*
* This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
* You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
*
* Alternatively, the contents of this file may be used under the terms of the Apache License, Version 2.0 in which case, the provisions of the Apache License Version 2.0 are applicable instead of those above.
* 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. */
package org.semanticweb.owlapi.rdf.rdfxml.parser;
import static org.semanticweb.owlapi.rdf.rdfxml.parser.RDFConstants.RDF_OBJECT;
import static org.semanticweb.owlapi.rdf.rdfxml.parser.RDFConstants.RDF_PREDICATE;
import static org.semanticweb.owlapi.rdf.rdfxml.parser.RDFConstants.RDF_STATEMENT;
import static org.semanticweb.owlapi.rdf.rdfxml.parser.RDFConstants.RDF_SUBJECT;
import static org.semanticweb.owlapi.rdf.rdfxml.parser.RDFConstants.RDF_TYPE;
import static org.semanticweb.owlapi.rdf.rdfxml.parser.RDFConstants.XMLLANG;
import static org.semanticweb.owlapi.rdf.rdfxml.parser.RDFConstants.XMLNS;
import static org.semanticweb.owlapi.util.OWLAPIPreconditions.checkNotNull;
import static org.semanticweb.owlapi.util.OWLAPIPreconditions.verifyNotNull;
import java.io.IOException;
import java.io.StreamTokenizer;
import java.io.StringReader;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.semanticweb.owlapi.model.IRI;
import org.semanticweb.owlapi.model.NodeID;
import org.semanticweb.owlapi.util.SAXParsers;
import org.xml.sax.Attributes;
import org.xml.sax.ErrorHandler;
import org.xml.sax.InputSource;
import org.xml.sax.Locator;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
import org.xml.sax.ext.DeclHandler;
import org.xml.sax.helpers.DefaultHandler;
import org.xml.sax.helpers.LocatorImpl;
/**
* This class parses the RDF according to the syntax specified in
* http://www.w3.org/TR/rdf-
* syntax-grammar/.
*/
public class RDFParser extends DefaultHandler implements IRIProvider {
private static final String WRONGRESOLVE =
"IRI '%s' cannot be resolved against current base IRI %s reason is: %s";
@Nonnull
protected static final Locator nullDocumentLocator = new LocatorImpl();
private final Map resolvedIRIs = new HashMap<>();
protected final Map uriCache = new HashMap<>();
/** Registered error handler. */
protected ErrorHandler errorHandler = new ErrorHandler() {
@Override
public void warning(SAXParseException exception) {}
@Override
public void fatalError(SAXParseException exception) throws SAXException {
throw exception;
}
@Override
public void error(SAXParseException exception) {}
};
/** Stack of base IRIs. */
protected final LinkedList baseIRIs = new LinkedList<>();
private final Map baseURICache = new HashMap<>();
/** IRI of the document being parsed. */
protected IRI baseIRI;
/** The stack of languages. */
@Nonnull
protected final LinkedList languages = new LinkedList<>();
/** The current language. */
protected String language;
/** Consumer receiving notifications about parsing events. */
protected RDFConsumer consumer;
/** Current parser's state. */
protected State state;
/** Stack of parser states. */
protected final List states = new ArrayList<>();
/** Document locator. */
protected Locator documentLocator;
@Nonnull
protected IRI getBaseIRI() {
return verifyNotNull(baseIRI, "base IRI has not been set yet");
}
@Nonnull
protected Locator getDocumentLocator() {
if (documentLocator != null) {
return verifyNotNull(documentLocator);
}
return nullDocumentLocator;
}
/**
* Parses RDF from given input source.
*
* @param source specifies where RDF comes from
* @param inputConsumer receives notifications about RDF parsing events
* @throws SAXException SAX exception
* @throws IOException if there was a problem parsing the output stream
*/
public void parse(@Nonnull InputSource source, @Nonnull RDFConsumer inputConsumer)
throws SAXException, IOException {
InputSource s = checkNotNull(source, "source cannot be null");
checkNotNull(inputConsumer, "consumer cannot be null");
String systemID = s.getSystemId();
try {
if (systemID != null) {
baseIRI = IRI.create(new URI(source.getSystemId()));
} else {
throw new SAXException(
"Supplied InputSource object myst have systemId property set, which is needed for IRI resolution.");
}
consumer = inputConsumer;
inputConsumer.startModel(getBaseIRI());
DeclHandler handler = new DeclHandler() {
@Override
public void internalEntityDecl(String name, String value) {
consumer.addPrefix(name, value);
}
@Override
public void externalEntityDecl(String name, String publicId, String systemId) {}
@Override
public void elementDecl(String name, String model) {}
@Override
public void attributeDecl(String eName, String aName, String type, String mode,
String value) {}
};
SAXParsers.initParserWithOWLAPIStandards(handler,
inputConsumer.getConfiguration().getEntityExpansionLimit()).parse(source, this);
inputConsumer.endModel();
} catch (URISyntaxException e) {
throw new SAXException(
"Invalid SystemID '" + systemID + "'of the supplied input source.", e);
} finally {
state = null;
states.clear();
baseIRIs.clear();
}
}
@Override
public void setDocumentLocator(Locator locator) {
documentLocator = checkNotNull(locator, "locator cannot be null");
}
/**
* Sets the error handler.
*
* @param errorHandler the error handler
*/
public void setErrorHandler(@Nonnull ErrorHandler errorHandler) {
this.errorHandler = checkNotNull(errorHandler, "errorHandler cannot be null");
}
@Override
public void warning(SAXParseException e) throws SAXException {
errorHandler.warning(e);
}
@Override
public void error(SAXParseException e) throws SAXException {
errorHandler.error(e);
}
@Override
public void fatalError(SAXParseException e) throws SAXException {
errorHandler.fatalError(e);
}
@Override
public void startDocument() {
states.clear();
pushState(new StartRDF(this));
}
@Override
public void endDocument() {
verify(state != null, "RDF content not finished.");
}
@Override
public void startElement(String uri, String localName, String qName, Attributes attributes)
throws SAXException {
processXMLBase(attributes);
processXMLLanguage(attributes);
state.startElement(uri, localName, qName, attributes);
}
@Override
public void endElement(String uri, String localName, String qName) throws SAXException {
state.endElement(uri, localName, qName);
baseIRI = baseIRIs.remove(0);
language = languages.remove(0);
}
@Override
public void characters(char[] ch, int start, int length) throws SAXException {
state.characters(ch, start, length);
}
@Override
public void processingInstruction(String target, String data) {
if ("include-rdf".equals(target)) {
Map arguments = parseStringArguments(data);
verify(arguments.size() > 2,
"Incorrect number of arguments for 'include-rdf' processing instruction.");
String logicalIRI = arguments.get("logicalIRI");
String physicalIRI = arguments.get("physicalIRI");
if (physicalIRI != null) {
physicalIRI = resolveIRI(physicalIRI);
}
consumer.includeModel(logicalIRI, physicalIRI);
}
}
/**
* Pushes a new state on the state stack.
*
* @param s new state
*/
public void pushState(State s) {
states.add(s);
state = s;
}
/**
* Pops a state from the stack.
*/
public void popState() {
int size = states.size();
verify(size == 0, "Internal exception: state stack is empty.");
if (size == 1) {
state = null;
} else {
state = states.get(size - 2);
}
states.remove(size - 1);
}
@Nonnull
private IRI resolveFromDelegate(@Nonnull IRI iri, @Nonnull String value) {
checkNotNull(iri, "iri cannot be null");
checkNotNull(value, "value cannot be null");
if (NodeID.isAnonymousNodeIRI(value)) {
return IRI.create(value, null);
}
// cache the delegate URI if not there already
if (!baseURICache.containsKey(getBaseIRI())) {
baseURICache.put(getBaseIRI(), getBaseIRI().toURI());
}
// get hold of the delegate URI
URI delegateURI = baseURICache.get(getBaseIRI());
assert delegateURI != null;
// resolve against delegate
URI resolve = delegateURI.resolve(value.replace(" ", "%20"));
assert resolve != null;
return IRI.create(resolve);
}
/**
* Processes xml:base reference if there is one.
*
* @param atts the attributes potentially containing xml:base declaration
*/
private void processXMLBase(@Nonnull Attributes atts) {
checkNotNull(atts, "atts cannot be null");
baseIRIs.add(0, getBaseIRI());
String value = atts.getValue(XMLNS, "base");
if (value != null) {
try {
baseIRI = resolveFromDelegate(getBaseIRI(), value);
resolvedIRIs.clear();
} catch (IllegalArgumentException e) {
throw new RDFParserException(e,
String.format(WRONGRESOLVE, value, getBaseIRI(), e.getMessage()),
getDocumentLocator());
}
}
}
/**
* Processes xml:language reference is there is one.
*
* @param atts the attributes potentially containing xml:language declaration
*/
private void processXMLLanguage(@Nonnull Attributes atts) {
checkNotNull(atts, "atts cannot be null");
languages.add(0, language);
String value = atts.getValue(XMLLANG);
if (value != null) {
language = value;
}
}
/**
* Resolves an IRI with the current base.
*
* @param iri the IRI being resolved
* @return the resolved IRI
*/
@Nonnull
public String resolveIRI(@Nonnull String iri) {
checkNotNull(iri, "uri cannot be null");
if (iri.isEmpty()) {
// MH - Fix for resolving a "This document" reference against base
// IRIs.
String namespace = getBaseIRI().getNamespace();
if (namespace.charAt(namespace.length() - 1) == '#') {
return namespace.substring(0, namespace.length() - 1);
}
String base = getBaseIRI().toString();
int hashIndex = base.indexOf('#');
if (hashIndex != -1) {
return base.substring(0, hashIndex);
} else {
return base;
}
} else {
try {
String resolved = resolvedIRIs.get(iri);
if (resolved != null) {
return resolved;
} else {
IRI theIRI = resolveFromDelegate(getBaseIRI(), iri);
String u = theIRI.toString();
uriCache.put(u, theIRI);
resolvedIRIs.put(iri, u);
return u;
}
} catch (IllegalArgumentException e) {
throw new RDFParserException(e,
String.format(WRONGRESOLVE, iri, getBaseIRI(), e.getMessage()),
getDocumentLocator());
}
}
}
/**
* Called when a statement with resource value is added to the model.
*
* @param subject IRI of the subject resource
* @param predicate IRI of the predicate resource
* @param object IRI of the object resource
* @param reificationID if not {@code null}, contains IRI of the resource that will hold the
* reified statement
*/
public void statementWithResourceValue(@Nonnull String subject, @Nonnull String predicate,
@Nonnull String object, @Nullable String reificationID) {
String remappedSubject = consumer.remapOnlyIfRemapped(subject);
consumer.statementWithResourceValue(remappedSubject, predicate, object);
if (reificationID != null) {
consumer.statementWithResourceValue(reificationID, RDF_TYPE, RDF_STATEMENT);
consumer.statementWithResourceValue(reificationID, RDF_SUBJECT, remappedSubject);
consumer.statementWithResourceValue(reificationID, RDF_PREDICATE, predicate);
consumer.statementWithResourceValue(reificationID, RDF_OBJECT, object);
}
}
/**
* Called when a statement with literal value is added to the model.
*
* @param subject IRI of the subject resource
* @param predicate IRI of the predicate resource
* @param object literal object value
* @param dataType the IRI of the literal's datatype (may be {@code null})
* @param reificationID if not {@code null}, contains IRI of the resource that will hold the
* reified statement
*/
public void statementWithLiteralValue(@Nonnull String subject, @Nonnull String predicate,
@Nonnull String object, @Nullable String dataType, @Nullable String reificationID) {
consumer.statementWithLiteralValue(subject, predicate, object, language, dataType);
if (reificationID != null) {
consumer.statementWithResourceValue(reificationID, RDF_TYPE, RDF_STATEMENT);
consumer.statementWithResourceValue(reificationID, RDF_SUBJECT, subject);
consumer.statementWithResourceValue(reificationID, RDF_PREDICATE, predicate);
consumer.statementWithLiteralValue(reificationID, RDF_OBJECT, object, language,
dataType);
}
}
/**
* Parses the string into a map of name-value pairs.
*
* @param string string to be parsed
* @return map of name-value pairs
*/
private Map parseStringArguments(String string) {
try {
StreamTokenizer tokenizer = new StreamTokenizer(new StringReader(string));
Map result = new HashMap<>();
tokenizer.nextToken();
while (tokenizer.ttype != StreamTokenizer.TT_EOF) {
verify(tokenizer.ttype != StreamTokenizer.TT_WORD,
"Invalid processing instruction argument.");
String name = tokenizer.sval;
verify('=' != tokenizer.nextToken(), "Expecting token '='");
tokenizer.nextToken();
verify(tokenizer.ttype != '\"' && tokenizer.ttype != '\'',
"Invalid processing instruction argument.");
String value = tokenizer.sval;
result.put(name, value);
tokenizer.nextToken();
}
return result;
} catch (IOException e) {
throw new RDFParserException(e, "I/O error", getDocumentLocator());
}
}
@Override
@Nonnull
public IRI getIRI(@Nonnull String s) {
return uriCache.get(checkNotNull(s, "s cannot be null"));
}
/**
* If condition b is true, throw an exception with provided message
*
* @param b condition to verify
* @param message message for the exception
* @throws RDFParserException exception thrown
*/
public void verify(boolean b, @Nonnull String message) {
if (b) {
throw new RDFParserException(message, getDocumentLocator());
}
}
}
