com.hlcl.rql.hip.as
Class PhysicalPageTextFinder

java.lang.Object
  extended by com.hlcl.rql.hip.as.PhysicalPageTextFinder

public class PhysicalPageTextFinder
extends java.lang.Object

Author:
lejafr This class searches for text within physical pages (including their block childs) recursively per physical page. Double linked physical pages are scanned twice; there is no optimisation to prevent this.

Constructor Summary
PhysicalPageTextFinder(Page page)
          Construct a physical page wrapping the given general page.
 
Method Summary
 java.util.List collectContainedText(java.lang.String findList, java.lang.String delimiter, boolean scanFollowingPhysicalPages, boolean caseSensitive)
          Scannt alle child pages der Startseite nach den gegebenen Suchbegriffen..
 java.util.List getSearchResults()
          Liefert eine Liste mit allen TextFinderResult Objekten, die ab der Startpage gefunden wurden.
 void setListener(PageListener dependentListener)
          Setzt den aghängigen listener, der über jede neue physical page informiert wird, um einen fortschritt anzuzeigen.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PhysicalPageTextFinder

public PhysicalPageTextFinder(Page page)
                       throws RQLException
Construct a physical page wrapping the given general page.

Throws:
RQLException
Method Detail

collectContainedText

public java.util.List collectContainedText(java.lang.String findList,
                                           java.lang.String delimiter,
                                           boolean scanFollowingPhysicalPages,
                                           boolean caseSensitive)
                                    throws RQLException
Scannt alle child pages der Startseite nach den gegebenen Suchbegriffen..

Das zurückgegebene Set ist leer, wenn keiner der Begriffe auf der Startseite oder Ihren Kindseiten vorkommt.

Returns:
a list of TextFinderResult
Throws:
RQLException
See Also:
TextFinderResult

getSearchResults

public java.util.List getSearchResults()
Liefert eine Liste mit allen TextFinderResult Objekten, die ab der Startpage gefunden wurden.

Returns:
java.util.List of TextFinderResult

setListener

public void setListener(PageListener dependentListener)
Setzt den aghängigen listener, der über jede neue physical page informiert wird, um einen fortschritt anzuzeigen.