com.sebtools.Searcher
Component Searcher (Searcher)


I manage search functionality. I will usually be extended by a site-specific search object.


hierarchy: WEB-INF.cftags.component
      com.sebtools.Searcher
properties:
methods: init, addCollection, create, getCollections, getDbXml, getLandingPages, getSearchData, index, indexPath, indexQuery, QueryDeleteRows, reRun, run, send
* - private method

init
public Searcher init ( required string CollectionPath, required DataMgr DataMgr, required string sendpage, string excludedirs="", string excludefiles="" )

I initialize and return this object.

Output: suppressed
Parameters:
   CollectionPath: string, required, CollectionPath
   DataMgr: DataMgr, required, DataMgr
   sendpage: string, required, sendpage
   excludedirs: string, optional, excludedirs
   excludefiles: string, optional, excludefiles

addCollection
public void addCollection ( required string CollectionName )

Output: suppressed
Parameters:
   CollectionName: string, required, CollectionName

create
public void create ( required string CollectionName )

I create the given collection.

Output: suppressed
Parameters:
   CollectionName: string, required, CollectionName

getCollections
public string getCollections ( )

I return a list of all of the collections used by Searcher.

Output: suppressed
getDbXml
public string getDbXml ( )

I return the XML for the tables needed for Searcher to work.

Output: suppressed
getLandingPages
public query getLandingPages ( required string searchterm )

I return information about the given search phrase.

Output: suppressed
Parameters:
   searchterm: string, required, searchterm

getSearchData
public query getSearchData ( date startdate, date enddate )

I return information about past searches.

Output: suppressed
Parameters:
   startdate: date, optional, startdate
   enddate: date, optional, enddate

index
public boolean index ( )

I index the collection(s) to be searched.

Output: suppressed
indexPath
public void indexPath ( required string CollectionName, required string Key )

I index a path collection and add it to the Searcher.

Output: suppressed
Parameters:
   CollectionName: string, required, CollectionName
   Key: string, required, Key

indexQuery
public void indexQuery ( required string CollectionName, required query query, required string Key, required string Title, required string Body, string URLPath="", string Custom1="", string Custom2="" )

I index a query collection and add it to the Searcher.

Output: suppressed
Parameters:
   CollectionName: string, required, CollectionName
   query: query, required, query
   Key: string, required, Key
   Title: string, required, Title
   Body: string, required, Body
   URLPath: string, optional, URLPath
   Custom1: string, optional, Custom1
   Custom2: string, optional, Custom2

QueryDeleteRows
QueryDeleteRows ( required QUERY, required ROWS )

Output: enabled
Parameters:
   QUERY: any, required, QUERY
   ROWS: any, required, ROWS

reRun
public query reRun ( required numeric searchid )

I return results from a search that has already been run (useful for multi-page search results).

Output: suppressed
Parameters:
   searchid: numeric, required, searchid

run
public query run ( required string searchterm )

I run a search on the given search term.

Output: suppressed
Parameters:
   searchterm: string, required, searchterm

send
remote any send ( required numeric searchid, required string to )

I track a search selection and the redirect the user to the desired page.

Output: enabled
Parameters:
   searchid: numeric, required, searchid
   to: string, required, to