com.raritantechnologies.utils.tree
Class TreeBuilderGateway

java.lang.Object
  com.raritantechnologies.utils.tree.TreeBuilderGateway

All Implemented Interfaces:

ICollectionGateway, java.lang.Runnable

public class TreeBuilderGateway

extends java.lang.Object

implements ICollectionGateway

Uses an ITreeBuilder to generate a set of results for processing.

XML Configuration Template:

 <CollectionGateway name="[ collection gateway name ]" 
      class="com.raritantechnologies.utils.tree.TreeBuilderGateway"
      idField="[ name to assign to ID field ]"
      nameField="[ result field name for tree node name ]"
      pathField="[ result field name for tree node path ]"
      includeRoot="[ true(default)|false ]" 
      maxLevel="[ maximum depth of tree to get ]" >

    <TreeBuilder class="[ class of ITreeBuilder ]" >
      <!-- Initialization parameters for TreeBuilder -->
    </TreeBuilder>

    <!-- Optional IResultMatcher to filter Tree nodes going into the output result set -->
    <ResultMatcher class="[ class of com.raritantechnologies.searchApp.IResultMatcher ]" >

    </ResultMatcher>

    <FieldFormatters>
      <!-- One or more Formatter elements -->
      <Formatter class="[ class of IFieldFormatter ]" >

      </Formatter>
    </FieldFormatters>

    <!-- Optional ITreeProcessor that can process the Tree object -->
    <TreeProcessor class="class of com.raritantechnologies.utils.tree.ITreeProcessor ]" >

    </TreeProcessor>

 </CollectionGateway>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

TreeBuilderGateway()

Method Summary

java.lang.String	getConfigurationXML()
void	initialize(org.w3c.dom.Element gatewayElem, ISearchFieldMap sfMap) Initialize the ICollectionGateway from a Configuration XML element.
boolean	isPaused()
void	pause()
void	resume()
void	run()
void	run(ILoginInfo userInfo) Need to have loginInfo for sources which require login/pw access.
void	setGatewayListener(IGatewayListener listener) Sets the IGatewayListener interface.
void	setInputParameters(OrderedMap inputParams) set input parameters...

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TreeBuilderGateway

public TreeBuilderGateway()

Method Detail

setInputParameters

public void setInputParameters(OrderedMap inputParams)

Description copied from interface: ICollectionGateway

set input parameters...

Specified by:

setInputParameters in interface ICollectionGateway

run

public void run(ILoginInfo userInfo)

Description copied from interface: ICollectionGateway

Need to have loginInfo for sources which require login/pw access.

Specified by:

run in interface ICollectionGateway

setGatewayListener

public void setGatewayListener(IGatewayListener listener)

Description copied from interface: ICollectionGateway

Sets the IGatewayListener interface.

Specified by:

setGatewayListener in interface ICollectionGateway

initialize

public void initialize(org.w3c.dom.Element gatewayElem,
                       ISearchFieldMap sfMap)

Initialize the ICollectionGateway from a Configuration XML element.

Specified by:

initialize in interface ICollectionGateway

run

public void run()

Specified by:

run in interface ICollectionGateway

pause

public void pause()

Specified by:

pause in interface ICollectionGateway

resume

public void resume()

Specified by:

resume in interface ICollectionGateway

isPaused

public boolean isPaused()

Specified by:

isPaused in interface ICollectionGateway

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface ICollectionGateway