org.apache.wiki.search
Class SearchMatcher

java.lang.Object
  org.apache.wiki.search.SearchMatcher

public class SearchMatcher
extends Object

SearchMatcher performs the task of matching a search query to a page's contents. This utility class is isolated to simplify WikiPageProvider implementations and to offer an easy target for upgrades. The upcoming(?) TranslatorReader rewrite will presumably invalidate this, among other things.

Since:

2.1.5

Nested Class Summary

class

SearchMatcher.SearchResultImpl A local search result.

Constructor Summary

SearchMatcher(WikiEngine engine, QueryItem[] queries)
Creates a new SearchMatcher.

Method Summary

SearchResult

matchPageContent(String wikiname, String pageText) Compares the page content, available through the given stream, to the query items of this matcher.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchMatcher

public SearchMatcher(WikiEngine engine,
                     QueryItem[] queries)

Creates a new SearchMatcher.

Parameters:

engine - The WikiEngine

queries - A list of queries

Method Detail

matchPageContent

public SearchResult matchPageContent(String wikiname,
                                     String pageText)
                              throws IOException

Compares the page content, available through the given stream, to the query items of this matcher. Returns a search result object describing the quality of the match.

This method would benefit of regexps (1.4) and streaming. FIXME!

Parameters:

wikiname - The name of the page

pageText - The content of the page

Returns:

A SearchResult item, or null, there are no queries

Throws:

IOException - If reading page content fails