com.raritantechnologies.verity.parametric.PIBuild
Class TaxDefGenerator

java.lang.Object
  com.raritantechnologies.verity.parametric.PIBuild.TaxDefGenerator

All Implemented Interfaces:

IConfigurable, IJobProcess, ITreeProcessor, ITreeXMLGenerator

public class TaxDefGenerator

extends java.lang.Object

implements IJobProcess, ITreeXMLGenerator, ITreeProcessor

JobProcess that generates a Verity 5.0 TaxDef XML File from a TreeRoot object. Will also generate an OTL file, and use terms from the nested IResultSet for additional rules.

XML Configuration Template:

Used as an ITreeProcessor:

  <TreeProcessor class="com.raritantechnologies.verity.parametric.PIBuild.TaxDefGenerator"
                    taxonomyName="[ name of taxonomy in output file ]"
                    fileName="[ name of TaxDef output file ]"
                    otlFileName="[ name of OTL file ]" >

    <!-- Set of result fields to be used as terms in OTL file -->
    <TermResultFields>
      <Field ID="[ id of result field to be included in OTL output ]" />
    </TermResultFields>

    <TermAttributes>
      <Attribute ID="[ id of TreeNode attribute to be included in OTL output ]" />
    </TermAttributes>

  </TreeProcessor>
 

Used as an IJobProcess:

  <JobProcess class="com.raritantechnologies.verity.parametric.PIBuild.TaxDefGenerator"
                 taxonomyName="[ name of taxonomy in output file ]"
                 fileName="[ name of TaxDef output file ]"
                 otlFileName="[ name of OTL file ]"
                 treeBuilder="[ name of ITreeBuilder SystemObject ]" >

    <!-- local specification of the ITreeBuilder -->
    <TreeBuilder class="[ class of ITreeBuilder ]" >

    </TreeBuilder>

    <!-- Set of result fields to be used as terms in OTL file -->
    <TermResultFields>
      <Field ID="[ id of result field to be included in OTL output ]" />
    </TermResultFields>

    <TermAttributes>
      <Attribute ID="[ id of TreeNode attribute to be included in OTL output ]" />
    </TermAttributes>

  </JobProcess>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

TaxDefGenerator()

TaxDefGenerator(java.lang.String taxonomyName, java.lang.String outputFilePath, ITreeBuilder treeBuilder)

Method Summary

void	executeJob(RaritanPageContext rpc)
void	executeJob(java.lang.String[] args)
java.lang.String	getConfigurationXML()
java.lang.String	getXML(TreeRoot tree) returns an XML string that represents data in a TreeRoot object.
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	processTree(TreeRoot tree)
java.lang.String	repeat(int N, java.lang.String character)

Methods inherited from class java.lang.Object

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

Constructor Detail

TaxDefGenerator

public TaxDefGenerator()

TaxDefGenerator

public TaxDefGenerator(java.lang.String taxonomyName,
                       java.lang.String outputFilePath,
                       ITreeBuilder treeBuilder)

Method Detail

getXML

public java.lang.String getXML(TreeRoot tree)

Description copied from interface: ITreeXMLGenerator

returns an XML string that represents data in a TreeRoot object.

Specified by:

getXML in interface ITreeXMLGenerator

repeat

public java.lang.String repeat(int N,
                               java.lang.String character)

processTree

public void processTree(TreeRoot tree)

Specified by:

processTree in interface ITreeProcessor

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

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface IJobProcess