org.semanticweb.owlapi.util.DefaultPrefixManager Maven / Gradle / Ivy
/*
* This file is part of the OWL API.
*
* The contents of this file are subject to the LGPL License, Version 3.0.
*
* Copyright (C) 2011, 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.
*
* Copyright 2011, University of Manchester
*
* 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.util;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import org.semanticweb.owlapi.model.IRI;
import org.semanticweb.owlapi.model.OWLEntity;
import org.semanticweb.owlapi.model.PrefixManager;
import org.semanticweb.owlapi.vocab.Namespaces;
/**
* @author Matthew Horridge, The University Of Manchester, Information
* Management Group, Date: 10-Sep-2008
*/
public class DefaultPrefixManager implements PrefixManager, ShortFormProvider,
IRIShortFormProvider {
private static final long serialVersionUID = 30406L;
/**
* String comparator that takes length into account before natural ordering.
* XXX stateless, might be used through a singleton
*/
private static final class StringLengthComparator implements
Comparator, Serializable {
private static final long serialVersionUID = 30406L;
public StringLengthComparator() {}
@Override
public int compare(String o1, String o2) {
int diff = o1.length() - o2.length();
if (diff != 0) {
return diff;
}
return o1.compareTo(o2);
}
}
private static final StringLengthComparator STRING_LENGTH_COMPARATOR = new StringLengthComparator();
private final Map prefix2NamespaceMap;
private final Map reverseprefix2NamespaceMap;
/** Creates a namespace manager that does not have a default namespace. */
public DefaultPrefixManager() {
this(STRING_LENGTH_COMPARATOR);
}
/**
* Creates a namespace manager that does not have a default namespace.
*
* @param c
* comparator to sort prefixes
*/
public DefaultPrefixManager(Comparator c) {
prefix2NamespaceMap = new TreeMap(c);
reverseprefix2NamespaceMap = new HashMap();
setupDefaultPrefixes();
}
/**
* @param pm
* the prefix manager to copy
*/
public DefaultPrefixManager(PrefixManager pm) {
this();
addPrefixes(pm);
}
// XXX this method will be added to the PrefixManager interface
/**
* @param pm
* prefix manager whose prefixes will be added to this manager
*/
public void addPrefixes(PrefixManager pm) {
for (String prefixName : pm.getPrefixNames()) {
String prefix = pm.getPrefix(prefixName);
if (prefix != null) {
prefix2NamespaceMap.put(prefixName, prefix);
reverseprefix2NamespaceMap.put(prefix, prefixName);
}
}
}
/**
* @param pm
* the prefix manager to copy
* @param c
* comparator to sort prefixes
*/
public DefaultPrefixManager(PrefixManager pm, Comparator c) {
this(c);
addPrefixes(pm);
}
/** clear the map. */
// XXX not in the interface
public void clear() {
// Clear the default namespace and map
prefix2NamespaceMap.clear();
reverseprefix2NamespaceMap.clear();
}
@Override
public Set getPrefixNames() {
return new HashSet(prefix2NamespaceMap.keySet());
}
/**
* Creates a namespace manager that has the specified default namespace.
*
* @param defaultPrefix
* The namespace to be used as the default namespace.
*/
public DefaultPrefixManager(String defaultPrefix) {
this();
if (defaultPrefix != null) {
setDefaultPrefix(defaultPrefix);
}
}
/**
* Creates a namespace manager that has the specified default namespace.
*
* @param defaultPrefix
* The namespace to be used as the default namespace.
* @param c
* comparator to sort prefixes
*/
public DefaultPrefixManager(String defaultPrefix, Comparator c) {
this(c);
if (defaultPrefix != null) {
setDefaultPrefix(defaultPrefix);
}
}
private void setupDefaultPrefixes() {
setPrefix("owl:", Namespaces.OWL.toString());
setPrefix("rdfs:", Namespaces.RDFS.toString());
setPrefix("rdf:", Namespaces.RDF.toString());
setPrefix("xsd:", Namespaces.XSD.toString());
setPrefix("xml:", Namespaces.XML.toString());
}
/**
* Sets the default namespace. This will also bind the prefix name ":" to
* this prefix
*
* @param defaultPrefix
* The namespace to be used as the default namespace. Note that the
* value may be {@code null} in order to clear the default namespace.
*/
// XXX not in the interface
public void setDefaultPrefix(String defaultPrefix) {
setPrefix(":", defaultPrefix);
}
@Override
public String getPrefixIRI(IRI iri) {
String ns = iri.getNamespace();
String prefix = reverseprefix2NamespaceMap.get(ns);
if (prefix == null) {
return null;
}
return iri.prefixedBy(prefix);
}
@Override
public String getDefaultPrefix() {
return prefix2NamespaceMap.get(":");
}
@Override
public boolean containsPrefixMapping(String prefix) {
return prefix2NamespaceMap.get(prefix) != null;
}
@Override
public IRI getIRI(String curie) {
if (curie.startsWith("<")) {
return IRI.create(curie.substring(1, curie.length() - 1));
}
int sep = curie.indexOf(':');
if (sep == -1) {
if (getDefaultPrefix() != null) {
return IRI.create(getDefaultPrefix() + curie);
} else {
return IRI.create(curie);
}
} else {
String prefixName = curie.substring(0, sep + 1);
if (!containsPrefixMapping(prefixName)) {
throw new RuntimeException(
"Prefix not registered for prefix name: " + prefixName);
}
String prefix = getPrefix(prefixName);
String localName = curie.substring(sep + 1);
return IRI.create(prefix, localName);
}
}
@Override
public Map getPrefixName2PrefixMap() {
return Collections.unmodifiableMap(prefix2NamespaceMap);
}
@Override
public String getPrefix(String prefixName) {
return prefix2NamespaceMap.get(prefixName);
}
/**
* Adds a prefix name to prefix mapping.
*
* @param prefixName
* name The prefix name (must not be null)
* @param prefix
* The prefix. Cannot be null.
* @throws NullPointerException
* if the parameters passed in are null
* @throws IllegalArgumentException
* if the prefix name does not end with a colon.
*/
// XXX not in the interface
public void setPrefix(String prefixName, String prefix) {
if (prefix == null) {
throw new NullPointerException("prefix cannot be null");
}
if (prefixName == null) {
throw new NullPointerException("prefixName cannot be null");
}
if (!prefixName.endsWith(":")) {
throw new IllegalArgumentException(
"Prefix names must end with a colon (:)");
}
prefix2NamespaceMap.put(prefixName, prefix);
reverseprefix2NamespaceMap.put(prefix, prefixName);
}
/**
* Removes a previously registerd prefix namespace mapping.
*
* @param namespace
* The namespace to be removed.
*/
// XXX not in the interface
public void unregisterNamespace(String namespace) {
List toRemove = new ArrayList();
for (Map.Entry e : prefix2NamespaceMap.entrySet()) {
if (e.getValue().equals(namespace)) {
toRemove.add(e.getKey());
}
}
reverseprefix2NamespaceMap.remove(namespace);
for (String s : toRemove) {
prefix2NamespaceMap.remove(s);
}
}
@Override
public String getShortForm(IRI iri) {
String sf = getPrefixIRI(iri);
if (sf == null) {
return iri.toQuotedString();
} else {
return sf;
}
}
@Override
public String getShortForm(OWLEntity entity) {
return getShortForm(entity.getIRI());
}
@Override
public void dispose() {}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy