com.raritantechnologies.utils.tagging
Interface ITagWriter

All Superinterfaces:

IConfigurable

All Known Implementing Classes:

GetFormHyperlinkTagWriter, HyperlinkTagWriter, SystemObjectTagWriter

public interface ITagWriter

extends IConfigurable

Base interface for "TagWriters": Classes which can insert tags (highlighting, hyperlinks, etc) into a body of text.

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

static java.lang.String

TEMPLATE

Method Summary

void	addTag(java.lang.String sourceWord, java.lang.Object tagReference)
void	clearTags()
void	initialize(org.w3c.dom.Element elem) Initialize TagWriter from an XML configuation element.
void	setMatchCase(java.lang.String matchCase)
java.lang.String	tagWord(java.lang.String sessionID, java.lang.String sourceWord) returns a "tagged" version of the source word.

Field Detail

TEMPLATE

public static final java.lang.String TEMPLATE

See Also:

Constant Field Values

Method Detail

initialize

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

Initialize TagWriter from an XML configuation element.

Specified by:

initialize in interface IConfigurable

tagWord

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

returns a "tagged" version of the source word.

addTag

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

clearTags

public void clearTags()

setMatchCase

public void setMatchCase(java.lang.String matchCase)