com.raritantechnologies.verity
Class SimpleQueryCooker

java.lang.Object
  extended bycom.raritantechnologies.verity.SimpleQueryCooker
All Implemented Interfaces:
IQueryCooker

public class SimpleQueryCooker
extends java.lang.Object
implements IQueryCooker

Simple Verity QueryCooker Implementation - just returns value of a set query Parameter. Use this query cooker in cases where query is already formatted.

XML Configuration Template:
    <QueryCooker class="com.raritantechnologies.verity.SimpleQueryCooker"
                    queryParam="[ field to be extracted for query ]" />
 

Developed by Raritan Technologies .

Author:
Ted Sullivan, Glenn Robitaille

Constructor Summary
SimpleQueryCooker()
           
SimpleQueryCooker(java.lang.String queryParam)
           
 
Method Summary
 java.lang.String getHighlightQuery(java.lang.String[] searchSources, OrderedMap queryParams, ISearchFieldMap searchMap, ILoginInfo userInfo)
          returns a query suitable for use with Verity highlighting processes.
 java.lang.String getSourceQuery(java.lang.String[] searchSources, OrderedMap queryParams, ISearchFieldMap searchMap, ILoginInfo userInfo)
          returns a Verity Query Language (VQL) Source Query.
 java.lang.String getVerityQuery(java.lang.String[] searchSources, OrderedMap queryParams, ISearchFieldMap searchMap, ILoginInfo userInfo)
          returns a Verity Query Language (VQL) string for the form parameters submitted in queryParams.
 void initialize(org.w3c.dom.Element elem)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SimpleQueryCooker

public SimpleQueryCooker()

SimpleQueryCooker

public SimpleQueryCooker(java.lang.String queryParam)
Method Detail

getVerityQuery

public java.lang.String getVerityQuery(java.lang.String[] searchSources,
                                       OrderedMap queryParams,
                                       ISearchFieldMap searchMap,
                                       ILoginInfo userInfo)
Description copied from interface: IQueryCooker
returns a Verity Query Language (VQL) string for the form parameters submitted in queryParams. The Search sources are needed to map the input params to the verity collection fields. This mapping can be different for different search sources.

Specified by:
getVerityQuery in interface IQueryCooker

getSourceQuery

public java.lang.String getSourceQuery(java.lang.String[] searchSources,
                                       OrderedMap queryParams,
                                       ISearchFieldMap searchMap,
                                       ILoginInfo userInfo)
Description copied from interface: IQueryCooker
returns a Verity Query Language (VQL) Source Query.

Specified by:
getSourceQuery in interface IQueryCooker

getHighlightQuery

public java.lang.String getHighlightQuery(java.lang.String[] searchSources,
                                          OrderedMap queryParams,
                                          ISearchFieldMap searchMap,
                                          ILoginInfo userInfo)
Description copied from interface: IQueryCooker
returns a query suitable for use with Verity highlighting processes.

Specified by:
getHighlightQuery in interface IQueryCooker

initialize

public void initialize(org.w3c.dom.Element elem)
Specified by:
initialize in interface IQueryCooker