io.opencaesar.owl.doc.OwlCatalog Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of owl-doc Show documentation
Show all versions of owl-doc Show documentation
A tool to generate OWL documentation
/**
*
* Copyright 2019-2021 California Institute of Technology ("Caltech").
* U.S. Government sponsorship acknowledged.
*
* 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 io.opencaesar.owl.doc;
import java.io.File;
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Vector;
import org.apache.xml.resolver.Catalog;
import org.apache.xml.resolver.CatalogEntry;
import org.apache.xml.resolver.CatalogManager;
/**
* The Catalog that resolves logical IRIs to physical URIs. It is a wrapper around the the Apache XML Resolver Catalog.
*
* @author elaasar
*/
public final class OwlCatalog {
/*
* The singleton catalog manager
*/
private static CatalogManager manager = new CatalogManager();
static {
manager.setUseStaticCatalog(false);
manager.setIgnoreMissingProperties(true);
}
/*
* The wrapped Apache catalog
*/
private CatalogEx catalog;
/*
* Creates a new OmlCatalog instance
*/
private OwlCatalog(CatalogEx catalog) {
this.catalog = catalog;
}
/**
* Creates a new Oml Catalog given a catalog URI
*
* @param catalogUri The URI of a catalog file named 'catalog.xml'
* @return A new instance of Oml Catalog
* @throws IOException When there are problems parsing the catalog
*/
public static OwlCatalog create(URI catalogUri) throws IOException {
CatalogEx catalog = new CatalogEx(catalogUri);
catalog.setCatalogManager(manager);
catalog.setupReaders();
catalog.loadSystemCatalogs();
catalog.parseCatalog(new URL(catalogUri.toString()));
return new OwlCatalog(catalog);
}
/**
* Resolves the given URI to a file path
*
* @param uri The URI to resolve
* @return The resolved file path
* @throws IOException if the URI cannot be turned into a valid path
*/
public String resolveURI(String uri) throws IOException {
String resolved = catalog.resolveURI(uri);
return normalize(resolved);
}
/**
* Gets the current base of the catalog
*
* @return The current base of the catalog
*/
public String getCurrentBase() {
return catalog.getCurrentBase();
}
/**
* Gets the base URI
*
* @return The base URI
*/
public URI getBaseUri() {
return catalog.getBaseUri();
}
/**
* Gets the catalog entries
*
* @return The entries of the catalog
*/
public List getEntries() {
List entries = new ArrayList();
Enumeration en = catalog.getCatalogEntries().elements();
while (en.hasMoreElements()) {
entries.add((CatalogEntry) en.nextElement());
}
return entries;
}
/**
* Gets the nested catalogs of this catalog
*
* @return The nested catalog of this catalog
*/
public List getNestedCatalogs() {
List entries = new ArrayList();
Enumeration en = catalog.getCatalogs().elements();
while (en.hasMoreElements()) {
entries.add((String)en.nextElement());
}
return entries;
}
/**
* Gets the URIs that are used for rewrite rules in this catalog
*
* @return a map of rewrite URIs
*/
public Map getRewriteRules() {
var rewriteUris = new HashMap();
for (CatalogEntry e : getEntries()) {
if (e.getEntryType() == Catalog.REWRITE_URI) { // only type of entry supported so far
var uri = URI.create(normalize(e.getEntryArg(1)));
String s = uri.toString();
if (s.endsWith("/")) {
try {
uri = new URI(s.substring(0, s.length()-1));
} catch (URISyntaxException e1) {
e1.printStackTrace();
}
}
rewriteUris.put(e.getEntryArg(0), uri);
}
}
return rewriteUris;
}
private String normalize(String path) {
java.net.URI uri = java.net.URI.create(path);
java.net.URI normalized = uri.normalize();
return path.replaceFirst(uri.getRawPath(), normalized.getRawPath());
}
/**
* Gets the URIs of files that are mapped by this catalog
*
* @param fileExtensions a list of file extension
* @return a list of file URIs
*/
public Map getFileUriMap(List fileExtensions) {
var uris = new HashMap();
for (final var rewriteRule : getRewriteRules().entrySet()) {
var rewriteUri = rewriteRule.getValue();
var path = new File(rewriteUri);
if (path.isDirectory()) {
for (var file : getFiles(path, fileExtensions)) {
String relative = path.toURI().relativize(file.toURI()).getPath();
uris.put(rewriteRule.getKey()+trimFileExtension(relative), URI.create(rewriteUri+"/"+relative));
}
} else { // likely a file name with no extension
for (String ext : fileExtensions) {
var file = new File(path.toString()+"."+ext);
if (file.exists()) {
uris.put(rewriteRule.getKey(), URI.create(path.toString()+"."+ext));
break;
}
}
}
}
return uris;
}
private List getFiles(File folder, List fileExtensions) {
final var files = new LinkedHashSet();
for (File file : folder.listFiles()) {
if (file.isFile()) {
var ext = getFileExtension(file);
if (fileExtensions.contains(ext)) {
files.add(file);
}
} else if (file.isDirectory()) {
files.addAll(getFiles(file, fileExtensions));
}
}
return new ArrayList(files);
}
private String getFileExtension(final File file) {
String fileName = file.getName();
if (fileName.lastIndexOf(".") != -1)
return fileName.substring(fileName.lastIndexOf(".")+1);
else
return "";
}
private String trimFileExtension(final String fileName) {
int i = fileName.lastIndexOf('.');
if (i != -1)
return fileName.substring(0, i);
else
return fileName;
}
private static class CatalogEx extends Catalog {
private URI baseUri;
public CatalogEx(URI catalogUri) {
String s = catalogUri.toString();
int i = s.lastIndexOf("/");
try {
this.baseUri = new URI(s.substring(0, i));
} catch (URISyntaxException e) {
e.printStackTrace();
}
}
URI getBaseUri() {
return baseUri;
}
Vector getCatalogEntries() {
return catalogEntries;
}
Vector getCatalogs() {
return catalogs;
}
@Override
protected String makeAbsolute(String sysid) {
sysid = fixSlashes(sysid);
return baseUri.toString()+'/'+sysid;
}
}
}