com.ecyrd.jspwiki
Class SearchMatcher

java.lang.Object
  |
  +--com.ecyrd.jspwiki.SearchMatcher

public class SearchMatcher

extends java.lang.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

Author:

ebu at ecyrd dot com

Nested Class Summary

class

SearchMatcher.SearchResultImpl

Constructor Summary

SearchMatcher(QueryItem[] queries)

Method Summary

SearchResult

matchPageContent(java.lang.String wikiname, java.lang.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(QueryItem[] queries)

Method Detail

matchPageContent

public SearchResult matchPageContent(java.lang.String wikiname,
                                     java.lang.String pageText)
                              throws java.io.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!

java.io.IOException