com.raritantechnologies.searchApp.queryFilters
Class PhraseQueryParser

java.lang.Object
  com.raritantechnologies.searchApp.queryFilters.PhraseQueryParser

All Implemented Interfaces:

IConfigurable, IQueryParser

public class PhraseQueryParser

extends java.lang.Object

implements IQueryParser

Combines multiple fields into phrases. Used in situations where a nested complex form element needs to be translated to a single query value.

XML Configuration Template:

  <QueryParser class="com.raritantechnologies.searchApp.queryFilters.PhraseQueryParser" >

    <Fields>
      <Field outputID="[ name of destination field ID ]" >

          <!-- one or more Field elements: to combine input fields, use the same output field name -->
          <Segment inputID="[ fieldID ]"  />
          <Segment value=" some constant " />
          <Segment inputID="[ fieldID2 ]" />

      </Field>
    </Fields>

  </QueryParser>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

PhraseQueryParser()

Method Summary

java.lang.String	createQuery(OrderedMap params, java.lang.String language, ILoginInfo userInfo)
java.util.List	getErrors() Returns the errors that occurred during the translate() step.
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
OrderedMap	parse(OrderedMap params, ILoginInfo loginInfo)
OrderedMap	parse(OrderedMap params, java.lang.String language, ILoginInfo loginInfo) Translate using the input parameters if this is how the query is passed.
void	setLanguage(java.lang.String language)
void	setSessionID(java.lang.String sessionID) Allows QueryParser object to access the sessionData.

Methods inherited from class java.lang.Object

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

Constructor Detail

PhraseQueryParser

public PhraseQueryParser()

Method Detail

parse

public OrderedMap parse(OrderedMap params,
                        java.lang.String language,
                        ILoginInfo loginInfo)
                 throws QueryParseException,
                        UnsupportedLanguageException

Description copied from interface: IQueryParser

Translate using the input parameters if this is how the query is passed.

Specified by:

parse in interface IQueryParser

Parameters:

params - An ordered map containing the query parameters

language - String representing the target language (e.g. VQL)

Throws:

QueryParseException

UnsupportedLanguageException

parse

public OrderedMap parse(OrderedMap params,
                        ILoginInfo loginInfo)

Specified by:

parse in interface IQueryParser

createQuery

public java.lang.String createQuery(OrderedMap params,
                                    java.lang.String language,
                                    ILoginInfo userInfo)
                             throws QueryParseException,
                                    UnsupportedLanguageException

Specified by:

createQuery in interface IQueryParser

Throws:

QueryParseException

UnsupportedLanguageException

setLanguage

public void setLanguage(java.lang.String language)

Specified by:

setLanguage in interface IQueryParser

getErrors

public java.util.List getErrors()

Description copied from interface: IQueryParser

Returns the errors that occurred during the translate() step.

Specified by:

getErrors in interface IQueryParser

Returns:

the list of error(s) (if any) that occurred.

setSessionID

public void setSessionID(java.lang.String sessionID)

Description copied from interface: IQueryParser

Allows QueryParser object to access the sessionData.

Specified by:

setSessionID in interface IQueryParser

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 IQueryParser