Package org.openprovenance.prov.model

Class Namespace

java.lang.Object

org.openprovenance.prov.model.Namespace

public class Namespace
extends Object

A class to manipulate Namespaces when creating, serializing and converting prov documents.

Author:

Luc Moreau

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,String>	namespaces
protected Map<String,String>	prefixes
static String	xmlns

Constructor Summary

Constructors

Constructor	Description
Namespace()
Namespace(Hashtable<String,String> pref)
Namespace(Namespace other)

Method Summary

Modifier and Type	Method	Description
void	addKnownNamespaces()
boolean	check(String prefix, String namespace)
void	extendWith(Namespace ns)	Extends this Namespace with all the prefix/namespace registration of the Namespace received as argument.
static Namespace	gatherNamespaces(Bundle bundle)
static Namespace	gatherNamespaces(Bundle bundle, ProvFactory pFactory)
static Namespace	gatherNamespaces(Document doc)
String	getDefaultNamespace()
Map<String,String>	getNamespaces()
Namespace	getParent()
Map<String,String>	getPrefixes()
static Namespace	getThreadNamespace()
void	newPrefix(String namespace)
QualifiedName	qualifiedName(String prefix, String local, ProvFactory pFactory)	Creates a qualified name, with given prefix and local name.
String	qualifiedNameToString(QName name)
String	qualifiedNameToString(QName name, Namespace child)
String	qualifiedNameToString(QualifiedName name)
String	qualifiedNameToString(QualifiedName name, Namespace child)
static String	qualifiedNameToStringWithNamespace(QualifiedName name)
void	register(String prefix, String namespace)
void	registerDefault(String namespace)
void	setDefaultNamespace(String defaultNamespace)
void	setParent(Namespace parent)
QualifiedName	stringToQualifiedName(String id, ProvFactory pFactory)
QualifiedName	stringToQualifiedName(String id, ProvFactory pFactory, boolean isEscaped)
String	toString()
void	unregister(String prefix, String namespace)
void	unregisterDeafult(String namespace)
static Namespace	withThreadNamespace(Namespace ns)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

prefixes

protected Map<String,String> prefixes

namespaces

protected Map<String,String> namespaces

xmlns

public static final String xmlns

See Also:

Constant Field Values

Constructor Detail

Namespace

public Namespace()

Namespace

public Namespace(Hashtable<String,String> pref)

Namespace

public Namespace(Namespace other)

Method Detail

getThreadNamespace

public static Namespace getThreadNamespace()

withThreadNamespace

public static Namespace withThreadNamespace(Namespace ns)

extendWith

public void extendWith(Namespace ns)

Extends this Namespace with all the prefix/namespace registration of the Namespace received as argument.

Parameters:

ns - the Namespace whose prefix/namespace registration are added to this Namespace.

setParent

public void setParent(Namespace parent)

getParent

public Namespace getParent()

addKnownNamespaces

public void addKnownNamespaces()

getDefaultNamespace

public String getDefaultNamespace()

setDefaultNamespace

public void setDefaultNamespace(String defaultNamespace)

getPrefixes

public Map<String,String> getPrefixes()

getNamespaces

public Map<String,String> getNamespaces()

check

public boolean check(String prefix,
                     String namespace)

registerDefault

public void registerDefault(String namespace)

register

public void register(String prefix,
                     String namespace)

newPrefix

public void newPrefix(String namespace)

unregister

public void unregister(String prefix,
                       String namespace)

unregisterDeafult

public void unregisterDeafult(String namespace)

gatherNamespaces

public static Namespace gatherNamespaces(Document doc)

gatherNamespaces

public static Namespace gatherNamespaces(Bundle bundle)

gatherNamespaces

public static Namespace gatherNamespaces(Bundle bundle,
                                         ProvFactory pFactory)

stringToQualifiedName

public QualifiedName stringToQualifiedName(String id,
                                           ProvFactory pFactory)

stringToQualifiedName

public QualifiedName stringToQualifiedName(String id,
                                           ProvFactory pFactory,
                                           boolean isEscaped)

qualifiedName

public QualifiedName qualifiedName(String prefix,
                                   String local,
                                   ProvFactory pFactory)

Creates a qualified name, with given prefix and local name. The prefix needs to have been pre-registered. Prefix is allowed to be null: in that case, the intended namespace is the default namespace (see getDefaultNamespace()) which must have been pre-registered.

Parameters:

prefix - the prefix for the QualifiedName

local - the local name for the QualifiedName

pFactory - the factory method used to construct the QualifiedName

Returns:

a QualifiedName

Throws:

QualifiedNameException - if prefix is not pre-registered.

NullPointerException - if prefix is null and defaultnamespace has not been registered.

qualifiedNameToStringWithNamespace

public static String qualifiedNameToStringWithNamespace(QualifiedName name)

qualifiedNameToString

public String qualifiedNameToString(QName name)

qualifiedNameToString

public String qualifiedNameToString(QualifiedName name)

qualifiedNameToString

public String qualifiedNameToString(QualifiedName name,
                                    Namespace child)

Parameters:

name - the QualifiedName to convert to string

child - argument used just for the purpose of debugging when throwing an exception

Returns:

a string representation of the QualifiedName

qualifiedNameToString

public String qualifiedNameToString(QName name,
                                    Namespace child)

Parameters:

name - the QName to convert to string

child - argument used just for the purpose of debugging when throwing an exception

Returns:

a string representation of the QualifiedName

toString

public String toString()

Overrides:

toString in class Object