com.raritantechnologies.utils.tree
Class TreeBuilderProcess

java.lang.Object
  extended bycom.raritantechnologies.utils.tree.TreeBuilderProcess
All Implemented Interfaces:
IConfigurable, IJobProcess

public class TreeBuilderProcess
extends java.lang.Object
implements IJobProcess

JobProcess that uses an ITreeBuilder to create a Tree object and persist it to a file or database.

XML Configuration Template:
  <JobProcess class="com.raritantechnologies.utils.tree.TreeBuilderProcess"
                   outputFileName="[ file name if Tree is to be persisted as an XML file (if only one)]"
                 DBConnectionManager="[ name of Database connection manager if tree is persisted in database ]"
                 useNodeIDAsKey="[ true | false(default) - relevant for DB persistence ]" >

    <TreeBuilder class="[ class of com.raritantechnologies.utils.tree.ITreeBuilder ]" >

    </TreeBuilder>

    <OutputProcessor outputFileName="[ file name if Tree is to be persisted as an XML file]"
                 DBConnectionManager="[ name of Database connection manager if tree is persisted in database ]"
                 useNodeIDAsKey="[ true | false(default) - relevant for DB persistence ]">
      <TreeFilter>

        <!-- One or more NodeFilter elements -->
        <NodeFilter class="[ class of com.raritantechnologies.utils.tree.filter.ITreeNodeFilter ]" >

        </NodeFilter>

        <!-- etc ... -->

      </TreeFilter>

      <TreeXMLGenerator class="[ class of com.raritantechnologies.utils.tree.ITreeXMLGenerator ]" >
          <!-- configuration parameters for ITreeXMLGenerator -->
      </TreexMLGenerator>

      <!-- Alternatively - one or more ITreeProcessor implementations to deal with the tree output -->
      <TreeProcessor class="[ class of com.raritantechnologies.utils.tree.ITreeProcessor ]" >

      </TreeProcessor>

   </OutputProcessor>

  </JobProcess>
 

Developed by Raritan Technologies Inc..

Author:
Ted Sullivan

Constructor Summary
TreeBuilderProcess()
           
 
Method Summary
 void executeJob(RaritanPageContext rpc)
           
 void executeJob(java.lang.String[] args)
           
 java.lang.String getConfigurationXML()
           
 void initialize(org.w3c.dom.Element elem)
          Initializes the object from an XML tag or element.
static void main(java.lang.String[] args)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TreeBuilderProcess

public TreeBuilderProcess()
Method Detail

executeJob

public void executeJob(java.lang.String[] args)
Specified by:
executeJob in interface IJobProcess

executeJob

public void executeJob(RaritanPageContext rpc)
Specified by:
executeJob in interface IJobProcess

initialize

public void initialize(org.w3c.dom.Element elem)
Description copied from interface: IConfigurable
Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:
initialize in interface IJobProcess

main

public static void main(java.lang.String[] args)

getConfigurationXML

public java.lang.String getConfigurationXML()
Specified by:
getConfigurationXML in interface IJobProcess