Rule Execution Server API

ilog.rules.xml
Class IlrXmlObjectExplorer

java.lang.Object
  extended by ilog.rules.xml.IlrXmlObjectExplorer
Direct Known Subclasses:
IlrXmlObjectAsserter

public class IlrXmlObjectExplorer
extends Object

The class explores an xml object tree in order to apply some processing on selected nodes. The exploration is recursively done through

  • collection attributes (Vector types) of XML objects,
  • reference attributes on other XML objects.
  • Once an object is selected by the selector, it is processed by the processor. It could happen that a node may be explored but not selected by the explorer.

    See Also:
    IlrXmlObjectExplorer.IlrObjectSelector, IlrXmlObjectExplorer.IlrObjectProcessor, IlrXmlObjectAsserter, IlrXmlObject

    Nested Class Summary
    static interface IlrXmlObjectExplorer.IlrObjectProcessor
              This interface defines an abstract processor of Java instances.
    static interface IlrXmlObjectExplorer.IlrObjectSelector
              This interface defines an abstract selector of Java instances.
     
    Field Summary
    protected  ilog.rules.xml.util.IlrXmlTreeExplorer explorer
               
    protected  IlrXmlObjectExplorer.IlrObjectProcessor processor
               
    protected  IlrXmlObjectExplorer.IlrObjectSelector selector
               
     
    Constructor Summary
    IlrXmlObjectExplorer()
              Default constructor.
     
    Method Summary
     Object exploreObject(Object object)
              Activates the effective exploration of the XML tree.
     IlrXmlObjectExplorer.IlrObjectProcessor getProcessor()
               
     IlrXmlObjectExplorer.IlrObjectSelector getSelector()
               
     void setProcessor(IlrXmlObjectExplorer.IlrObjectProcessor processor)
               
     void setSelector(IlrXmlObjectExplorer.IlrObjectSelector selector)
               
     
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
     

    Field Detail

    selector

    protected IlrXmlObjectExplorer.IlrObjectSelector selector

    processor

    protected IlrXmlObjectExplorer.IlrObjectProcessor processor

    explorer

    protected ilog.rules.xml.util.IlrXmlTreeExplorer explorer
    Constructor Detail

    IlrXmlObjectExplorer

    public IlrXmlObjectExplorer()
    Default constructor.

    Method Detail

    setSelector

    public void setSelector(IlrXmlObjectExplorer.IlrObjectSelector selector)

    setProcessor

    public void setProcessor(IlrXmlObjectExplorer.IlrObjectProcessor processor)

    getSelector

    public IlrXmlObjectExplorer.IlrObjectSelector getSelector()

    getProcessor

    public IlrXmlObjectExplorer.IlrObjectProcessor getProcessor()

    exploreObject

    public Object exploreObject(Object object)
    Activates the effective exploration of the XML tree.

    Parameters:
    object - The XML tree root to be explored.
    Returns:
    The processing result.

    Rule Execution Server API

    © Copyright IBM Corp. 1987, 2013