cdx.scorebot.util
Class ColorLogicHTML

java.lang.Object
  extended by cdx.scorebot.util.ColorLogicHTML

public class ColorLogicHTML
extends java.lang.Object

A basic HTML keyword highlighter which marks up certain keywords in a string with user-defined HTML styles.

Author:
David Underhill

Field Summary
static ColorLogicHTML SCORING_LOGIC_HTML
           
 
Constructor Summary
ColorLogicHTML()
          default constructor
 
Method Summary
 void addKeyword(java.lang.String keyword, java.lang.String styleName)
          adds a keyword (a keyword is some word or phrase which has whitespace or a parenthesis)
 void addMarker(java.lang.String markerStart, java.lang.String markerEnd)
          adds a marker
 void addMarkerStyle(java.lang.String markerStart, java.lang.String styleName)
          adds a marker style
 java.lang.String getKeywordStyle(java.lang.String keyword)
          returns a keyword's style
 java.lang.String getMarker(java.lang.String markerStart)
          returns a start marker's end style
 java.lang.String getMarkerStyleStyle(java.lang.String markerStart)
          returns a marker's style
 java.lang.String highlight(java.lang.String s)
          Return a string which highlights the specified string with HTML styles based on the known keywords and marker styles.
 void removeKeyword(java.lang.String keyword)
          removes a keyword
 void removeMarker(java.lang.String markerStart)
          removes a marker and any associated style
 void removeMarkerStyle(java.lang.String markerStart)
          removes a marker
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SCORING_LOGIC_HTML

public static final ColorLogicHTML SCORING_LOGIC_HTML
Constructor Detail

ColorLogicHTML

public ColorLogicHTML()
default constructor

Method Detail

highlight

public java.lang.String highlight(java.lang.String s)
Return a string which highlights the specified string with HTML styles based on the known keywords and marker styles. Currently, keywords are highlighted even if they are in the middle of a marker style. However, keywords must appear "on their own" -- i.e. they are only considered to appear if there is no letter, digit, or underscore on either side of the keyword's appearance.

Parameters:
s - the string to highlight with the known styling information

addKeyword

public void addKeyword(java.lang.String keyword,
                       java.lang.String styleName)
adds a keyword (a keyword is some word or phrase which has whitespace or a parenthesis)


getKeywordStyle

public java.lang.String getKeywordStyle(java.lang.String keyword)
returns a keyword's style


removeKeyword

public void removeKeyword(java.lang.String keyword)
removes a keyword


addMarkerStyle

public void addMarkerStyle(java.lang.String markerStart,
                           java.lang.String styleName)
adds a marker style


getMarkerStyleStyle

public java.lang.String getMarkerStyleStyle(java.lang.String markerStart)
returns a marker's style


removeMarkerStyle

public void removeMarkerStyle(java.lang.String markerStart)
removes a marker


addMarker

public void addMarker(java.lang.String markerStart,
                      java.lang.String markerEnd)
adds a marker


getMarker

public java.lang.String getMarker(java.lang.String markerStart)
returns a start marker's end style


removeMarker

public void removeMarker(java.lang.String markerStart)
removes a marker and any associated style