/* 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.renderer;
import static org.semanticweb.owlapi.util.OWLAPIPreconditions.*;
import static org.semanticweb.owlapi.vocab.OWLRDFVocabulary.*;
import java.io.IOException;
import java.io.Writer;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import javax.annotation.Nonnull;
import org.semanticweb.owlapi.io.RDFLiteral;
import org.semanticweb.owlapi.io.RDFNode;
import org.semanticweb.owlapi.io.RDFResource;
import org.semanticweb.owlapi.io.RDFResourceBlankNode;
import org.semanticweb.owlapi.io.RDFTriple;
import org.semanticweb.owlapi.io.XMLUtils;
import org.semanticweb.owlapi.model.IRI;
import org.semanticweb.owlapi.model.OWLAnnotationProperty;
import org.semanticweb.owlapi.model.OWLClass;
import org.semanticweb.owlapi.model.OWLDataProperty;
import org.semanticweb.owlapi.model.OWLDatatype;
import org.semanticweb.owlapi.model.OWLDocumentFormat;
import org.semanticweb.owlapi.model.OWLEntity;
import org.semanticweb.owlapi.model.OWLNamedIndividual;
import org.semanticweb.owlapi.model.OWLObjectProperty;
import org.semanticweb.owlapi.model.OWLOntology;
import org.semanticweb.owlapi.rdf.RDFRendererBase;
import org.semanticweb.owlapi.util.VersionInfo;
/**
* @author Matthew Horridge, The University Of Manchester, Bio-Health
* Informatics Group
* @since 2.0.0
*/
public class RDFXMLRenderer extends RDFRendererBase {
private final RDFXMLWriter writer;
@Nonnull
private final Set<RDFResource> pending = new HashSet<>();
@Nonnull
private final RDFXMLNamespaceManager qnameManager;
@Nonnull
private final OWLDocumentFormat format;
/**
* @param ontology
* ontology
* @param w
* writer
*/
public RDFXMLRenderer(@Nonnull OWLOntology ontology, @Nonnull Writer w) {
this(checkNotNull(ontology, "ontology cannot be null"), checkNotNull(w,
"w cannot be null"), verifyNotNull(ontology
.getOWLOntologyManager().getOntologyFormat(ontology)));
}
/**
* @param ontology
* ontology
* @param w
* writer
* @param format
* format
*/
public RDFXMLRenderer(@Nonnull OWLOntology ontology, @Nonnull Writer w,
@Nonnull OWLDocumentFormat format) {
super(checkNotNull(ontology, "ontology cannot be null"), checkNotNull(
format, "format cannot be null"));
this.format = checkNotNull(format, "format cannot be null");
qnameManager = new RDFXMLNamespaceManager(ontology, format);
String defaultNamespace = qnameManager.getDefaultNamespace();
String base = base(defaultNamespace);
writer = new RDFXMLWriter(XMLWriterFactory.createXMLWriter(
checkNotNull(w, "w cannot be null"), qnameManager, base));
}
@SuppressWarnings("null")
@Nonnull
private static String base(@Nonnull String defaultNamespace) {
String base;
if (defaultNamespace.endsWith("#")) {
base = defaultNamespace.substring(0, defaultNamespace.length() - 1);
} else {
base = defaultNamespace;
}
return base;
}
/** @return unserializable entities */
@Nonnull
public Set<OWLEntity> getUnserialisableEntities() {
return qnameManager.getEntitiesWithInvalidQNames();
}
@Override
protected void beginDocument() throws IOException {
writer.startDocument();
}
@Override
protected void endDocument() throws IOException {
writer.endDocument();
writer.writeComment(VersionInfo.getVersionInfo()
.getGeneratedByMessage());
if (!format.isAddMissingTypes()) {
// missing type declarations could have been omitted, adding a
// comment to document it
writer.writeComment("Warning: type declarations were not added automatically.");
}
}
@Override
protected void writeIndividualComments(@Nonnull OWLNamedIndividual ind)
throws IOException {
writer.writeComment(XMLUtils.escapeXML(checkNotNull(ind,
"ind cannot be null").getIRI().toString()));
}
@Override
protected void writeClassComment(@Nonnull OWLClass cls) throws IOException {
writer.writeComment(XMLUtils.escapeXML(checkNotNull(cls,
"cls cannot be null").getIRI().toString()));
}
@Override
protected void writeDataPropertyComment(@Nonnull OWLDataProperty prop)
throws IOException {
writer.writeComment(XMLUtils.escapeXML(checkNotNull(prop,
"prop cannot be null").getIRI().toString()));
}
@Override
protected void writeObjectPropertyComment(@Nonnull OWLObjectProperty prop)
throws IOException {
writer.writeComment(XMLUtils.escapeXML(checkNotNull(prop,
"prop cannot be null").getIRI().toString()));
}
@Override
protected void writeAnnotationPropertyComment(
@Nonnull OWLAnnotationProperty prop) throws IOException {
writer.writeComment(XMLUtils.escapeXML(checkNotNull(prop,
"prop cannot be null").getIRI().toString()));
}
@Override
protected void writeDatatypeComment(@Nonnull OWLDatatype datatype)
throws IOException {
writer.writeComment(XMLUtils.escapeXML(checkNotNull(datatype,
"datatype cannot be null").getIRI().toString()));
}
@Override
protected void writeBanner(@Nonnull String name) throws IOException {
writer.writeComment("\n///////////////////////////////////////////////////////////////////////////////////////\n//\n// "
+ checkNotNull(name, "name cannot be null")
+ "\n//\n///////////////////////////////////////////////////////////////////////////////////////\n");
}
@Override
public void render(@Nonnull RDFResource node) throws IOException {
checkNotNull(node, "node cannot be null");
if (pending.contains(node)) {
return;
}
pending.add(node);
RDFTriple candidatePrettyPrintTypeTriple = null;
Collection<RDFTriple> triples = graph.getTriplesForSubject(node, true);
for (RDFTriple triple : triples) {
IRI propertyIRI = triple.getPredicate().getIRI();
if (propertyIRI.equals(RDF_TYPE.getIRI())
&& !triple.getObject().isAnonymous()
&& BUILT_IN_VOCABULARY_IRIS.contains(triple.getObject()
.getIRI())
&& prettyPrintedTypes.contains(triple.getObject().getIRI())) {
candidatePrettyPrintTypeTriple = triple;
}
}
if (candidatePrettyPrintTypeTriple == null) {
writer.writeStartElement(RDF_DESCRIPTION.getIRI());
} else {
writer.writeStartElement(candidatePrettyPrintTypeTriple.getObject()
.getIRI());
}
if (!node.isAnonymous()) {
writer.writeAboutAttribute(node.getIRI());
}
// XXX this call looks like it should be made, but only when the node id
// is necessary
// else {
// writer.writeNodeIDAttribute(node);
// }
for (RDFTriple triple : triples) {
if (candidatePrettyPrintTypeTriple != null
&& candidatePrettyPrintTypeTriple.equals(triple)) {
continue;
}
writer.writeStartElement(triple.getPredicate().getIRI());
RDFNode objectNode = triple.getObject();
if (!objectNode.isLiteral()) {
RDFResource objectRes = (RDFResource) objectNode;
if (objectRes.isAnonymous()) {
// Special rendering for lists
if (isObjectList(objectRes)) {
writer.writeParseTypeAttribute();
List<RDFNode> list = new ArrayList<>();
toJavaList(objectRes, list);
for (RDFNode n : list) {
if (n.isAnonymous()) {
render((RDFResourceBlankNode) n);
} else {
if (n.isLiteral()) {
RDFLiteral litNode = (RDFLiteral) n;
writer.writeStartElement(RDFS_LITERAL
.getIRI());
if (!litNode.isPlainLiteral()) {
writer.writeDatatypeAttribute(litNode
.getDatatype());
} else if (litNode.hasLang()) {
writer.writeLangAttribute(litNode
.getLang());
}
writer.writeTextContent(litNode
.getLexicalValue());
writer.writeEndElement();
} else {
writer.writeStartElement(RDF_DESCRIPTION
.getIRI());
writer.writeAboutAttribute(n.getIRI());
writer.writeEndElement();
}
}
}
} else {
render(objectRes);
}
} else {
writer.writeResourceAttribute(objectRes.getIRI());
}
} else {
RDFLiteral rdfLiteralNode = (RDFLiteral) objectNode;
if (!rdfLiteralNode.isPlainLiteral()) {
writer.writeDatatypeAttribute(rdfLiteralNode.getDatatype());
} else if (rdfLiteralNode.hasLang()) {
writer.writeLangAttribute(rdfLiteralNode.getLang());
}
writer.writeTextContent(rdfLiteralNode.getLexicalValue());
}
writer.writeEndElement();
}
writer.writeEndElement();
pending.remove(node);
}
}