Tagging String Filter demo

Example

TaggingStringFilter Demo

This example uses several elements, a PageImportRenderer to insert text from a file into this page and a TaggingStringFilter which will dynamically tag the page. The file is a section of a Shakespeare play which will be auto tagged by the filter from a set of keywords obtained from the Absolute Shakespeare web site. (see the result parser demo to see how this information is loaded into the ShakespeareGlossary search source.) A HyperlinkTagWriter is used to format the hyperlinks to a popup window in which the definition is displayed.

From Hamlet - by William Shakespeare
To be, or not to be: that is the question:
Whether 'tis nobler in the mind to suffer
The slings and arrows of outrageous fortune,
Or to take arms against a sea of troubles,
And by opposing end them? To die: to sleep;
No more; and by a sleep to say we end
The heart-ache and the thousand natural shocks
That flesh is heir to, 'tis a consummation
Devoutly to be wish'd. To die, to sleep;
To sleep: perchance to dream: ay, there's the rub;
For in that sleep of death what dreams may come
When we have shuffled off this mortal coil,
Must give us pause: there's the respect
That makes calamity of so long life;
For who would bear the whips and scorns of time,
The oppressor's wrong, the proud man's contumely,
The pangs of despised love, the law's delay,
The insolence of office and the spurns
That patient merit of the unworthy takes,
When he himself might his quietus make
With a bare bodkin? who would fardels bear,
To grunt and sweat under a weary life,
But that the dread of something after death,
The undiscover'd country from whose bourn
No traveller returns, puzzles the will
And makes us rather bear those ills we have
Than fly to others that we know not of?
Thus conscience does make cowards of us all;
And thus the native hue of resolution
Is sicklied o'er with the pale cast of thought,
And enterprises of great pith and moment
With this regard their currents turn awry,
And lose the name of action.--Soft you now!
The fair Ophelia! Nymph, in thy orisons
Be all my sins remember'd.

JSP Source for the PageImportRenderer custom tag:

 <results:PageImport importRenderer="2BORNOT2B" />

XML Configuration for PageImportRenderer:
Uses the ShakespeareGlossary search source (see the result parser demo to see how this source is created.)

  <SystemObject type="PageImportRenderer" name="2BORNOT2B"
                configurableClass="com.raritantechnologies.searchApp.taglibrary.PageImportRenderer" >

    <PageElements>
      <PageElement>

        <!-- ========================================================== -->
        <!--   The Body element describes where the page content is     -->
        <!--   acquired from - in this case from a file named           -->
        <!--   'ToBeOrNotToBe.html'.                                    -->
        <!-- ========================================================== -->
        <Body fileName="BASE_PATH/data/ShakespeareGlossary/ToBeOrNotToBe.html" />

        <!-- ========================================================== -->
        <!--  The Header and Trailer sections can be used to define     -->
        <!--  static html code that will preceed and follow the body    -->
        <!--  section respectively.  In this case, the Trailer is used  -->
        <!--  to supply a javascript function that will work with the   -->
        <!--  StringFilter defined below.                               -->
        <!-- ========================================================== -->

        <Trailer>
          <![CDATA[
            <script language="javascript" >

            function popup_def( href )
            {
                window.open( href, "aWin", "width=500,height=100,left=200,top=200" );
            }
            </script>
           ]]>
        </Trailer>
      </PageElement>
    </PageElements>

    <!-- ============================================================ -->
    <!--  TaggingStringFilter uses the ShakespeareGlossary source     -->
    <!--  to mark up the imported page.                               -->
    <!-- ============================================================ -->
    <StringFilter class="com.raritantechnologies.utils.tagging.TaggingStringFilter" >

      <TagWriter class="com.raritantechnologies.utils.tagging.HyperlinkTagWriter"
                 javascriptFunction="popup_def" matchCase="LOWER" >

        <TagSource class="com.raritantechnologies.utils.tagging.SearchSourceTagSource"
                   name="ShakespeareTagSource"
                   action="showDefinition.jsp"
                   searchSource="ShakespeareGlossary"
                   tagTermField="Term" >
         <Query ID="Term" value="" />
          <RequestParams>
            <Param ID="Term" name="Term" />
          </RequestParams>
        </TagSource>

      </TagWriter>

    </StringFilter>

  </SystemObject>