An XML rule processor.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| halted | bool | readonly | If true, the XML rule process has halted. |
| id | number | readonly | The unique ID of the XMLRuleProcessor. |
| index | number | readonly | The index of the XMLRuleProcessor within its containing object. |
| label | string | r/w | A property that can be set to any string. |
| parent | Application | readonly | The parent of the XMLRuleProcessor (a Application). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rulePaths | Array of string | readonly | The XPath condition paths of the rules in the rule set. |
Methods
void endProcessingRuleSet ()
Stop processing XML rule set.
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
XMLRuleMatchDatafindNextMatch ()
Finds the next matching XML element.
Array of XMLRuleProcessorgetElements ()
Resolves the object specifier, creating an array of object references.
void halt ()
Halt the XML rule processor.
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
void remove ()
Deletes the XMLRuleProcessor.
void skipChildren ()
Do not process XML elements (children) of the current XML element.
XMLRuleMatchDatastartProcessingRuleSet (initialElement:
XMLElement)
Start processing an XML rule set.
| Parameter | Type | Description |
|---|---|---|
| initialElement | XMLElement | The XML element at which to start processing the rule set. |
XMLRuleMatchDatastartProcessingSubtree ()
Process the XML elements of the current XML element.
string toSource ()
Generates a string which, if executed, will return the XMLRuleProcessor.
string toSpecifier ()
Retrieves the object specifier.
Element of:
XMLRuleMatchData.parent
Used in:
XMLRuleProcessors.previousItem (
obj:
XMLRuleProcessor )
XMLRuleProcessors.nextItem (
obj:
XMLRuleProcessor )
Returned by:
Array of XMLRuleProcessor XMLRuleProcessor .getElements (
)
XMLRuleProcessor XMLRuleProcessors.add (
rulePaths:
Array of string[, prefixMappingTable:
Array of any][, withProperties:
Object]
)
XMLRuleProcessor XMLRuleProcessors.anyItem (
)
Array of XMLRuleProcessor XMLRuleProcessors.everyItem (
)
XMLRuleProcessor XMLRuleProcessors.firstItem (
)
XMLRuleProcessor XMLRuleProcessors.item (
index:
any
)
XMLRuleProcessor XMLRuleProcessors.itemByID (
id:
number
)
XMLRuleProcessor XMLRuleProcessors.itemByName (
name:
string
)
Array of XMLRuleProcessor XMLRuleProcessors.itemByRange (
from:
any, to:
any
)
XMLRuleProcessor XMLRuleProcessors.lastItem (
)
XMLRuleProcessor XMLRuleProcessors.middleItem (
)
XMLRuleProcessor XMLRuleProcessors.nextItem (
obj:
XMLRuleProcessor
)
XMLRuleProcessor XMLRuleProcessors.previousItem (
obj:
XMLRuleProcessor
)