org.apache.camel.builder.saxon
Class XQueryBuilder<E extends org.apache.camel.Exchange>

java.lang.Object
  extended by org.apache.camel.builder.saxon.XQueryBuilder<E>
All Implemented Interfaces:
org.apache.camel.Expression<E>, org.apache.camel.Predicate<E>

public abstract class XQueryBuilder<E extends org.apache.camel.Exchange>
extends Object
implements org.apache.camel.Expression<E>, org.apache.camel.Predicate<E>

Creates an XQuery builder

Version:
$Revision: 534053 $

Constructor Summary
XQueryBuilder()
           
 
Method Summary
protected  void addParameters(net.sf.saxon.query.DynamicQueryContext dynamicQueryContext, Map<String,Object> map)
           
 XQueryBuilder<E> asBytes()
           
 XQueryBuilder<E> asBytesSource()
           
 XQueryBuilder<E> asDOM()
           
 XQueryBuilder<E> asDOMSource()
           
 XQueryBuilder<E> asList()
           
 void assertMatches(String text, E exchange)
           
 XQueryBuilder<E> asString()
           
 XQueryBuilder<E> asStringSource()
           
protected  void clearBuilderReferences()
          To avoid keeping around any unnecessary objects after the expresion has been created lets nullify references here
protected  void configureQuery(net.sf.saxon.query.DynamicQueryContext dynamicQueryContext, org.apache.camel.Exchange exchange)
          Configures the dynamic context with exchange specific parameters
protected  net.sf.saxon.query.DynamicQueryContext createDynamicContext(E exchange)
          Creates a dynamic context for the given exchange
protected abstract  net.sf.saxon.query.XQueryExpression createQueryExpression(net.sf.saxon.query.StaticQueryContext staticQueryContext)
          A factory method to create the XQuery expression
 Object evaluate(E exchange)
           
 byte[] evaluateAsBytes(E exchange)
           
 Object evaluateAsBytesSource(E exchange)
           
 Node evaluateAsDOM(E exchange)
           
 List evaluateAsList(E exchange)
           
 String evaluateAsString(E exchange)
           
 Object evaluateAsStringSource(E exchange)
           
 net.sf.saxon.Configuration getConfiguration()
           
 net.sf.saxon.query.XQueryExpression getExpression()
           
 Map<String,Object> getParameters()
           
 Properties getProperties()
           
 ResultFormat getResultsFormat()
           
 net.sf.saxon.query.StaticQueryContext getStaticQueryContext()
           
 boolean matches(E exchange)
           
protected  boolean matches(E exchange, List results)
           
 XQueryBuilder<E> parameter(String name, Object value)
           
 void setConfiguration(net.sf.saxon.Configuration configuration)
           
 void setParameters(Map<String,Object> parameters)
           
 void setProperties(Properties properties)
           
 void setResultsFormat(ResultFormat resultsFormat)
           
 void setStaticQueryContext(net.sf.saxon.query.StaticQueryContext staticQueryContext)
           
 String toString()
           
static
<E extends org.apache.camel.Exchange>
XQueryBuilder<E>
xquery(InputStream in, String characterSet)
           
static
<E extends org.apache.camel.Exchange>
XQueryBuilder<E>
xquery(Reader reader)
           
static
<E extends org.apache.camel.Exchange>
XQueryBuilder<E>
xquery(String queryText)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

XQueryBuilder

public XQueryBuilder()
Method Detail

toString

public String toString()
Overrides:
toString in class Object

evaluate

public Object evaluate(E exchange)
Specified by:
evaluate in interface org.apache.camel.Expression<E extends org.apache.camel.Exchange>

evaluateAsList

public List evaluateAsList(E exchange)
                    throws Exception
Throws:
Exception

evaluateAsStringSource

public Object evaluateAsStringSource(E exchange)
                              throws Exception
Throws:
Exception

evaluateAsBytesSource

public Object evaluateAsBytesSource(E exchange)
                             throws Exception
Throws:
Exception

evaluateAsDOM

public Node evaluateAsDOM(E exchange)
                   throws Exception
Throws:
Exception

evaluateAsBytes

public byte[] evaluateAsBytes(E exchange)
                       throws Exception
Throws:
Exception

evaluateAsString

public String evaluateAsString(E exchange)
                        throws Exception
Throws:
Exception

matches

public boolean matches(E exchange)
Specified by:
matches in interface org.apache.camel.Predicate<E extends org.apache.camel.Exchange>

assertMatches

public void assertMatches(String text,
                          E exchange)
                   throws AssertionError
Specified by:
assertMatches in interface org.apache.camel.Predicate<E extends org.apache.camel.Exchange>
Throws:
AssertionError

xquery

public static <E extends org.apache.camel.Exchange> XQueryBuilder<E> xquery(String queryText)

xquery

public static <E extends org.apache.camel.Exchange> XQueryBuilder<E> xquery(Reader reader)

xquery

public static <E extends org.apache.camel.Exchange> XQueryBuilder<E> xquery(InputStream in,
                                                                            String characterSet)

asBytes

public XQueryBuilder<E> asBytes()

asBytesSource

public XQueryBuilder<E> asBytesSource()

asDOM

public XQueryBuilder<E> asDOM()

asDOMSource

public XQueryBuilder<E> asDOMSource()

asList

public XQueryBuilder<E> asList()

asString

public XQueryBuilder<E> asString()

asStringSource

public XQueryBuilder<E> asStringSource()

parameter

public XQueryBuilder<E> parameter(String name,
                                  Object value)

getExpression

public net.sf.saxon.query.XQueryExpression getExpression()
                                                  throws IOException,
                                                         net.sf.saxon.trans.XPathException
Throws:
IOException
net.sf.saxon.trans.XPathException

getConfiguration

public net.sf.saxon.Configuration getConfiguration()

setConfiguration

public void setConfiguration(net.sf.saxon.Configuration configuration)

getStaticQueryContext

public net.sf.saxon.query.StaticQueryContext getStaticQueryContext()

setStaticQueryContext

public void setStaticQueryContext(net.sf.saxon.query.StaticQueryContext staticQueryContext)

getParameters

public Map<String,Object> getParameters()

setParameters

public void setParameters(Map<String,Object> parameters)

getProperties

public Properties getProperties()

setProperties

public void setProperties(Properties properties)

getResultsFormat

public ResultFormat getResultsFormat()

setResultsFormat

public void setResultsFormat(ResultFormat resultsFormat)

createQueryExpression

protected abstract net.sf.saxon.query.XQueryExpression createQueryExpression(net.sf.saxon.query.StaticQueryContext staticQueryContext)
                                                                      throws net.sf.saxon.trans.XPathException,
                                                                             IOException
A factory method to create the XQuery expression

Throws:
net.sf.saxon.trans.XPathException
IOException

createDynamicContext

protected net.sf.saxon.query.DynamicQueryContext createDynamicContext(E exchange)
                                                               throws Exception
Creates a dynamic context for the given exchange

Throws:
Exception

configureQuery

protected void configureQuery(net.sf.saxon.query.DynamicQueryContext dynamicQueryContext,
                              org.apache.camel.Exchange exchange)
                       throws Exception
Configures the dynamic context with exchange specific parameters

Parameters:
dynamicQueryContext -
exchange -
Throws:
Exception

addParameters

protected void addParameters(net.sf.saxon.query.DynamicQueryContext dynamicQueryContext,
                             Map<String,Object> map)

clearBuilderReferences

protected void clearBuilderReferences()
To avoid keeping around any unnecessary objects after the expresion has been created lets nullify references here


matches

protected boolean matches(E exchange,
                          List results)


Copyright © 2007 Apache Software Foundation. All Rights Reserved.