com.raritantechnologies.rql
Class RQLParser

java.lang.Object
  com.raritantechnologies.rql.RQLParser

All Implemented Interfaces:

IConfigurable, IStringFilter

public class RQLParser

extends java.lang.Object

implements IStringFilter

This is the API layer to parse a Raritan Query Language string The syntax is taken from Lucene: http://jakarta.apache.org/lucene/docs/queryparsersyntax.html. Can output it in VQL (Verity Query Language).

XML Configuration Template:

   <StringFilter class="com.raritantechnologies.rql.RQLParser"
                    analyzerClass="[ Lucene analyzer class - StandardAnalyzer is default ]"
                    defaultField="[ default field for fielded searching ]"
                    suppressDefault="[true|false(default)] "  >

     <RQLFormatter class="[ class of com.raritantechnologies.rql.IRQLFormatter ]" >

     </RQLFormatter>

   </StringFilter>
 

Developed by Raritan Technologies Inc..

Author:

Kepler Gelotte

Field Summary

protected java.lang.String	analyzerClass
protected java.lang.String	defaultField
protected java.lang.String	message
protected Query	query
protected java.lang.String	rqlQuery
protected boolean	suppressDefault

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

TEMPLATE

Constructor Summary

RQLParser()

RQLParser(org.w3c.dom.Element elem)

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)
java.lang.String	getDefaultField()
java.lang.String	getMessage()
java.lang.String	getQuery()
boolean	getSuppressDefault()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
static void	main(java.lang.String[] args)
boolean	parseQuery()
void	setDefaultField(java.lang.String field)
void	setQuery(java.lang.String query)
void	setSuppressDefault(boolean state)
java.lang.String	toVQL()
java.lang.String	toVQL(Query query)

Methods inherited from class java.lang.Object

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

Field Detail

suppressDefault

protected boolean suppressDefault

rqlQuery

protected java.lang.String rqlQuery

defaultField

protected java.lang.String defaultField

message

protected java.lang.String message

query

protected Query query

analyzerClass

protected java.lang.String analyzerClass

Constructor Detail

RQLParser

public RQLParser()

RQLParser

public RQLParser(org.w3c.dom.Element elem)

Method Detail

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

filterString

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

Specified by:

filterString in interface IStringFilter

setQuery

public void setQuery(java.lang.String query)

getQuery

public java.lang.String getQuery()

getDefaultField

public java.lang.String getDefaultField()

setDefaultField

public void setDefaultField(java.lang.String field)

getSuppressDefault

public boolean getSuppressDefault()

setSuppressDefault

public void setSuppressDefault(boolean state)

getMessage

public java.lang.String getMessage()

parseQuery

public boolean parseQuery()

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

toVQL

public java.lang.String toVQL()

toVQL

public java.lang.String toVQL(Query query)

main

public static void main(java.lang.String[] args)