com.raritantechnologies.searchApp.query
Interface IQueryResultSetWriter

All Superinterfaces:

IConfigurable

All Known Implementing Classes:

DBQueryResultSetWriter, FlatFileQueryResultSetWriter, XMLQueryResultSetWriter

public interface IQueryResultSetWriter

extends IConfigurable

Saves queries (in the form of OrderedMaps and (optionally) result statistics to persistent storage.

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

static java.lang.String	ADHOC
static java.lang.String	APPLICATION_NAME
static java.lang.String	DATE
static java.lang.String	IGNORE_COLUMN
static java.lang.String	PAGE_SIZE
static java.lang.String	QUERY_ID
static java.lang.String	QUERY_NAME
static java.lang.String	RESP_TIME
static java.lang.String	ROLE_NAME
static java.lang.String	SESSION_ID
static java.lang.String	SOURCE_NAMES
static java.lang.String	START_REC
static java.lang.String	TOTAL_DOCS
static java.lang.String	USER_NAME

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)
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 queryResultBean)
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)

Field Detail

TOTAL_DOCS

public static final java.lang.String TOTAL_DOCS

See Also:

Constant Field Values

RESP_TIME

public static final java.lang.String RESP_TIME

See Also:

Constant Field Values

USER_NAME

public static final java.lang.String USER_NAME

See Also:

Constant Field Values

ROLE_NAME

public static final java.lang.String ROLE_NAME

See Also:

Constant Field Values

APPLICATION_NAME

public static final java.lang.String APPLICATION_NAME

See Also:

Constant Field Values

QUERY_NAME

public static final java.lang.String QUERY_NAME

See Also:

Constant Field Values

QUERY_ID

public static final java.lang.String QUERY_ID

See Also:

Constant Field Values

SOURCE_NAMES

public static final java.lang.String SOURCE_NAMES

See Also:

Constant Field Values

PAGE_SIZE

public static final java.lang.String PAGE_SIZE

See Also:

Constant Field Values

START_REC

public static final java.lang.String START_REC

See Also:

Constant Field Values

DATE

public static final java.lang.String DATE

See Also:

Constant Field Values

SESSION_ID

public static final java.lang.String SESSION_ID

See Also:

Constant Field Values

IGNORE_COLUMN

public static final java.lang.String IGNORE_COLUMN

See Also:

Constant Field Values

ADHOC

public static final java.lang.String ADHOC

See Also:

Constant Field Values

Method Detail

getNextID

public java.lang.Integer getNextID()

setQueryParser

public void setQueryParser(IQueryParser queryParser)

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

saveQuery

public void saveQuery(RaritanPageContext pageContext,
                      QueryResultBean queryResultBean)

deleteQuery

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

deleteQuery

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

modifyQuery

public void modifyQuery(RaritanPageContext pageContext,
                        QueryResultBean queryResultBean)

modifyQuery

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

modifyQuery

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

saveQueries

public void saveQueries(RaritanPageContext pageContext,
                        QueryResultBeanSet querySet)

getSavedFields

public java.lang.String[] getSavedFields()

setSavedFields

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

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