com.raritantechnologies.utils.tagging
Class HyperlinkTagWriter

java.lang.Object
  com.raritantechnologies.utils.tagging.HyperlinkTagWriter

All Implemented Interfaces:

IConfigurable, ITagWriter

Direct Known Subclasses:

HighlightTagWriter

public class HyperlinkTagWriter

extends java.lang.Object

implements ITagWriter

Tags words or phrases within a text string with hyperlinks.

Contains a hash map of source words --> urls. Wraps source words in hyperlinks to the related URL.

XML Configuration Template:

  <TagWriter class="com.raritantechnologies.utils.tagging.HyperlinkTagWriter"
                matchCase="LOWER|UPPER|NONE" 
                target="someWin" 
                javascriptFunction=""
                createHref="[true(default)|false ]"
                includeNameAnchor="[true|false(default) - if true includes a name="#{source_word}"" in the anchor tag ]" >

    <WordLinks>
      <WordLink source="ASourceWord"   url="ItsLink" />
      <WordLink source="AnotherSource" url="AnotherLink" />
    </WordLinks>

    <!-- Optional IHyperlinkTagSource enables RTI search source to be used to create tag term list -->
    <TagSource class="[implementation of IHyperlinkTagSource]" >
       <!-- TagSource initialization params -->
    </TagSource>
  </TagWriter>
 

XML Configuration schema for external file:

  <TagWriter taggingClass="com.raritantechnologies.utils.tagging.HyperlinkTagWriter" >
    <WordLinkFile fileName="TheFileWithWordLinks.txt" delimiter="=" />
  </TagWriter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

protected java.lang.String

matchCase

Fields inherited from interface com.raritantechnologies.utils.tagging.ITagWriter

TEMPLATE

Constructor Summary

HyperlinkTagWriter()

Method Summary

void	addSourceLink(java.lang.String firstWord, AttributeWordsTagger tagger)
void	addSourceLink(java.lang.String sourceWord, java.lang.String referenceURL)
void	addTag(java.lang.String sourceWord, java.lang.Object tagReference)
void	clearSourceLinks()
void	clearTags()
void	initialize(org.w3c.dom.Element elem) Initialize TagWriter from an XML configuation element.
void	removeSourceLink(java.lang.String sourceWord)
void	setMatchCase(java.lang.String matchCase)
void	setMatchPartialPhrase(boolean matchPartialPhrase)
protected java.lang.String	tagIt(java.lang.String sessionID, java.lang.String url, java.lang.String source)
java.lang.String	tagWord(java.lang.String sessionID, java.lang.String sourceWord) returns a "tagged" version of the source word.

Methods inherited from class java.lang.Object

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

Field Detail

matchCase

protected java.lang.String matchCase

Constructor Detail

HyperlinkTagWriter

public HyperlinkTagWriter()

Method Detail

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: ITagWriter

Initialize TagWriter from an XML configuation element.

Specified by:

initialize in interface ITagWriter

addTag

public void addTag(java.lang.String sourceWord,
                   java.lang.Object tagReference)

Specified by:

addTag in interface ITagWriter

addSourceLink

public void addSourceLink(java.lang.String sourceWord,
                          java.lang.String referenceURL)

addSourceLink

public void addSourceLink(java.lang.String firstWord,
                          AttributeWordsTagger tagger)

removeSourceLink

public void removeSourceLink(java.lang.String sourceWord)

clearTags

public void clearTags()

Specified by:

clearTags in interface ITagWriter

clearSourceLinks

public void clearSourceLinks()

setMatchPartialPhrase

public void setMatchPartialPhrase(boolean matchPartialPhrase)

setMatchCase

public void setMatchCase(java.lang.String matchCase)

Specified by:

setMatchCase in interface ITagWriter

tagWord

public java.lang.String tagWord(java.lang.String sessionID,
                                java.lang.String sourceWord)

Description copied from interface: ITagWriter

returns a "tagged" version of the source word.

Specified by:

tagWord in interface ITagWriter

tagIt

protected java.lang.String tagIt(java.lang.String sessionID,
                                 java.lang.String url,
                                 java.lang.String source)