org.ontoware.rdf2go.model.NamespaceSupport Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rdf2go.api Show documentation

RDF2go is an implementation-independent Java API with the design goals: portability (hence the name), performance and ease of implementation. This project was started at FZI Forschungszentrum Informatik Karlsruhe, Germany - www.fzi.de

The newest version!

/**
 * LICENSE INFORMATION
 *
 * Copyright 2005-2008 by FZI (http://www.fzi.de).
 * Licensed under a BSD license (http://www.opensource.org/licenses/bsd-license.php)
 *  = Max Völkel
 *  = FZI Forschungszentrum Informatik Karlsruhe, Karlsruhe, Germany
 *  = 2010
 *
 * Further project information at http://semanticweb.org/wiki/RDF2Go
 */

package org.ontoware.rdf2go.model;

import java.util.Map;

/**
 * This interface leaves it open to implementations where the prefixes go, e.g.
 * if prefixes added to a {@link Model} change the mapping in the surrounding
 * {@link ModelSet} if any. As namespaces do not really exist *in RDF*, only in
 * syntaxes, there are no definitive specifications on this subject.
 * 
 * This API is modeled after the OpenRDF 2.0 API.
 * 
 * Discussion about this interfaces at http://issues.semweb4j.org/RTGO-20
 * 
 * @author voelkel
 * @since 4.6
 */
public interface NamespaceSupport {

	/**
	 * @param prefix
	 * @return the namespace that is associated with the specified prefix, if
	 *         any. Null otherwise.
	 */
	String getNamespace(String prefix);

	/**
	 * Get all namespaces as a map of prefix to namespace.
	 * 
	 * @return An unmodifiable view on the namespaces. (compare to
	 *         Collections.unmodifiableMap()). Never returns null.
	 */
	Map getNamespaces();

	/**
	 * Throws no exception if the prefix was not present.
	 * 
	 * @param prefix
	 */
	void removeNamespace(String prefix);

	/**
	 * @param prefix
	 * @param namespaceURI
	 * @throws IllegalArgumentException
	 *             if the given namespaceURI is not a valid URI in this
	 *             environment.
	 */
	void setNamespace(String prefix, String namespaceURI)
			throws IllegalArgumentException;

}