com.raritantechnologies.searchApp.browse
Class XMLBrowseListWriter

java.lang.Object
  com.raritantechnologies.searchApp.browse.FileBrowseListWriter
      com.raritantechnologies.searchApp.browse.XMLBrowseListWriter

All Implemented Interfaces:

IBrowseListWriter, IConfigurable

public class XMLBrowseListWriter

extends FileBrowseListWriter

Implementation of IBrowseListWriter that writes Browse entries to an XML file.

XML Configuration Template

  <BrowseListWriter class="com.raritantechnologies.searchApp.browse.XMLBrowseListWriter"
                       outputFile="[ name of file to store browse list XML ]" />
 

XML Format: (single file version)

   <browse_list field="[ name of term field e.g. 'Name' ]" >
     <source name="[ name of browse source ]" >
       <field name="[ name of browse field ]" >
         <page num="[ 1 .. n pages ]" >
           <term display="[ display value ]" value="[ value ]" />
           <!-- etc... -->
         </page>

         <page num="[ 1 .. n pages ]" >
           <term display="[ display value ]" value="[ value ]" />
           <!-- etc... -->
         </page>
       </field>
     </source>
   </browse_list>

 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

Fields inherited from class com.raritantechnologies.searchApp.browse.FileBrowseListWriter

displayMap, sourceMap

Constructor Summary

XMLBrowseListWriter()

Method Summary

void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	saveBrowseList()

Methods inherited from class com.raritantechnologies.searchApp.browse.FileBrowseListWriter

addBrowseItem, getBrowseCounts

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLBrowseListWriter

public XMLBrowseListWriter()

Method Detail

saveBrowseList

public void saveBrowseList()

Specified by:

saveBrowseList in interface IBrowseListWriter

Overrides:

saveBrowseList in class FileBrowseListWriter

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

Overrides:

initialize in class FileBrowseListWriter