Platforms to show: All Mac Windows Linux Cross-Platform

Back to SaxonProcessorMBS class.

SaxonProcessorMBS.clarkNameToEQName(name 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
Convert clark name string to EQName notation.

The expanded name, as a string using the notation defined by the EQName production in XPath 3.0. If the name is in a namespace, the resulting string takes the form Q{uri}local. Otherwise, the value is the local part of the name.

Name: The URI in Clark notation: {uri}local if the name is in a namespace, or simply local if not.

Returns the expanded name, as a string using the notation defined by the EQName production in XPath 3.0.

SaxonProcessorMBS.clearConfigurationProperties

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Clear configuration properties specific to the processor in use.

SaxonProcessorMBS.ConfigurationProperty(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 configuration property specific to the processor in use.

Properties specified here are common across all the processors.
Example 'l': enable line number has the value 'on' or 'off'
(Read and Write computed property)

Some examples using this property:

SaxonProcessorMBS.Constructor

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

Create Saxon Processor.

See also:

SaxonProcessorMBS.Constructor(other as SaxonProcessorMBS)

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:

SaxonProcessorMBS.Destructor

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

SaxonProcessorMBS.EQNameToClarkName(name 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
Convert EQName string to clark name notation.

name: The URI in EQName notation: Q{uri}local if the name is in a namespace. For a name in no namespace, either of the forms Q{}local or simply local are accepted.

Returns the URI in the clark notation.

SaxonProcessorMBS.NewDocumentBuilder as DocumentBuilderMBS

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

A DocumentBuilder is used to load source XML documents.

SaxonProcessorMBS.NewSchemaValidator as SchemaValidatorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Create a SchemaValidator which can be used to validate instance documents against the schema held by this SchemaManager.

Returns nil, if license doesn't allow the validator.

Some examples using this method:

SaxonProcessorMBS.NewXPathProcessor as XPathProcessorMBS

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

An XPathProcessor is used to compile XPath expressions.

Some examples using this method:

SaxonProcessorMBS.NewXQueryProcessor as XQueryProcessorMBS

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

An XQueryProcessor is used to compile XQuery queries.

Some examples using this method:

SaxonProcessorMBS.NewXslt30Processor as Xslt30ProcessorMBS

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

An Xslt30Processor is used to compile XSLT30 stylesheets.

Some examples using this method:

SaxonProcessorMBS.parseJsonFromFile(File as FolderItem) as XdmValueMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Parse a source JSON file and return it as an XdmValue.
Example
Const Path = "/Users/cs/test.json"
Var n As XdmValueMBS = s.parseJsonFromFile(Path)
Var x As String = n.toString

Break

File: The full path to the file.

Returns an XdmValueMBS.

Throws a SaxonExceptionMBS if there ia a failure in the parsing of the XML file.

SaxonProcessorMBS.parseJsonFromPath(Path 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
Parse a source JSON file and return it as an XdmValue.
Example
Const Path = "/Users/cs/test.json"
Var n As XdmValueMBS = s.parseJsonFromFile(Path)
Var x As String = n.toString

Break

Path: the filename of the JSON. This is a full path filename or a URI.

Returns an XdmValueMBS.

Throws a SaxonExceptionMBS if there ia a failure in the parsing of the XML file.

SaxonProcessorMBS.parseJsonFromString(content 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
Parse a lexical representation of the JSON and return it as an XdmValue.
Example
Var Processor As New SaxonProcessorMBS
Var n As XdmValueMBS = Processor.parseJsonFromString("[1,2,3]")
Var s As String = n.toString
Break
// shows [1.0e0,2.0e0,3.0e0]

source: the JSON as a lexical string
encoding: the encoding of the source argument. Argument can be omitted and "" accepted to use the default platform encoding.

Returns an XdmValueMBS.

Raises SaxonExceptionMBS if there is a failure in the parsing of the JSON.

SaxonProcessorMBS.parseXmlFromFile(File as FolderItem, validator as SchemaValidatorMBS = nil) as XdmNodeMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Parse a source document file and return it as an XdmNode.

source: the filename of the source document
validator: can be used to supply a SchemaValidator to validate the document. Default is nil.

Returns an XdmNodeMBS

Throws a SaxonExceptionMBS if there ia a failure in the parsing of the XML file.

SaxonProcessorMBS.parseXmlFromPath(Path as String, validator as SchemaValidatorMBS = nil) as XdmNodeMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Parse a source document file and return it as an XdmNode.
Example
Var s As New SaxonProcessorMBS

Const XMLPath = "/Users/cs/test.xml"
Var n As XdmNodeMBS = s.parseXmlFromPath(XMLPath)
Var x As String = n.toString

Break

source: the filename of the source document
validator: can be used to supply a SchemaValidator to validate the document. Default is nil.

Returns an XdmNodeMBS

Throws a SaxonExceptionMBS if there ia a failure in the parsing of the XML file.

SaxonProcessorMBS.parseXmlFromString(content as String, encoding as String = "", validator as SchemaValidatorMBS = nil) as XdmNodeMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Parse a lexical representation of the source document and return it as an XdmNodeMBS.

source: the source document as a lexical string
encoding: the encoding used to decode the source string. If not specified then platform default encoding is used.
validator: can be used to supply a SchemaValidator to validate the document. Default is nil.

Returns an XdmNodeMBS

Throws a SaxonExceptionMBS if there is a failure in the parsing of the XML document

SaxonProcessorMBS.parseXmlFromUri(URI as String, validator as SchemaValidatorMBS = nil) as XdmNodeMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Parse a source document available by URI and return it as an XdmNode.

source: the URI of the source document
validator: can be used to supply a SchemaValidator to validate the document. Default is nil.

Returns an XdmNodeMBS.

Raises SaxonExceptionMBS if there ia failure in the parsing of the XML file

SaxonProcessorMBS.setCatalog(catalogFile as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Set catalog to be used in Saxon.

catalogFile: file name to the catalog

SaxonProcessorMBS.setCatalogFiles(catalogFiles() as String)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
The catalog files to be used in Saxon.

catalogFiles: the catalog file names array to the catalog

SaxonProcessorMBS.StringValue(item as XdmItemMBS) as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Get the string representation of the XdmValue.

SaxonProcessorMBS.SystemFunction(name as String, arity as Integer) as XdmFunctionItemMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Get a system function.
Example
Var processor As New SaxonProcessorMBS
Var func As XdmFunctionItemMBS = processor.SystemFunction("{http://www.w3.org/2005/xpath-functions}parse-json", 1)
Break

This can be any function defined in XPath 3.1 functions and operators, including functions in the math, map, and array namespaces. It can also be a Saxon extension function, provided a licensed Processor is used.

processor: The Saxon Processor object required to get the system function.
name: the name of the function
arity: the number of arguments in the function

Returns the requested function, or null if there is no such function. Note that some functions (those with particular context dependencies) may be unsuitable for dynamic calling.

The items on this page are in the following plugins: MBS XML Plugin.


The biggest plugin in space...