org.apache.velocity.tools.examples.showcase.tool

Class MySearchTool

java.lang.Object

org.apache.velocity.tools.generic.SafeConfig

org.apache.velocity.tools.view.PagerTool

org.apache.velocity.tools.view.AbstractSearchTool

org.apache.velocity.tools.examples.showcase.tool.MySearchTool

public class MySearchTool
extends AbstractSearchTool

This is meant to demonstrate how to extend the AbstractSearchTool. A typical implementation would have no static Set as a database, , not have store() methods, and have a real executeQuery(criteria) implementation. But this works for the purposes of this demo.

Version:

$Id: MySearchTool.java 479724 2006-11-27 18:49:37Z nbubna $

Author:

Nathan Bubna

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.velocity.tools.view.AbstractSearchTool

AbstractSearchTool.StoredResults

Field Summary

Fields inherited from class org.apache.velocity.tools.view.AbstractSearchTool

DEFAULT_CRITERIA_KEY, STORED_RESULTS_KEY

Fields inherited from class org.apache.velocity.tools.view.PagerTool

DEFAULT_INDEX_KEY, DEFAULT_ITEMS_PER_PAGE, DEFAULT_ITEMS_PER_PAGE_KEY, DEFAULT_NEW_ITEMS_KEY, DEFAULT_SLIP_SIZE, DEFAULT_SLIP_SIZE_KEY, session, STORED_ITEMS_KEY

Fields inherited from class org.apache.velocity.tools.generic.SafeConfig

LOCK_CONFIG_KEY, log, LOGGER_NAME_KEY, SAFE_MODE_KEY, USE_CLASS_LOGGER_KEY

Constructor Summary

Constructors

Constructor and Description
MySearchTool()

Method Summary

Modifier and Type	Method and Description
protected List	executeQuery(Object crit) This is a very simplistic implementation that looks for the string value of the criteria in the string value of every item in our stupid static database.
boolean	getCreateSession() Override to create a session in which to store search results.
void	store(Collection items) Adds the specified items to our static "database".
void	store(Map items) Adds the entries of the specified map to our static "database".
void	store(Object item) Adds the specified item to our static "database".

Methods inherited from class org.apache.velocity.tools.view.AbstractSearchTool

getCriteria, getCriteriaKey, getItems, getStoredItems, getStoredResults, reset, setCriteria, setCriteriaKey, setStoredItems, setStoredResults, setup

Methods inherited from class org.apache.velocity.tools.view.PagerTool

getFirstIndex, getIndex, getIndexKey, getItemsPerPage, getItemsPerPageKey, getLastIndex, getNewItemsKey, getNextIndex, getPage, getPageDescription, getPageNumber, getPageNumber, getPagesAvailable, getPrevIndex, getSlip, getSlipSize, getSlipSizeKey, getTotal, hasItems, setCreateSession, setIndex, setIndexKey, setItems, setItemsPerPage, setItemsPerPageKey, setNewItemsKey, setRequest, setSlipSize, setSlipSizeKey

Methods inherited from class org.apache.velocity.tools.generic.SafeConfig

configure, configure, getLog, initLogger, isConfigLocked, isSafeMode, setLockConfig, setSafeMode

Methods inherited from class java.lang.Object

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

Constructor Detail

MySearchTool

public MySearchTool()

Method Detail

store

public void store(Object item)

Adds the specified item to our static "database". You would not do this in a normal application!

store

public void store(Map items)

Adds the entries of the specified map to our static "database". You would not do this in a normal application!

store

public void store(Collection items)

Adds the specified items to our static "database". You would not do this in a normal application!

getCreateSession

public boolean getCreateSession()

Override to create a session in which to store search results. This is done to make the demo work well. In a normal app, it would probably not be the search tool's responsibility to ensure that there is a session.

Overrides:

getCreateSession in class PagerTool

executeQuery

protected List executeQuery(Object crit)

This is a very simplistic implementation that looks for the string value of the criteria in the string value of every item in our stupid static database. If the criteria string is in the item string, it is added to the result list.

Specified by:

executeQuery in class AbstractSearchTool

Parameters:

crit - search criteria

Returns:

a List of results for this query