org.apache.marmotta.ldpath.parser

Class Configuration<Node>

java.lang.Object

org.apache.marmotta.ldpath.parser.Configuration<Node>

Direct Known Subclasses:

DefaultConfiguration

public class Configuration<Node>
extends Object

A generic configuration object for LDPath parsers. Contains default settings for namespaces, functions, and transformers to be used by all parser instances.

Author: Sebastian Schaffert

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,SelectorFunction<Node>>	functions A map from function URIs (e.g.
protected Map<String,String>	namespaces A map from namespace prefixes to namespace URIs
protected Map<String,TestFunction<Node>>	testFunctions A map from function URIs (e.g.
protected Map<String,NodeTransformer<?,Node>>	transformers A map from type URIs (e.g.

Constructor Summary

Constructors

Constructor and Description
Configuration()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFunction(String uri, SelectorFunction<Node> function) Add a mapping from a URI to a SelectorFunction implementation to the configuration.
void	addNamespace(String prefix, String uri) Add a namespace prefix to URI mapping to this configuration.
void	addTestFunction(String uri, TestFunction<Node> test) Add a mapping from an URI to a TestFunction inplementation to the configuration.
void	addTransformer(String uri, NodeTransformer<?,Node> transformer) Add a mapping from a type URI to a NodeTransformer.
Map<String,SelectorFunction<Node>>	getFunctions() Return an immutable map of the registered functions.
Map<String,String>	getNamespaces() Return an immutable map of the registered namespaces.
Map<String,TestFunction<Node>>	getTestFunctions() Return an immutable map of the registered function tests.
Map<String,NodeTransformer<?,Node>>	getTransformers() Return an immutable map of the registered transformers.
void	removeFunction(String uri) Remove the function registered under the given URI.
void	removeNamespace(String prefix) Remove the namespace with the prefix given as argument.
void	removeTestFunction(String uri) Remove the test function registered under the given URI.
void	removeTransformer(String uri) Remove the transformer registered with the URI given as argument

Methods inherited from class java.lang.Object

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

Field Detail

namespaces

protected Map<String,String> namespaces

A map from namespace prefixes to namespace URIs

transformers

protected Map<String,NodeTransformer<?,Node>> transformers

A map from type URIs (e.g. XSD Schema Types) to LDPath transformer instances

functions

protected Map<String,SelectorFunction<Node>> functions

A map from function URIs (e.g. LMF functions) to LDPath selector function instances

testFunctions

protected Map<String,TestFunction<Node>> testFunctions

A map from function URIs (e.g. LMF functions) to LDPath test function instances

Constructor Detail

Configuration

public Configuration()

Method Detail

getNamespaces

public Map<String,String> getNamespaces()

Return an immutable map of the registered namespaces.

Returns:

an ImmutableMap of the registered namespaces.

getTransformers

public Map<String,NodeTransformer<?,Node>> getTransformers()

Return an immutable map of the registered transformers.

Returns:

an ImmutableMap of the registered transformers.

getFunctions

public Map<String,SelectorFunction<Node>> getFunctions()

Return an immutable map of the registered functions.

Returns:

an ImmutableMap of the registered SelectorFunctions.

getTestFunctions

public Map<String,TestFunction<Node>> getTestFunctions()

Return an immutable map of the registered function tests.

Returns:

an ImmutableMap of the registered TestFunctions.

addNamespace

public void addNamespace(String prefix,
                String uri)

Add a namespace prefix to URI mapping to this configuration.

Parameters:

prefix - the namespace prefix to be used for the URI as a string

uri - the URI of the namespace to map to as a string

removeNamespace

public void removeNamespace(String prefix)

Remove the namespace with the prefix given as argument.

Parameters:

prefix - the namespace prefix to remove as a string

addFunction

public void addFunction(String uri,
               SelectorFunction<Node> function)

Add a mapping from a URI to a SelectorFunction implementation to the configuration. Registered selector functions will be available under their URIs during program parsing. Function calls are not thread safe and the order of function calls is not predictable; they should therefore not hold any state.

Example:
fn:concat(...) is a mapping from http://www.newmedialab.at/lmf/functions/1.0/ to an instance of ConcatenateFunction

Note that currently you can only use the http://www.newmedialab.at/lmf/functions/1.0/ namespace for registering functions.

Parameters:

uri - the URI under which to register the selector function as a string

function - an instance of the selector function implementation to use for this URI

removeFunction

public void removeFunction(String uri)

Remove the function registered under the given URI.

Parameters:

uri - a string representing the URI under which the function has been registered.

addTestFunction

public void addTestFunction(String uri,
                   TestFunction<Node> test)

Add a mapping from an URI to a TestFunction inplementation to the configuration. Registered test functions will be available under their URIs during program parsing. Function calls are not thread safe and the order of function calls in not predictable; they should therefore not hold any state.

Example:
fn:eq(...) is a mapping from http://www.newmedialab.at/lmf/functions/1.0/eq to an instance of EqualTest

Note that currently you can only use the http://www.newmedialab.at/lmf/functions/1.0/ namespace for registering functions.

Parameters:

uri - the URI under which to register the selector function as a string

test - an instance of the test function implementation for this URI

removeTestFunction

public void removeTestFunction(String uri)

Remove the test function registered under the given URI.

Parameters:

uri - a string representing the URI under which the test function has been registered.

addTransformer

public void addTransformer(String uri,
                  NodeTransformer<?,Node> transformer)

Add a mapping from a type URI to a NodeTransformer. The values of fields with a type specification with this URI will be transformed to other Java types using this transformer.

Example:
... :: xsd:int will transform the values of the field to Java integer values using an instance of IntTransformer

Parameters:

uri - a string identifying the URI for which to register the transformer

transformer -

removeTransformer

public void removeTransformer(String uri)

Remove the transformer registered with the URI given as argument

Parameters:

uri - a string representing the URI under which the transformer is registered