com.raritantechnologies.vqlparser
Class VQLParserStringFilter

java.lang.Object
  com.raritantechnologies.vqlparser.VQLParserStringFilter

All Implemented Interfaces:

IConfigurable, IStringFilter

public class VQLParserStringFilter

extends java.lang.Object

implements IStringFilter

Normalizes a VQL string returning the search terms.

A VQL string is used as input. The query is run through the Lexer and Parse classes. This yields a Node object. The resulting query terms are extracted from the Node object and returned as a String.

Example (using default 'RulesValueString')

Input String: '((term1<in>metadata)<and>(term2<in>metadata))'

Output String: 'term1 term2'

XML Configuration Template:

    <StringFilter 
        class="com.raritantechnologies.vqlparser.VQLParserStringFilter" 
        outputFormat="RulesValueString" >

    </StringFilter>
 
    or use the setOutputFormat method as follows:
    
    VQLParserStringFilter vpsf = new VQLParserStringFilter();

    vpsf.setOutputFormat("RulesValueString");
    
  Supported outputs:
  RulesValueString (default)
  ToEnglishString
    
 

Developed by Raritan Technologies Inc..

Author:

Ron Pohle

Field Summary

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

TEMPLATE

Constructor Summary

VQLParserStringFilter()

Method Summary

java.lang.String	filterString(java.util.Map parameters, java.lang.String inputString)
java.lang.String	filterString(java.lang.String inputString) Accepts a VQL string and returns query terms.
java.lang.String	filterString(java.lang.String sessionID, java.lang.String inputString)
java.lang.String	getConfigurationXML()
java.lang.String	getConfigurationXML(java.lang.String configurationTemplate)
java.lang.String	getOutputFormat()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	setOutputFormat(java.lang.String format)

Methods inherited from class java.lang.Object

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

Constructor Detail

VQLParserStringFilter

public VQLParserStringFilter()

Method Detail

filterString

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

Accepts a VQL string and returns query terms.

'((term1<in>metadata)<and>(term2<in>metadata))'

returns

'term1 term2'

Specified by:

filterString in interface IStringFilter

Parameters:

inputString - A VQL string.

filterString

public java.lang.String filterString(java.lang.String sessionID,
                                     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

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

setOutputFormat

public void setOutputFormat(java.lang.String format)

getOutputFormat

public java.lang.String getOutputFormat()