Platforms to show: All Mac Windows Linux Cross-Platform

Back to SaxonProcessorMBS class.

Next items

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.makeArray(input() as Variant) as XdmArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Creates an array from variants.
Example
Var Processor As New SaxonProcessorMBS
Var values() As Variant
values.add 123
values.add "Hello"
values.add True
values.add Array(1,2,3)
Var a As XdmArrayMBS = Processor.makeArray(values)
Var t As String = a.toString
Break // shows [123,"Hello",true(),[1,2,3]]

Uses makeValue internally to convert variant values to XdmValue.

SaxonProcessorMBS.makeArrayValues(input() as XdmValueMBS) as XdmArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Make an XdmArray whose members are of type XdmValue.
Example
Var Processor As New SaxonProcessorMBS
Var v() As XdmValueMBS
v.Add Processor.makeInt32Value(123)
v.Add Processor.makeDoubleValue(123)
v.Add Processor.makeStringValue("Hello")
Var a As XdmValueMBS = Processor.makeArrayValues(v)
// shows [123,1.23e2,"Hello"]
MessageBox a.toString

input: the input array of XdmValue pointers

Returns an XdmArray whose members are XdmValue values corresponding one-to-one with the input.

SaxonProcessorMBS.makeAtomicValue(type as String, value as String) as XdmAtomicValueMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
ate an Xdm Atomic value from string representation.
Example
Var Processor As New SaxonProcessorMBS
Var v As Variant = 1234.56
Var a As XdmAtomicValueMBS = Processor.makeAtomicValue(v)
MessageBox a.toString

type: Local name of a type in the XML Schema namespace.
value: The value given in a string form.

In the case of a QName the value supplied must be in clark notation. {uri}local

Returns XdmValueMBS object.

See also:

SaxonProcessorMBS.makeAtomicValue(value as Variant) as XdmAtomicValueMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Creates an atomic value.
Example
Var Processor As New SaxonProcessorMBS
Var v As Variant = "Hello"
Var a As XdmAtomicValueMBS = Processor.makeAtomicValue(v)
Var t As String = a.toString
Break // shows Hello

Converts values to Atomic value. Supports string, text, date/datetime, UInt32, UInt64, Int64, Int32, Integer, Color, Boolean, Single and Double.

See also:

SaxonProcessorMBS.makeBooleanArray(input() as Boolean) as XdmArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Make an XdmArray whose members are xs:boolean values.
Example
Var Processor As New SaxonProcessorMBS
Var values() As Boolean = array(true, false, true)
Var a As XdmArrayMBS = Processor.makeBooleanArray(values)
Var t As String = a.toString
Break // shows [true(),false(),true()]

input: the input array of boolean values

Returns an XdmArrayMBS whose members are xs:boolean values corresponding one-to-one with the input.

SaxonProcessorMBS.makeBooleanValue(value as Boolean) as XdmAtomicValueMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Factory method to make a boolean value.
Example
Var Processor As New SaxonProcessorMBS
Var a As XdmAtomicValueMBS = Processor.makeBooleanValue(True)
Var t As String = a.toString
Break // shows true

Makes a XdmAtomicValue representing a boolean Value.

SaxonProcessorMBS.makeDoubleArray(input() as Double) as XdmArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Make an XdmArray whose members are xs:float values.
Example
Var Processor As New SaxonProcessorMBS
Var v() As Double
v.Add 0.1
v.Add 2.2
v.Add 99
Var a As XdmValueMBS = Processor.makeDoubleArray(v)
// shows [1.0e-1,2.2e0,9.9e1]
MessageBox a.toString

input: the input array of single values.

Returns an XdmArray whose members are xs:float values corresponding one-to-one with the input.

SaxonProcessorMBS.makeDoubleValue(value as Double) as XdmAtomicValueMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Factory method to create a double.
Example
Var Processor As New SaxonProcessorMBS
Var a As XdmAtomicValueMBS = Processor.makeDoubleValue(123)
MessageBox a.toString

Make an XdmAtomicValue from a primitive double value

SaxonProcessorMBS.makeInt16Array(input() as Int16) as XdmArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Make an XdmArray whose members are xs:short values
Example
Var Processor As New SaxonProcessorMBS
Var v() As Int16
v.Add 1
v.Add 2
v.Add -3
Var a As XdmValueMBS = Processor.makeInt16Array(v)
MessageBox a.toString // shows [1,2,-3]

input: the input array of short values

Returns an XdmArray whose members are xs:boolean values corresponding one-to-one with the input.

SaxonProcessorMBS.makeInt32Array(input() as Int32) as XdmArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Make an XdmArray whose members are xs:int values.
Example
Var Processor As New SaxonProcessorMBS
Var v() As Int32
v.Add 1
v.Add 2
v.Add 3
Var a As XdmValueMBS = Processor.makeInt32Array(v)
MessageBox a.toString // shows [1,2,3]

input: the input array of int values.

Returns an XdmArray whose members are xs:int values corresponding one-to-one with the input.

SaxonProcessorMBS.makeInt32Value(value as Int32) as XdmAtomicValueMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Factory method to make an integer.
Example
Var Processor As New SaxonProcessorMBS
Var s As Int32 = 123
Var a As XdmAtomicValueMBS = Processor.makeInt32Value(s)
Var t As String = a.toString
Break // shows 123

SaxonProcessorMBS.makeInt64Array(input() as Int64) as XdmArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Make an XdmArray whose members are xs:long values
Example
Var Processor As New SaxonProcessorMBS
Var v() As Int64 = Array(1,2,3,4)
Var a As XdmValueMBS = Processor.makeInt64Array(v)
MessageBox a.toString // shows [1,2,3,4]

input: the input array of long values

Returns an XdmArray whose members are xs:long values corresponding one-to-one with the input.

SaxonProcessorMBS.makeInt64Value(value as Int64) as XdmAtomicValueMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Ractory method to make a Int64 value.
Example
Var Processor As New SaxonProcessorMBS
Var s As XdmAtomicValueMBS = Processor.makeInt64Value(123)
Var t As String = s.StringValue
Var v As Variant = s.Value
Var i As Int64 = s.LongValue
Break

makes either an Int64Value or a BigIntegerValue depending on the value supplied.

SaxonProcessorMBS.makeIntegerArray(input() as Integer) as XdmArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Make an XdmArray whose members are xs:long or xs:int values
Example
Var Processor As New SaxonProcessorMBS
Var v() As Integer = Array(1,2,3,4)
Var a As XdmValueMBS = Processor.makeIntegerArray(v)
MessageBox a.toString // shows [1,2,3,4]

input: the input array of integer values

Either uses makeInt64Array or makeInt32Array internally depending on whether this is 32-bit or 64-bit application.

SaxonProcessorMBS.makeIntegerValue(value as Integer) as XdmAtomicValueMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Makes an integer value.
Example
Var Processor As New SaxonProcessorMBS
Var s As Int32 = 123
Var a As XdmAtomicValueMBS = Processor.makeIntegerValue(s)
Var t As String = a.toString
Break // shows 123

Internally uses makeInt32Value or makeInt64Value depending on whether the application is 32-bit or 64-bit.

SaxonProcessorMBS.makeMap(dataMap as Dictionary) as XdmMapMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Make an XdmMap whose argument is a map from the dictionary.
Example
Var Processor As New SaxonProcessorMBS
Var map As New Dictionary
map.Value("test") = Processor.makeStringValue("Hello")
map.Value("other") = "World"
map.Value(Processor.makeIntegerValue(123)) = True
Var m As XdmMapMBS = Processor.makeMap(map)
Var s As String = m.toString
Break // map{"other":"World","test":"Hello",123:true()}

dataMap: is dictionary, which consists of keys as XdmAtomicValueMBS and value is XdmValueMBS.

Returns an XdmMap whose members are key, value pair given as (XdmAtomicValue, XdmValue)

For your convenience we convert various data types to XdmAtomicValueMBS automatically using makeAtomicValue method.

Also for your convenience any value in the dictionary not being a XdmValueMBS is converted to XdmValueMBS using makeValue() function.

SaxonProcessorMBS.makeObjectArray(input() as Object) as XdmArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Creates an array from an array of objects.
Example
Var Processor As New SaxonProcessorMBS
Var values() As Object
values.add Processor.makeValue(123)
values.add Processor.makeValue("Hello")
values.add Processor.makeValue(True)
values.add Processor.makeValue(Array(1,2,3))
Var a As XdmArrayMBS = Processor.makeObjectArray(values)
var t as string = a.toString
Break // shows [123,"Hello",true(),[1,2,3]]

Uses makeValue internally to convert variant values to XdmValue.

SaxonProcessorMBS.makeQNameValue(value as String) as XdmAtomicValueMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Create an QName Xdm value from string representation in clark notation
Example
Var Processor As New SaxonProcessorMBS
Var a As XdmAtomicValueMBS = Processor.makeQNameValue("Hello")
Var s As String = a.toString
Break // s is Hello

value: The value given in a string form in clark notation. {uri}local

Returns XdmAtomicValueMBS object.

SaxonProcessorMBS.makeSingleArray(input() as Single) as XdmArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Make an XdmArray whose members are xs:double values.
Example
Var Processor As New SaxonProcessorMBS
Var v() As Single
v.Add 0.1
v.Add 2.2
v.Add 99
Var a As XdmValueMBS = Processor.makeSingleArray(v)
// shows [xs:float("0.1"),xs:float("2.2"),xs:float("99")]
MessageBox a.toString
Break

input: the input array of double values.

Returns an XdmArray whose members are xs:double values corresponding one-to-one with the input.

SaxonProcessorMBS.makeSingleValue(value as Single) as XdmAtomicValueMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Factory method to make a float value.
Example
Var Processor As New SaxonProcessorMBS
Var s As Single = 123.45
Var a As XdmAtomicValueMBS = Processor.makeSingleValue(s)
Var t As String = a.toString
Break // shows 123.45

Make an XdmAtomicValue from a primitive float value.

SaxonProcessorMBS.makeStringArray(input() as String) as XdmArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Make an XdmArray whose members are xs:string values
Example
Var Processor As New SaxonProcessorMBS
Var v() As String
v.Add "Hello"
v.add "World"
Var a As XdmValueMBS = Processor.makeStringArray(v)
// shows ["Hello","World"]
MessageBox a.toString
Break

input: the input array of string values

Returns an XdmArray whose members are xs:string values corresponding one-to-one with the input.

SaxonProcessorMBS.makeStringValue(value as String, encoding as String = "") as XdmAtomicValueMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Factory method to create string.
Example
Var Processor As New SaxonProcessorMBS
Var s As XdmAtomicValueMBS = Processor.makeStringValue("Hello")
Var t As String = s.StringValue
Break

Unlike the constructor, this avoids creating a new StringValue in the case of a zero-length string (and potentially other strings, in future)

value: the String value.
encoding: the encoding of the string. If not specified then the platform default encoding is used.

SaxonProcessorMBS.makeValue(value as Variant) as XdmValueMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Saxon MBS XML Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No All
Converts a value.
Example
Var Processor As New SaxonProcessorMBS

Var v As Variant = 123.45
Var a As XdmValueMBS = Processor.makeValue(v)
Var t As String = a.toString

Break

Converts values to XdmValueMBS internally:

  • nil value
  • Array of String
  • Array of Boolean
  • Array of Int32, Int64 or Integer
  • Array of Single/Double
  • Array of Object/Variant
  • String, OSType, Date, DateTime, Text
  • Int32
  • Int64, UInt32, Color
  • Single
  • Double, Currency, UInt64
  • Boolean
  • Object: Dictionary or XdmValueMBS

Raises exception for unsupported types. We could add more types if needed.

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.

Next items

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


The biggest plugin in space...