com.raritantechnologies.searchApp.alert
Class BasicAlertFormatter

java.lang.Object
  com.raritantechnologies.searchApp.alert.BasicAlertFormatter

All Implemented Interfaces:

IAlertFormatter, IConfigurable

public class BasicAlertFormatter

extends java.lang.Object

implements IAlertFormatter

Basic implementation of IAlertFormatter that returns a formatted page from a set of Alert result sets.

XML Configuration Template:

  <AlertFormatter class="com.raritantechnologies.searchApp.alert.BasicAlertFormatter"
                     templateFile="[ html template file ]"
                     labelTableClass="[ cssClass of label table ]"
                     labelClass="[ cssClass of label ]"
                     displayForm="[ name of DisplayForm ]" >

    <Columns>
      <Column Field="[ field name in result ]" type="[ field type href|text ]"   />

    </Columns>

    <!-- Alternately - can use an IDisplayFormRenderer -->
    <DisplayForm class="[ class of com.raritantechnologies.searchApp.taglibrary.IDisplayFormRenderer ]" >

    </DisplayForm>

  </AlertFormatter>
 

Developed by Raritan Technologies .

Author:

Chris Peterson

Constructor Summary

BasicAlertFormatter()

Method Summary

java.lang.String	getFormattedPage(OrderedMap alertResultSets, java.lang.String userName) returns a formatted page of results from a set of alert result sets.
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicAlertFormatter

public BasicAlertFormatter()

Method Detail

getFormattedPage

public java.lang.String getFormattedPage(OrderedMap alertResultSets,
                                         java.lang.String userName)

returns a formatted page of results from a set of alert result sets.

Specified by:

getFormattedPage in interface IAlertFormatter

Parameters:

alertResultSets - Map of alert name to IResultSet with alert results.

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