com.raritantechnologies.searchApp.query
Class FlatFileQueryResultSetWriter

java.lang.Object
  com.raritantechnologies.searchApp.query.FlatFileQueryResultSetWriter

All Implemented Interfaces:

IConfigurable, IQueryResultSetWriter

public class FlatFileQueryResultSetWriter

extends java.lang.Object

implements IQueryResultSetWriter

Uses a Flat File to store queries.

XML Configuration Template:

  <QueryResultWriter class="com.raritantechnologies.searchApp.query.FlatFileQueryResultSetWriter"
                        filePath="[path to the saved file]" >

    <!-- Optional QueryParser that will transform the query prior to saving to flat file -->
    <QueryParser class="[ class of com.raritantechnologies.searchApp.IQueryParser ]" >

    </QueryParser>

    <QueryResultRenderer delimiter="|" >
      <Param ID="SessionID" />  
      <Param ID="UserName" />
      <Param ID="DocumentTitle" />
      <Param ID="k2dockey" />
    </QueryResultRenderer>

  </QueryResultWriter>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.query.IQueryResultSetWriter

ADHOC, APPLICATION_NAME, DATE, IGNORE_COLUMN, PAGE_SIZE, QUERY_ID, QUERY_NAME, RESP_TIME, ROLE_NAME, SESSION_ID, SOURCE_NAMES, START_REC, TOTAL_DOCS, USER_NAME

Constructor Summary

FlatFileQueryResultSetWriter()

Method Summary

void	deleteQuery(RaritanPageContext pageContext, java.lang.Integer queryID)
void	deleteQuery(RaritanPageContext pageContext, java.util.Map Params)
java.lang.Integer	getNextID()
java.lang.String[]	getSavedFields()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	modifyQuery(RaritanPageContext pageContext, QueryResultBean queryResultBean) modify Query read queries into QueryResultBeanSet - modify the query, save QueryResultBeanSet
void	modifyQuery(RaritanPageContext pageContext, java.lang.String queryID, java.util.HashMap params)
void	modifyQuery(RaritanPageContext pageContext, java.lang.String queryID, java.lang.String paramName, java.lang.String paramValue, boolean isAdhocParam)
void	saveQueries(RaritanPageContext pageContext, QueryResultBeanSet querySet)
void	saveQuery(RaritanPageContext pageContext, QueryResultBean query)
void	setQueryParser(IQueryParser queryParser) Set the queryParser to be used to transform the query before it is written to the persistent source.
void	setSavedFields(java.lang.String[] savedFields)

Methods inherited from class java.lang.Object

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

Constructor Detail

FlatFileQueryResultSetWriter

public FlatFileQueryResultSetWriter()

Method Detail

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 IQueryResultSetWriter

setQueryParser

public void setQueryParser(IQueryParser queryParser)

Description copied from interface: IQueryResultSetWriter

Set the queryParser to be used to transform the query before it is written to the persistent source.

Specified by:

setQueryParser in interface IQueryResultSetWriter

getNextID

public java.lang.Integer getNextID()

Specified by:

getNextID in interface IQueryResultSetWriter

saveQuery

public void saveQuery(RaritanPageContext pageContext,
                      QueryResultBean query)

Specified by:

saveQuery in interface IQueryResultSetWriter

saveQueries

public void saveQueries(RaritanPageContext pageContext,
                        QueryResultBeanSet querySet)

Specified by:

saveQueries in interface IQueryResultSetWriter

modifyQuery

public void modifyQuery(RaritanPageContext pageContext,
                        QueryResultBean queryResultBean)

modify Query read queries into QueryResultBeanSet - modify the query, save QueryResultBeanSet

Specified by:

modifyQuery in interface IQueryResultSetWriter

modifyQuery

public void modifyQuery(RaritanPageContext pageContext,
                        java.lang.String queryID,
                        java.lang.String paramName,
                        java.lang.String paramValue,
                        boolean isAdhocParam)

Specified by:

modifyQuery in interface IQueryResultSetWriter

modifyQuery

public void modifyQuery(RaritanPageContext pageContext,
                        java.lang.String queryID,
                        java.util.HashMap params)

Specified by:

modifyQuery in interface IQueryResultSetWriter

deleteQuery

public void deleteQuery(RaritanPageContext pageContext,
                        java.lang.Integer queryID)

Specified by:

deleteQuery in interface IQueryResultSetWriter

deleteQuery

public void deleteQuery(RaritanPageContext pageContext,
                        java.util.Map Params)

Specified by:

deleteQuery in interface IQueryResultSetWriter

getSavedFields

public java.lang.String[] getSavedFields()

Specified by:

getSavedFields in interface IQueryResultSetWriter

setSavedFields

public void setSavedFields(java.lang.String[] savedFields)

Specified by:

setSavedFields in interface IQueryResultSetWriter