XQueryProcessorMBS.AddParameters(values as Dictionary)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

Sets parameters given values in the dictionary.

This is a convenience function.
We loop over the entries in the dictionary, convert keys to XdmAtomicValue and values XdmValue objects internally and set parameters.

XQueryProcessorMBS.AddProperties(values as Dictionary)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

Sets properties given values in the dictionary.

This is a convenience function.
We loop over the entries in the dictionary, convert keys and values to string and set properties.

XQueryProcessorMBS.clearParameters

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

Clear parameter values set.

XQueryProcessorMBS.clearProperties

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

Clear property values set.

XQueryProcessorMBS.Clone as XQueryProcessorMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

Creates a cop of the processor.

XQueryProcessorMBS.Constructor

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

Default constructor.

See also:

• Constructor(other as XQueryProcessorMBS)
• Constructor(SaxonProcessor as SaxonProcessorMBS, CWD as String = "")

XQueryProcessorMBS.Constructor(other as XQueryProcessorMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

The copy constructor.

See also:

• Constructor
• Constructor(SaxonProcessor as SaxonProcessorMBS, CWD as String = "")

XQueryProcessorMBS.Constructor(SaxonProcessor as SaxonProcessorMBS, CWD as String = "")

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

Constructor with the SaxonProcessor supplied.

Pass the SaxonProcessor object to use.

cwd: set the current working directory. Default is the empty string

See also:

• Constructor
• Constructor(other as XQueryProcessorMBS)

XQueryProcessorMBS.declareNamespace(prefix as String, uri as String)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

Declare a namespace binding.

Declare a namespace binding as part of the static context for queries compiled using this XQueryCompiler. This binding may be overridden by a binding that appears in the query prolog. The namespace binding will form part of the static context of the query, but it will not be copied into result trees unless the prefix is actually used in an element or attribute name.

Prefix: The namespace prefix. If the value is a zero-length string, this method sets the default namespace for elements and types.
uri: The namespace URI. It is possible to specify a zero-length string to "undeclare" a namespace; in this case the prefix will not be available for use, except in the case where the prefix is also a zero length string, in which case the absence of a prefix implies that the name is in no namespace. Assume the prefix or uri is "".

XQueryProcessorMBS.Destructor

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

The destructor.

XQueryProcessorMBS.executeQueryToFile(infilename as String, ofilename as string, query as String, encoding as string = "")

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

Perform the Query to file.

The result is is saved to file
infilename: The file name of the source document
ofilename: The file name of where result will be stored
query: The query as string representation.
encoding: The encoding of the query string. If not specified then the platform default encoding is used.

Some examples using this method:

• /XML/Saxon/Saxon test

XQueryProcessorMBS.executeQueryToString(infilename as String, query as String, encoding as string = "") as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

Perform the Query to a string representation.

infilename: The file name of the source document
query: The query as string representation
encoding: the encoding of the query string. If not specified then the platform default encoding is used.

Returns result of as a string.

XQueryProcessorMBS.executeQueryToValue(infilename as String, query as String, encoding as string = "") as XdmValueMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

Perform the Query to a XdmValue representation.

infilename: The file name of the source document
query: The query as string representation
encoding: the encoding of the query string. If not specified then the platform default encoding is used.

Returns result of the the query as a XdmValueMBS.

XQueryProcessorMBS.ParameterValue(name as String) as XdmValueMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

Get/Set a parameter.

Name: The name of the parameter, as a string.
For namespaced parameter use the JAXP solution i.e. "{uri}name" value of the query parameter.
Assign "" to clear a previously set value.

Some of the properties on this class may just internally set/get a parameter.
(Read and Write computed property)

XQueryProcessorMBS.PropertyValue(name as String) as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

A property specific to the processor in use.

XQueryProcessor: set serialization properties
(names start with '!' i.e. name "!method" -> "xml")
'o':outfile name,
's': source as file name
'q': query file name,
'q': current by name,
'qs': string form of the query,
'base': set the base URI of the query,
'dtd': set DTD validation 'on' or
'off' name of the property value of the property

Some of the properties on this class may just internally set/get a property.
(Read and Write computed property)

XQueryProcessorMBS.removeParameter(name as String) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

Remove a parameter (name, value) pair.

Please pass the name of the parameter.
Returns outcome of the removal, true if found.

XQueryProcessorMBS.runQueryToFile

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

Execute the Query cached to file.

The use of the context item would have had to be set in advance Assume the output filename has been set in advance.

XQueryProcessorMBS.runQueryToString as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

Execute the Query cached.

The use of the context item would have had to be set in advance.
Result as a string.

Some examples using this method:

• /XML/Saxon/Saxon test

XQueryProcessorMBS.runQueryToValue as XdmValueMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Saxon	MBS XML Plugin	25.0	✅ Yes	✅ Yes	✅ Yes	❌ No	All

Execute the Query cached.

The use of the context item would have had to be set in advance

Returns XdmValueMBS of the result.