com.raritantechnologies.autonomy.category
Class AutonomyTreeBuilder

java.lang.Object
  com.raritantechnologies.autonomy.category.AutonomyTreeBuilder

All Implemented Interfaces:

IConfigurable, ITreeBuilder

public class AutonomyTreeBuilder

extends java.lang.Object

implements ITreeBuilder

Builds an RTI TreeRoot object from an IDOL Category tree,

TreeNode Attribute fields:

   booleanTrainingText
   fieldText
   language
   name
   trainingText

   Result Fields
       category Fields
       term   weight
       training Documents
 

Stores Term / Weights in a Result field where result "name" field = "QueryTerms" name="ModifiedTerms" name="GeneratedTerms" XML Configuration Template:

  <TreeBuilder class="com.raritantechnologies.autonomy.category.AutonomyTreeBuilder"
                  aciHost="[ IDOL host machine ]"
                  aciPort="[ IDOL aci port ]"
                  categoryID="[ ID of tree root node ]"
                  booleanTrainingAttribute="[ tree node attribute that gets boolean training field ]"
                  fieldTextAttribute="[ tree node attribute that gets category field text ]"
                  trainingTextAttribute="[ tree node attribute that gets training text field ]"
                  categoryPathAttribute="[ tree node attribute that gets category path ]"
                  addTermsNWeights="[ true(default)|false ]" >

      <!-- Stores category fields as result with a "name" field = "CategoryFields" -->
      <CategoryFields >
        <Field categoryName="[ name of category field ]" resultField="[ name of result field ]" />
      </CategoryFields>

  </TreeBuilder>
 

Field Summary

static java.lang.String	BOOLEAN_TRAINING_TEXT
static java.lang.String	FIELD_TEXT
static java.lang.String	LANGUAGE
static java.lang.String	NAME
static java.lang.String	TRAINING_TEXT

Fields inherited from interface com.raritantechnologies.utils.tree.ITreeBuilder

TEMPLATE

Constructor Summary

AutonomyTreeBuilder()

Method Summary

TreeRoot	buildTree(RaritanPageContext pContext)
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
TreeRoot	refreshTree(TreeRoot tree, RaritanPageContext pContext) Method to enable dynamic or refreshable trees.

Methods inherited from class java.lang.Object

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

Field Detail

BOOLEAN_TRAINING_TEXT

public static final java.lang.String BOOLEAN_TRAINING_TEXT

See Also:

Constant Field Values

FIELD_TEXT

public static final java.lang.String FIELD_TEXT

See Also:

Constant Field Values

LANGUAGE

public static final java.lang.String LANGUAGE

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

TRAINING_TEXT

public static final java.lang.String TRAINING_TEXT

See Also:

Constant Field Values

Constructor Detail

AutonomyTreeBuilder

public AutonomyTreeBuilder()

Method Detail

buildTree

public TreeRoot buildTree(RaritanPageContext pContext)

Specified by:

buildTree in interface ITreeBuilder

refreshTree

public TreeRoot refreshTree(TreeRoot tree,
                            RaritanPageContext pContext)

Description copied from interface: ITreeBuilder

Method to enable dynamic or refreshable trees. Static tree builders should implement this by returning the passed in tree object. Dynamic tree builders should implement this by returning the output of their buildTree( ) method or by pruning/growing the given tree as appropriate.

ITreeBuilders that support "lazy tree node evaluation" should use this method to determine which nodes in the tree need to be updated (TreeNode.needsUpdate( ) method returns true.

Specified by:

refreshTree in interface ITreeBuilder

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 IConfigurable