XMLRuleProcessor

An XML rule processor.

Go to Property Listing | Method Listing

Methods:

endProcessingRuleSet, extractLabel, findNextMatch, getElements, halt, insertLabel, remove, skipChildren, startProcessingRuleSet, startProcessingSubtree, toSource, toSpecifier

Objects:

Boolean, Number, Object, String

Property Listing

Property	Type	Access	Description
halted	Boolean	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.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
label	String	read/write	A property that can be set to any string.
parent	Application	readonly	The parent of the XMLRuleProcessor (a Application).
properties	Object	read/write	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.

Method Listing

undefined 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.

XMLRuleMatchData findNextMatch ()

Finds the next matching XML element.

XMLRuleProcessor getElements ()

Resolves the object specifier, creating an array of object references.

undefined halt ()

Halt the XML rule processor.

undefined 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.

undefined remove ()

Deletes the XMLRuleProcessor.

undefined skipChildren ()

Do not process XML elements (children) of the current XML element.

XMLRuleMatchData startProcessingRuleSet (initialElement:XMLElement)

Start processing an XML rule set.

Parameter	Type	Description
initialElement	XMLElement	The XML element at which to start processing the rule set.

XMLRuleMatchData startProcessingSubtree ()

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.

Object of

XMLRuleMatchData.parent