com.github.tkurz.sparqlmm.doc.FunctionSet Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sparql-mm Show documentation
Show all versions of sparql-mm Show documentation
SPARQL-MM is a multimedia-extension for SPARQL 1.1 (www.w3.org/TR/sparql11-query/) implemented for Sesame (http://www.openrdf.org/).
package com.github.tkurz.sparqlmm.doc;
import com.github.tkurz.sparqlmm.Constants;
import com.github.tkurz.sparqlmm.vocabularies.SCHEMA;
import com.google.common.base.Joiner;
import com.google.common.collect.FluentIterable;
import com.google.common.io.Files;
import org.openrdf.model.Model;
import org.openrdf.model.URI;
import org.openrdf.model.ValueFactory;
import org.openrdf.model.impl.LinkedHashModel;
import org.openrdf.model.impl.ValueFactoryImpl;
import org.openrdf.model.vocabulary.RDF;
import org.openrdf.rio.RDFFormat;
import org.openrdf.rio.RDFHandlerException;
import org.openrdf.rio.Rio;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.Writer;
import java.nio.charset.Charset;
import java.util.*;
/**
* ...
*
* Author: Thomas Kurz ([email protected])
*/
public class FunctionSet {
private static Logger logger = LoggerFactory.getLogger(FunctionSet.class);
public static String URL = Constants.NAMESPACE.substring(0, Constants.NAMESPACE.length()-1);
public static String TITLE = "SPARQL-MM Function Library for Media Fragments";
public static String DESCRIPTION = "SPARQL Function Library for handling Media Fragments URI like they are recommended from W3C at http://www.w3.org/TR/media-frags/ Media Fragments URI 1.0 (basic) recommendation.";
public static String CREATOR = "http://github.com/tkurz";
public static String PUBLISHER = "http://mico-project.eu";
public static String LICENSE = "http://www.apache.org/licenses/LICENSE-2.0";
public static String HOMEPAGE = "http://github.com/tkurz/sparql-mm";
public static String LINK_TURTLE = "index.ttl";
public static String LINK_XML = "index.rdf";
public static String STYLE_URL = "style.css";
private List functions = new ArrayList<>();
private Model model = new LinkedHashModel();
public FunctionSet(List functionNames) throws IOException, ClassNotFoundException, InstantiationException, IllegalAccessException {
for(String functionName : functionNames) {
functions.add(new Function(functionName));
}
Collections.sort(functions, new Comparator() {
@Override
public int compare(Function o1, Function o2) {
return o1.title.compareTo(o2.title);
}
});
//build sesame model
ValueFactory f = ValueFactoryImpl.getInstance();
URI vocabulary = f.createURI(URL);
model.add(vocabulary, RDF.TYPE, ValueFactoryImpl.getInstance().createURI("http://purl.org/net/schemas/sparql-extension-description#FunctionLibrary"));
model.add(vocabulary, SCHEMA.name, f.createLiteral(TITLE));
model.add(vocabulary, SCHEMA.description, f.createLiteral(DESCRIPTION));
model.add(vocabulary, SCHEMA.version, f.createLiteral(Constants.VERSION));
model.add(vocabulary, SCHEMA.creator, f.createURI(CREATOR));
model.add(vocabulary, SCHEMA.provider, f.createURI(PUBLISHER));
model.add(vocabulary, f.createURI(SCHEMA.NAMESPACE + "license"), f.createURI(LICENSE));
model.add(vocabulary, SCHEMA.url, f.createURI(HOMEPAGE));
for(Function function: functions) {
model.add(function.uri, RDF.TYPE, function.type);
model.add(function.uri, SCHEMA.name, f.createLiteral(function.title));
model.add(function.uri, SCHEMA.description, f.createLiteral(function.description));
model.add(function.uri, ValueFactoryImpl.getInstance().createURI("http://purl.org/net/schemas/sparql-extension-description#includedIn"), vocabulary);
model.add(vocabulary, ValueFactoryImpl.getInstance().createURI("http://purl.org/net/schemas/sparql-extension-description#includes"), function.uri);
}
}
public void toRDF(File file, RDFFormat format) throws RDFHandlerException, IOException {
Writer writer = Files.newWriter(file, Charset.forName("UTF-8"));
Rio.write(model, writer, format);
writer.flush();
writer.close();
}
public void toMD(File file) throws IOException {
PrintWriter out = new PrintWriter(file);
out.printf("# %s%n", TITLE);
out.println();
out.println("The URI for this vocabulary is");
out.println();
out.println("```");
out.println(Constants.NAMESPACE);
out.println("```");
out.println();
out.printf("When abbreviating terms the suggested prefix is `%s`%n", Constants.ABBREVIATION);
out.println();
out.println("Each function in this function set has a URI constructed by appending a term name to the vocabulary URI. For example:");
out.println();
out.println("```");
out.println(functions.get(0).uri.stringValue());
out.println("```");
out.println();
out.print("There are machine readable function description using [SPARQL Extension Description Vocabulary](http://www.ldodds.com/schemas/sparql-extension-description/) in ");
out.printf("[RDF/XML](%s) and [TURTLE](%s).%n", LINK_XML, LINK_TURTLE);
out.println();
for(FunctionDoc.Reference reference : FunctionDoc.Reference.values()) {
for(FunctionDoc.Type type : FunctionDoc.Type.values()) {
boolean show = false;
//test if it should be displayed
for (Function function : functions) {
if (function.reference == reference && function.typeName.equals(type.getName()) && function.type.equals(type.getUri())) {
show = true; break;
}
}
if(!show) continue;
out.printf("## %s %ss", reference.getName(), type.getName());
out.println();
out.println("| Relation name | Description |");
out.println("| :------------ |:------------|");
for(Function function: functions) {
if(function.reference == reference && function.typeName.equals(type.getName()) && function.type.equals(type.getUri())) out.printf("| %s:%s( %s ) | %s |%n", Constants.ABBREVIATION, function.uri.stringValue().substring(Constants.NAMESPACE.length()), function.getPropertyString(", ","*","*"), function.description);
}
out.println();
}
}
out.flush();
out.close();
}
public void toLatex(File file) throws IOException {
PrintWriter out = new PrintWriter(file);
out.printf("The id number follow the scheme described in D4.2.1-SPEC (Table 3)");
out.println("The base URI for the SPARQL-MM vocabulary is");
out.print("\\texttt{");
out.print(Constants.NAMESPACE);
out.println("}.");
out.printf("When abbreviating terms the suggested prefix is \\texttt{%s}.%n", Constants.ABBREVIATION);
out.println("Each function in this function set has a URI constructed by appending a term name to the vocabulary URI. For example:");
out.print("\\texttt{");
out.print(functions.get(0).uri.stringValue());
out.println("}.");
out.print("There are machine readable function description using \\textit{SPARQL Extension Description Vocabulary}\\footurl{http://www.ldodds.com/schemas/sparql-extension-description/} e.g. in ");
out.printf("RDF/XML\\footurl{https://raw.githubusercontent.com/tkurz/sparql-mm/master/ns/1.0.0/function/%s}.%n", LINK_XML);
out.println("%");
for(FunctionDoc.Reference reference : FunctionDoc.Reference.values()) {
for (FunctionDoc.Type type : FunctionDoc.Type.values()) {
boolean show = false;
//test if it should be displayed
for (Function function : functions) {
if (function.reference == reference && function.typeName.equals(type.getName()) && function.type.equals(type.getUri())) {
show = true; break;
}
}
if(!show) continue;
out.printf("\\subsubsection*{%s %ss}\n", reference.getName(), type.getName());
for (Function function : functions) {
if (function.reference == reference && function.typeName.equals(type.getName()) && function.type.equals(type.getUri())) {
out.println("\\begin{tabular}{|p{3cm}|p{10cm}|}");
out.printf("\\hline Name & %s:%s\\\\\n\\hline Properties & %s \\\\\n\\hline Description & %s\\\\\n\\hline\n", Constants.ABBREVIATION, function.uri.stringValue().substring(Constants.NAMESPACE.length()), function.getPropertyString(", ", "\\textit{", "}"), function.description);
out.println("\\end{tabular}");
out.println("\\vspace{0.3cm}");
out.println("\\newline");
}
}
}
}
out.flush();
out.close();
}
public void toHTML(File file) throws IOException {
PrintWriter out = new PrintWriter(file);
out.printf("\n", STYLE_URL);
out.printf("%s
%n", TITLE);
out.println();
out.println("");
out.printf("The URI for this vocabulary is %s. ", Constants.NAMESPACE);
out.printf("When abbreviating terms the suggested prefix is %s. ", Constants.ABBREVIATION);
out.printf("Each function in this function set has a URI constructed by appending a term name to the vocabulary URI. For example %s. ", functions.get(0).uri.stringValue());
out.print("There are machine readable function description using SPARQL Extension Description Vocabulary] in ");
out.printf("RDF/XML and TURTLE.", LINK_XML, LINK_TURTLE);
out.println("
");
for(FunctionDoc.Reference reference : FunctionDoc.Reference.values()) {
for (FunctionDoc.Type type : FunctionDoc.Type.values()) {
boolean show = false;
//test if it should be displayed
for (Function function : functions) {
if (function.reference == reference && function.typeName.equals(type.getName()) && function.type.equals(type.getUri())) {
show = true; break;
}
}
if(!show) continue;
out.printf("%s %ss
", reference.getName(), type.getName());
out.println("");
out.println("Relation name Description ");
for (Function function : functions) {
if (function.reference == reference && function.typeName.equals(type.getName()) && function.type.equals(type.getUri()))
out.printf("%s:%s( %s ) %s \n", Constants.ABBREVIATION, function.uri.stringValue().substring(Constants.NAMESPACE.length()), function.getPropertyString(", ","",""), function.description);
}
out.println("
");
}
}
out.flush();
out.close();
}
class Function {
String title, description;
URI type;
String typeName;
URI uri;
FunctionDoc.Reference reference;
Class[] properties;
public Function(String className) throws ClassNotFoundException, IOException, IllegalAccessException, InstantiationException {
Class clazz = Class.forName(className);
if(clazz.getAnnotation(FunctionDoc.class) == null) throw new IOException("Class " + className + " is not properly annotated for documentation.");
FunctionDoc doc = (FunctionDoc) clazz.getAnnotation(FunctionDoc.class);
org.openrdf.query.algebra.evaluation.function.Function function = (org.openrdf.query.algebra.evaluation.function.Function) clazz.newInstance();
title = doc.title();
description = doc.description();
type = doc.type().getUri();
uri = ValueFactoryImpl.getInstance().createURI(function.getURI());
typeName = doc.type().getName();
reference = doc.reference();
properties = doc.properties();
logger.debug("read doc for {}: uri:{}, title:{}, description:{}", className, uri.stringValue(), title, description);
}
public String getPropertyString(String join, final String wrapStart, final String wrapEnd) {
return Joiner.on(join).join(FluentIterable.from(Arrays.asList(properties)).transform(new com.google.common.base.Function() {
@Override
public String apply(Class aClass) {
return wrapStart + aClass.getSimpleName() + wrapEnd;
}
}));
}
}
}