org.apache.marmotta.platform.ldpath.api

Interface LDPathService

All Known Implementing Classes:

LDPathServiceImpl

public interface LDPathService

Add file description here!

Author: Sebastian Schaffert

Method Summary

Methods

Modifier and Type	Method and Description
Set<SelectorFunction<org.openrdf.model.Value>>	getFunctions() List all selector functions that are currently registered with LDPath.
Set<String>	getTransformableTypes() List all types that have a transformer registered.
Collection<org.openrdf.model.Value>	pathQuery(org.openrdf.model.Value context, String path, Map<String,String> namespaces) Run a path query starting from the given context node and return the result as a collection of KiWiNodes.
Map<org.openrdf.model.Value,Map<String,Collection<?>>>	programQuery(String program) Run a path program over all resources in the triplestore matching the program's filter and return the result for each respurce.
Map<String,Collection<?>>	programQuery(org.openrdf.model.Value context, String program) Run a path program starting from the given context node and return the result as a collection of KiWiNodes for each field occurring in the path progrm.
void	registerFunction(SelectorFunction<org.openrdf.model.Value> function) Register an LDPath function in this LDPath service.
void	registerTransformer(String typeUri, NodeTransformer<?,org.openrdf.model.Value> transformer) Register a result transformer for a type URI.

Method Detail

registerFunction

void registerFunction(SelectorFunction<org.openrdf.model.Value> function)

Register an LDPath function in this LDPath service. Can be used by other modules to plug in their own LDPath functions as needed.

Parameters:

function - SelectorFunction to register.

getFunctions

Set<SelectorFunction<org.openrdf.model.Value>> getFunctions()

List all selector functions that are currently registered with LDPath.

pathQuery

Collection<org.openrdf.model.Value> pathQuery(org.openrdf.model.Value context,
                                            String path,
                                            Map<String,String> namespaces)
                                              throws LDPathParseException

Run a path query starting from the given context node and return the result as a collection of KiWiNodes. The namespaces argument is optional and contains a map from prefixes to namespace URIs that can be used in the path expression.

Parameters:

context - the context node where to start with the path query

path - the path query to evaluate starting from the context node

namespaces - optional map from namespace prefixes to namespace URIs

Returns:

a collection of KiWiNodes

Throws:

LDPathParseException - when the path passed as argument could not be parsed

programQuery

Map<String,Collection<?>> programQuery(org.openrdf.model.Value context,
                                     String program)
                                       throws LDPathParseException

Run a path program starting from the given context node and return the result as a collection of KiWiNodes for each field occurring in the path progrm.

Parameters:

context - the context node where to start with the path query

program - the path program to evaluate starting from the context node

Returns:

a map mapping from field names to the resulting collection of KiWiNodes for the field

Throws:

LDPathParseException - when the path passed as argument could not be parsed

programQuery

Map<org.openrdf.model.Value,Map<String,Collection<?>>> programQuery(String program)
                                                                    throws LDPathParseException

Run a path program over all resources in the triplestore matching the program's filter and return the result for each respurce. Since this query can potentially return many results and take long, it is recommended to define appropriate program filters for the query.

Parameters:

program -

Returns:

Throws:

LDPathParseException

registerTransformer

void registerTransformer(String typeUri,
                       NodeTransformer<?,org.openrdf.model.Value> transformer)

Register a result transformer for a type URI. Use this method in your own projects to register custom result transformers.

Parameters:

typeUri - a URI identifying the type for which to use this transformer; can be specified in path programs

transformer - instance of a node transformer

getTransformableTypes

Set<String> getTransformableTypes()

List all types that have a transformer registered.