com.raritantechnologies.xml.filter
Class ProgrammableSAXSearchSourceFilter

java.lang.Object
  com.raritantechnologies.xml.filter.ProgrammableSAXSearchSourceFilter

All Implemented Interfaces:

IConfigurable, IStringFilter

public class ProgrammableSAXSearchSourceFilter

extends java.lang.Object

implements IStringFilter

Builds a query from an XML parse stream (adds parameters to an OrderedMap using IObjectModifier ). Executes the query against a delegate SearchSource. Returns XML of result set using XMLDisplayFormRenderer.

XML Configuration Template:

  <StringFilter class="com.raritantechnologies.xml.filter.ProgrammableSAXSearchSourceFilter" >

    <!-- Contains ElementModifiers that will be used to build the QueryMap -->
    <ProgrammableSAXFilter>

    </ProgrammableSAXFilter>

    <!-- ElementModifiers (see XMLResultProcessor -->
    <PageSizeExtractor callbackType="Attribute">
       <ParamName>Name</ParamName> 
       <AttributeName>attrInXML</AttributeName>
       <Comparator class="TagComparator" >
         <TagName>Name</TagName>
       </Comparator>
    </PageSizeExtractor>

    <StartRecExtractor callbackType="CData">
       <ParamName>Name</ParamName> 
       <Comparator class="TagComparator" >
         <TagName>Name</TagName>
       </Comparator>
    </StartRecExtractor>

  </StringFilter>
 

Field Summary

Fields inherited from interface com.raritantechnologies.utils.filter.IStringFilter

TEMPLATE

Constructor Summary

ProgrammableSAXSearchSourceFilter()

Method Summary

java.lang.String	filterString(java.util.Map parameters, java.lang.String inputString)
java.lang.String	filterString(java.lang.String inputString)
java.lang.String	filterString(java.lang.String sessionID, java.lang.String inputString)
java.lang.String	getConfigurationXML()
java.lang.String	getConfigurationXML(java.lang.String configurationTemplate)
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

ProgrammableSAXSearchSourceFilter

public ProgrammableSAXSearchSourceFilter()

Method Detail

filterString

public java.lang.String filterString(java.lang.String inputString)

Specified by:

filterString in interface IStringFilter

filterString

public java.lang.String filterString(java.util.Map parameters,
                                     java.lang.String inputString)

Specified by:

filterString in interface IStringFilter

filterString

public java.lang.String filterString(java.lang.String sessionID,
                                     java.lang.String inputString)

Specified by:

filterString in interface IStringFilter

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

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface IStringFilter

getConfigurationXML

public java.lang.String getConfigurationXML(java.lang.String configurationTemplate)

Specified by:

getConfigurationXML in interface IStringFilter