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.renderer;
import static org.semanticweb.owlapi.util.OWLAPIPreconditions.checkNotNull;
import static org.semanticweb.owlapi.util.OWLAPIPreconditions.verifyNotNull;
import static org.semanticweb.owlapi.vocab.OWLRDFVocabulary.BUILT_IN_VOCABULARY_IRIS;
import static org.semanticweb.owlapi.vocab.OWLRDFVocabulary.RDFS_LABEL;
import static org.semanticweb.owlapi.vocab.OWLRDFVocabulary.RDFS_LITERAL;
import static org.semanticweb.owlapi.vocab.OWLRDFVocabulary.RDF_DESCRIPTION;
import static org.semanticweb.owlapi.vocab.OWLRDFVocabulary.RDF_TYPE;
import java.io.IOException;
import java.io.Writer;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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.OWLDataFactory;
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.model.OWLOntologyManager;
import org.semanticweb.owlapi.rdf.RDFRendererBase;
import org.semanticweb.owlapi.util.AnnotationValueShortFormProvider;
import org.semanticweb.owlapi.util.ShortFormProvider;
import org.semanticweb.owlapi.util.VersionInfo;
import org.semanticweb.owlapi.vocab.OWL2Datatype;
/**
* @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 RDFXMLNamespaceManager qnameManager;
@Nonnull
private final OWLDocumentFormat format;
ShortFormProvider labelMaker;
private boolean explicitXsdString;
/**
* @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");
explicitXsdString = Boolean
.parseBoolean(format.getParameter("force xsd:string on literals", Boolean.FALSE).toString());
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));
Map> prefLangMap = new HashMap<>();
OWLOntologyManager manager = ontology.getOWLOntologyManager();
OWLDataFactory df = manager.getOWLDataFactory();
OWLAnnotationProperty labelProp = df.getOWLAnnotationProperty(RDFS_LABEL.getIRI());
labelMaker = new AnnotationValueShortFormProvider(Collections.singletonList(labelProp),
prefLangMap, manager);
}
@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;
}
@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 {
writeCommentForEntity("ind", ind);
}
@Override
protected void writeClassComment(@Nonnull OWLClass cls) throws IOException {
writeCommentForEntity("cls", cls);
}
@Override
protected void writeDataPropertyComment(@Nonnull OWLDataProperty prop) throws IOException {
writeCommentForEntity("prop", prop);
}
@Override
protected void writeObjectPropertyComment(@Nonnull OWLObjectProperty prop) throws IOException {
writeCommentForEntity("prop", prop);
}
@Override
protected void writeAnnotationPropertyComment(@Nonnull OWLAnnotationProperty prop)
throws IOException {
writeCommentForEntity("prop", prop);
}
@Override
protected void writeDatatypeComment(@Nonnull OWLDatatype datatype) throws IOException {
writeCommentForEntity("datatype", datatype);
}
private void writeCommentForEntity(String msg, OWLEntity entity) throws IOException {
if (XMLWriterPreferences.getInstance().isBannersEnabled()) {
checkNotNull(entity, msg + " cannot be null");
String iriString = entity.getIRI().toString();
if (XMLWriterPreferences.getInstance().isLabelsAsBanner()) {
String labelString = labelMaker.getShortForm(entity);
String commentString = null;
if (!iriString.equals(labelString)) {
commentString = labelString;
} else {
commentString = iriString;
}
writer.writeComment(XMLUtils.escapeXML(commentString));
} else {
writer.writeComment(XMLUtils.escapeXML(iriString));
}
}
}
@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, boolean root) throws IOException {
checkNotNull(node, "node cannot be null");
if (pending.contains(node)) {
return;
}
pending.add(node);
RDFTriple candidatePrettyPrintTypeTriple = null;
Collection triples = graph.getTriplesForSubject(node);
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());
} else if (node.idRequired()) {
writer.writeNodeIDAttribute((RDFResourceBlankNode) 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 list = new ArrayList<>();
toJavaList(objectRes, list);
for (RDFNode n : list) {
renderList(n);
}
} else if (objectRes.equals(node)) {
// special case for triples with same object and subject
writer.writeNodeIDAttribute((RDFResourceBlankNode) objectRes);
} else {
renderObject(objectRes);
}
} else {
writer.writeResourceAttribute(objectRes.getIRI());
}
} else {
writew((RDFLiteral) objectNode);
}
writer.writeEndElement();
}
writer.writeEndElement();
if (root) {
deferredRendering();
}
pending.remove(node);
}
protected void renderList(RDFNode n) throws IOException {
if (n.isAnonymous()) {
render((RDFResourceBlankNode) n, false);
} else {
if (n.isLiteral()) {
write((RDFLiteral) n);
} else {
writer.writeStartElement(RDF_DESCRIPTION.getIRI());
writer.writeAboutAttribute(n.getIRI());
writer.writeEndElement();
}
}
}
protected void renderObject(RDFResource object) throws IOException {
if (object.idRequired()) {
if (!pending.contains(object)) {
defer(object);
}
writer.writeNodeIDAttribute((RDFResourceBlankNode) object);
} else {
render(object, false);
}
}
protected void writew(RDFLiteral rdfLiteralNode) throws IOException {
if (rdfLiteralNode.hasLang()) {
writer.writeLangAttribute(rdfLiteralNode.getLang());
} else if (!rdfLiteralNode.isPlainLiteral() && (explicitXsdString
|| !OWL2Datatype.XSD_STRING.getIRI().equals(rdfLiteralNode.getDatatype()))) {
writer.writeDatatypeAttribute(rdfLiteralNode.getDatatype());
}
writer.writeTextContent(rdfLiteralNode.getLexicalValue());
}
protected void write(RDFLiteral litNode) throws IOException {
writer.writeStartElement(RDFS_LITERAL.getIRI());
writew(litNode);
writer.writeEndElement();
}
/**
* @return unserializable entities
*/
@Nonnull
public Set getUnserialisableEntities() {
return qnameManager.getEntitiesWithInvalidQNames();
}
}
