/**
* Show how to run two queries in tandem. The second query is applied to the results of the first.
*/
public static void examplePipeline() throws XPathException {
final Configuration config = new Configuration();
// Compile the first query
final StaticQueryContext sqc1 = config.newStaticQueryContext();
final XQueryExpression exp1 =
sqc1.compileQuery(
"declare variable $in as xs:integer external;" + "document{ <a>{$in * $in}</a> }");
// Compile the second query (each query should have its own static context)
final StaticQueryContext sqc2 = config.newStaticQueryContext();
final XQueryExpression exp2 = sqc2.compileQuery("/a + 5");
// Run the first query
final DynamicQueryContext dynamicContext = new DynamicQueryContext(config);
dynamicContext.setParameterValue("in", Int64Value.makeIntegerValue(3));
final NodeInfo doc = (NodeInfo) exp1.evaluateSingle(dynamicContext);
// Run the second query
dynamicContext.clearParameters();
dynamicContext.setContextItem(doc);
final Object result = exp2.evaluateSingle(dynamicContext);
System.out.println("3*3 + 5 = " + result);
// The result is actually a java.lang.Double
}
/**
* Show a query producing a single atomic value as its result and returning the value to the Java
* application
*/
public static void exampleToSingleton() throws XPathException {
final Configuration config = new Configuration();
final StaticQueryContext sqc = config.newStaticQueryContext();
final XQueryExpression exp = sqc.compileQuery("avg(for $i in 1 to 10 return $i*$i)");
final DynamicQueryContext dynamicContext = new DynamicQueryContext(config);
final BigDecimal result = (BigDecimal) exp.evaluateSingle(dynamicContext);
System.out.println(result);
}
/**
* Show a query that takes a parameter (external variable) as input. The query produces a single
* atomic value as its result and returns the value to the Java application. For the types of
* value that may be returned, and their mapping to XPath data types, see {@link
* XPathEvaluator#evaluate}
*/
public static void exampleWithParam() throws XPathException {
final Configuration config = new Configuration();
final StaticQueryContext sqc = config.newStaticQueryContext();
final XQueryExpression exp =
sqc.compileQuery("declare variable $in as xs:integer external;" + "$in * $in");
final DynamicQueryContext dynamicContext = new DynamicQueryContext(config);
dynamicContext.setParameterValue("in", Int64Value.makeIntegerValue(17));
final Long result = (Long) exp.evaluateSingle(dynamicContext);
System.out.println("17 * 17 = " + result);
}
/**
* Show how to run a query that is read from a file and that serializes its output as HTML to
* another file. The input to the query (the initial value of the context node) is supplied as the
* content of another file.
*/
public static void exampleToHTMLFile() throws XPathException, IOException {
final Configuration config = new Configuration();
final StaticQueryContext sqc = config.newStaticQueryContext();
final XQueryExpression exp = sqc.compileQuery(new FileReader("query/books-to-html.xq"));
final DynamicQueryContext dynamicContext = new DynamicQueryContext(config);
dynamicContext.setContextItem(config.buildDocument(new StreamSource("data/books.xml")));
final Properties props = new Properties();
props.setProperty(OutputKeys.METHOD, "html");
props.setProperty(OutputKeys.DOCTYPE_PUBLIC, "-//W3C//DTD HTML 4.01 Transitional//EN");
exp.run(dynamicContext, new StreamResult(new File("booklist.html")), props);
}
/** Show a query producing a document as its result and serializing this directly to System.out */
public static void exampleToStreamResult() throws XPathException {
final Configuration config = new Configuration();
final StaticQueryContext sqc = config.newStaticQueryContext();
final XQueryExpression exp = sqc.compileQuery("<a b='c'>{5+2}</a>");
final DynamicQueryContext dynamicContext = new DynamicQueryContext(config);
final Properties props = new Properties();
props.setProperty(OutputKeys.METHOD, "xml");
props.setProperty(OutputKeys.INDENT, "yes");
exp.run(dynamicContext, new StreamResult(System.out), props);
}
public XQueryExecutor(TraceExtension traceExtension) {
this.traceExtension = traceExtension;
Configuration configuration = Configuration.newConfiguration();
if (!traceExtension.allowsOptimization()) {
configuration.setConfigurationProperty(OPTIMIZATION_LEVEL, String.valueOf(NO_OPTIMIZATION));
}
configuration.setModuleURIResolver(new ClasspathModuleUriResolver());
Processor processor = new Processor(configuration);
xQueryCompiler = processor.newXQueryCompiler();
StaticQueryContext staticQueryContext = xQueryCompiler.getUnderlyingStaticContext();
staticQueryContext.setCodeInjector(traceExtension.getTraceCodeInjector());
}
/**
* Show a query producing a sequence as its result and returning the sequence to the Java
* application in the form of an iterator. The sequence is treated as if it were the content of a
* document{...} constructor. Note that it must not contain free-standing attribute nodes.
*/
public static void exampleToSerializedSequence() throws XPathException {
final Configuration config = new Configuration();
final StaticQueryContext sqc = config.newStaticQueryContext();
final XQueryExpression exp =
sqc.compileQuery("<doc><chap><a>3</a></chap></doc>//a, <b>4</b>, 19");
Properties props = new Properties();
props.setProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
final DynamicQueryContext dynamicContext = new DynamicQueryContext(config);
final SequenceIterator iter = exp.iterator(dynamicContext);
QueryResult.serializeSequence(iter, config, System.out, props);
}
/**
* Show a query producing a sequence as its result and returning the sequence to the Java
* application in the form of an iterator. The sequence is then output by wrapping the items in a
* document, with wrapping elements indicating the type of each item, and serializing the
* resulting document.
*/
public static void exampleToWrappedSequence() throws XPathException {
final Configuration config = new Configuration();
final StaticQueryContext sqc = config.newStaticQueryContext();
final XQueryExpression exp =
sqc.compileQuery("<doc><chap><a>3</a></chap></doc>//a, <b>4</b>, attribute c {5}, 19");
Properties props = new Properties();
props.setProperty(OutputKeys.OMIT_XML_DECLARATION, "no");
props.setProperty(OutputKeys.INDENT, "yes");
final DynamicQueryContext dynamicContext = new DynamicQueryContext(config);
final SequenceIterator iter = exp.iterator(dynamicContext);
final DocumentInfo doc = QueryResult.wrap(iter, config);
QueryResult.serialize(doc, new StreamResult(System.out), props);
}
/**
* Show a query producing a sequence as its result and returning the sequence to the Java
* application in the form of an iterator. For each item in the result, its string value is
* output.
*/
public static void exampleToSequence() throws XPathException {
final Configuration config = new Configuration();
final StaticQueryContext sqc = config.newStaticQueryContext();
final XQueryExpression exp = sqc.compileQuery("for $i in 1 to 10 return ($i * $i)");
final DynamicQueryContext dynamicContext = new DynamicQueryContext(config);
final SequenceIterator iter = exp.iterator(dynamicContext);
while (true) {
Item item = iter.next();
if (item == null) {
break;
}
System.out.println(item.getStringValue());
}
}
/**
* Show a query producing a DOM as its output. The DOM is then serialized using an identity
* transform
*/
public static void exampleToDOM() throws TransformerException {
final Configuration config = new Configuration();
final StaticQueryContext sqc = config.newStaticQueryContext();
final XQueryExpression exp =
sqc.compileQuery("<a xmlns='http://a/uri' xmlns:a='another.uri'>text</a>");
final DynamicQueryContext dynamicContext = new DynamicQueryContext(config);
DOMResult result = new DOMResult();
exp.run(dynamicContext, result, new Properties());
// now serialize the DOM
Transformer identity = TransformerFactory.newInstance().newTransformer();
identity.transform(new DOMSource(result.getNode()), new StreamResult(System.out));
}
/**
* Show a direct call from the Java application to a function defined in the Query. This is a very
* efficient way of invoking a query, but it does minimal checking of the supplied arguments
*/
public static void exampleDirectFunction() throws XPathException {
final Configuration config = new Configuration();
final StaticQueryContext sqc = config.newStaticQueryContext();
final XQueryExpression exp1 =
sqc.compileQuery(
"declare namespace f='f.ns';"
+ "declare function f:t1($v1 as xs:integer, $v2 as xs:untypedAtomic*) { "
+ " $v1 div $v2"
+ "};"
+ "10");
final UserFunction fn1 = exp1.getStaticContext().getUserDefinedFunction("f.ns", "t1", 2);
if (fn1 == null) {
throw new IllegalStateException("Function f:t1() not found");
}
final Controller controller = exp1.newController();
final Value[] arglist = new Value[2];
arglist[0] = new Int64Value(10);
for (int i = 3; i < 10; i++) {
arglist[1] = new Int64Value(i);
final ValueRepresentation result = fn1.call(arglist, controller);
System.out.println(arglist[0] + " div " + arglist[1] + " = " + result);
}
}
/**
* Support method for main program. This support method can also be invoked from subclasses that
* support the same command line interface
*
* @param args the command-line arguments
* @param name name of the class, to be used in error messages
*/
protected void doQuery(String args[], String name) {
boolean showTime = false;
int repeat = 1;
String sourceFileName = null;
String queryFileName = null;
File sourceFile;
File outputFile;
boolean useURLs = false;
String outputFileName = null;
boolean explain = false;
boolean wrap = false;
boolean pullMode = false;
boolean schemaAware = false;
for (int i = 0; i < args.length; i++) {
if (args[i].equals("-sa")) {
schemaAware = true;
} else if (args[i].equals("-val")) {
schemaAware = true;
} else if (args[i].equals("-vlax")) {
schemaAware = true;
} else if (args[i].equals("-p")) {
schemaAware = true;
}
}
config = makeConfiguration(schemaAware);
config.setHostLanguage(Configuration.XQUERY);
StaticQueryContext staticEnv = new StaticQueryContext(config);
DynamicQueryContext dynamicEnv = new DynamicQueryContext(config);
Properties outputProps = new Properties();
// Check the command-line arguments.
try {
int i = 0;
while (i < args.length) {
if (args[i].charAt(0) == '-') {
if (args[i].equals("-cr")) {
i++;
if (args.length < i + 1) {
badUsage(name, "No output file name");
}
String crclass = args[i++];
Object resolver = config.getInstance(crclass, null);
if (!(resolver instanceof CollectionURIResolver)) {
quit(crclass + " is not a CollectionURIResolver", 2);
}
config.setCollectionURIResolver((CollectionURIResolver) resolver);
} else if (args[i].equals("-ds")) {
config.setTreeModel(Builder.LINKED_TREE);
i++;
} else if (args[i].equals("-dt")) {
config.setTreeModel(Builder.TINY_TREE);
i++;
} else if (args[i].equals("-e")) {
explain = true;
i++;
} else if (args[i].equals("-l")) {
config.setLineNumbering(true);
i++;
} else if (args[i].equals("-3")) { // undocumented option: do it thrice
i++;
repeat = 3;
} else if (args[i].equals("-9")) { // undocumented option: do it nine times
i++;
repeat = 9;
} else if (args[i].equals("-mr")) {
i++;
if (args.length < i + 1) {
badUsage(name, "No ModuleURIResolver class");
}
String r = args[i++];
config.setModuleURIResolver(r);
} else if (args[i].equals("-noext")) {
i++;
config.setAllowExternalFunctions(false);
} else if (args[i].equals("-o")) {
i++;
if (args.length < i + 1) {
badUsage(name, "No output file name");
}
outputFileName = args[i++];
} else if (args[i].equals("-p")) {
i++;
setPOption(config);
useURLs = true;
} else if (args[i].equals("-pull")) {
i++;
pullMode = true;
} else if (args[i].equals("-r")) {
i++;
if (args.length < i + 1) {
badUsage(name, "No URIResolver class");
}
String r = args[i++];
config.setURIResolver(config.makeURIResolver(r));
dynamicEnv.setURIResolver(config.makeURIResolver(r));
} else if (args[i].equals("-s")) {
i++;
if (args.length < i + 1) {
badUsage(name, "No source file name");
}
sourceFileName = args[i++];
} else if (args[i].equals("-sa")) {
// already handled
i++;
} else if (args[i].equals("-snone")) {
config.setStripsWhiteSpace(Whitespace.NONE);
i++;
} else if (args[i].equals("-sall")) {
config.setStripsWhiteSpace(Whitespace.ALL);
i++;
} else if (args[i].equals("-signorable")) {
config.setStripsWhiteSpace(Whitespace.IGNORABLE);
i++;
} else if (args[i].equals("-strip")) { // retained for compatibility
config.setStripsWhiteSpace(Whitespace.ALL);
i++;
} else if (args[i].equals("-t")) {
System.err.println(config.getProductTitle());
// System.err.println("Java version " + System.getProperty("java.version"));
System.err.println(config.getPlatform().getPlatformVersion());
config.setTiming(true);
showTime = true;
i++;
} else if (args[i].equals("-T")) {
config.setTraceListener(new XQueryTraceListener());
i++;
} else if (args[i].equals("-TJ")) {
i++;
config.setTraceExternalFunctions(true);
} else if (args[i].equals("-TL")) {
if (args.length < i + 2) {
badUsage(name, "No TraceListener class specified");
}
TraceListener traceListener = config.makeTraceListener(args[++i]);
config.setTraceListener(traceListener);
config.setLineNumbering(true);
i++;
} else if (args[i].equals("-u")) {
useURLs = true;
i++;
} else if (args[i].equals("-untyped")) {
// TODO: this is an experimental undocumented option. It should be checked for
// consistency
config.setAllNodesUntyped(true);
i++;
} else if (args[i].equals("-v")) {
config.setValidation(true);
i++;
} else if (args[i].equals("-val")) {
if (schemaAware) {
config.setSchemaValidationMode(Validation.STRICT);
} else {
quit("The -val option requires a schema-aware processor", 2);
}
i++;
} else if (args[i].equals("-vlax")) {
if (schemaAware) {
config.setSchemaValidationMode(Validation.LAX);
} else {
quit("The -vlax option requires a schema-aware processor", 2);
}
i++;
} else if (args[i].equals("-vw")) {
if (schemaAware) {
config.setValidationWarnings(true);
} else {
quit("The -vw option requires a schema-aware processor", 2);
}
i++;
} else if (args[i].equals("-wrap")) {
wrap = true;
i++;
} else if (args[i].equals("-1.1")) {
config.setXMLVersion(Configuration.XML11);
i++;
} else if (args[i].equals("-?")) {
badUsage(name, "");
} else if (args[i].equals("-")) {
queryFileName = "-";
i++;
} else {
badUsage(name, "Unknown option " + args[i]);
}
} else {
break;
}
}
if (!("-".equals(queryFileName))) {
if (args.length < i + 1) {
badUsage(name, "No query file name");
}
queryFileName = args[i++];
}
for (int p = i; p < args.length; p++) {
String arg = args[p];
int eq = arg.indexOf("=");
if (eq < 1 || eq >= arg.length() - 1) {
badUsage(name, "Bad param=value pair on command line: " + arg);
}
String argname = arg.substring(0, eq);
if (argname.startsWith("!")) {
// parameters starting with "!" are taken as output properties
outputProps.setProperty(argname.substring(1), arg.substring(eq + 1));
} else if (argname.startsWith("+")) {
// parameters starting with "+" are taken as input documents
Object sources = Transform.loadDocuments(arg.substring(eq + 1), useURLs, config, true);
dynamicEnv.setParameter(argname.substring(1), sources);
} else {
dynamicEnv.setParameter(argname, new UntypedAtomicValue(arg.substring(eq + 1)));
}
}
config.displayLicenseMessage();
if (pullMode) {
config.setLazyConstructionMode(true);
}
Source sourceInput = null;
if (sourceFileName != null) {
if (useURLs || sourceFileName.startsWith("http:") || sourceFileName.startsWith("file:")) {
sourceInput = config.getURIResolver().resolve(sourceFileName, null);
if (sourceInput == null) {
sourceInput = config.getSystemURIResolver().resolve(sourceFileName, null);
}
} else if (sourceFileName.equals("-")) {
// take input from stdin
sourceInput = new StreamSource(System.in);
} else {
sourceFile = new File(sourceFileName);
if (!sourceFile.exists()) {
quit("Source file " + sourceFile + " does not exist", 2);
}
if (config.getPlatform() instanceof JavaPlatform) {
InputSource eis = new InputSource(sourceFile.toURI().toString());
sourceInput = new SAXSource(eis);
} else {
sourceInput = new StreamSource(sourceFile.toURI().toString());
}
}
}
long startTime = (new Date()).getTime();
if (showTime) {
System.err.println("Compiling query from " + queryFileName);
}
XQueryExpression exp;
try {
if (queryFileName.equals("-")) {
Reader queryReader = new InputStreamReader(System.in);
exp = staticEnv.compileQuery(queryReader);
} else if (queryFileName.startsWith("{") && queryFileName.endsWith("}")) {
// query is inline on the command line
String q = queryFileName.substring(1, queryFileName.length() - 1);
exp = staticEnv.compileQuery(q);
} else if (useURLs
|| queryFileName.startsWith("http:")
|| queryFileName.startsWith("file:")) {
ModuleURIResolver resolver = config.getModuleURIResolver();
String[] locations = {queryFileName};
Source[] sources = resolver.resolve(null, null, locations);
if (sources.length != 1 || !(sources[0] instanceof StreamSource)) {
quit("Module URI Resolver must return a single StreamSource", 2);
}
String queryText =
QueryReader.readSourceQuery((StreamSource) sources[0], config.getNameChecker());
exp = staticEnv.compileQuery(queryText);
} else {
InputStream queryStream = new FileInputStream(queryFileName);
staticEnv.setBaseURI(new File(queryFileName).toURI().toString());
exp = staticEnv.compileQuery(queryStream, null);
}
staticEnv = exp.getStaticContext(); // the original staticContext is copied
if (showTime) {
long endTime = (new Date()).getTime();
System.err.println("Compilation time: " + (endTime - startTime) + " milliseconds");
startTime = endTime;
}
} catch (XPathException err) {
int line = -1;
String module = null;
if (err.getLocator() != null) {
line = err.getLocator().getLineNumber();
module = err.getLocator().getSystemId();
}
if (err.hasBeenReported()) {
quit("Failed to compile query", 2);
} else {
if (line == -1) {
System.err.println("Failed to compile query: " + err.getMessage());
} else {
System.err.println("Static error at line " + line + " of " + module + ':');
System.err.println(err.getMessage());
}
}
exp = null;
System.exit(2);
}
if (explain) {
staticEnv.getExecutable().getKeyManager().explainKeys(config);
staticEnv.explainGlobalVariables();
staticEnv.explainGlobalFunctions();
exp.explain(staticEnv.getConfiguration());
}
OutputStream destination;
if (outputFileName != null) {
outputFile = new File(outputFileName);
if (outputFile.isDirectory()) {
quit("Output is a directory", 2);
}
destination = new FileOutputStream(outputFile);
} else {
destination = System.out;
}
for (int r = 0; r < repeat; r++) { // repeat is for internal testing/timing
if (sourceInput != null) {
if (showTime) {
System.err.println("Processing " + sourceInput.getSystemId());
}
DocumentInfo doc = staticEnv.buildDocument(sourceInput);
dynamicEnv.setContextItem(doc);
}
try {
if (wrap) {
SequenceIterator results = exp.iterator(dynamicEnv);
DocumentInfo resultDoc = QueryResult.wrap(results, config);
QueryResult.serialize(resultDoc, new StreamResult(destination), outputProps, config);
destination.close();
} else if (pullMode) {
if (wrap) {
outputProps.setProperty(SaxonOutputKeys.WRAP, "yes");
}
try {
exp.pull(dynamicEnv, new StreamResult(destination), outputProps);
} catch (XPathException err) {
config.reportFatalError(err);
throw err;
}
} else {
exp.run(dynamicEnv, new StreamResult(destination), outputProps);
}
} catch (TerminationException err) {
throw err;
} catch (XPathException err) {
if (err.hasBeenReported()) {
throw new DynamicError("Run-time errors were reported");
} else {
throw err;
}
}
if (showTime) {
long endTime = (new Date()).getTime();
System.err.println("Execution time: " + (endTime - startTime) + " milliseconds");
startTime = endTime;
}
}
} catch (TerminationException err) {
quit(err.getMessage(), 1);
} catch (XPathException err) {
quit("Query processing failed: " + err.getMessage(), 2);
} catch (TransformerFactoryConfigurationError err) {
err.printStackTrace();
quit("Query processing failed", 2);
} catch (Exception err2) {
err2.printStackTrace();
quit("Fatal error during transformation: " + err2.getMessage(), 2);
}
}