com.raritantechnologies.utils.tagging
Class RegExprTermExtractor

java.lang.Object
  extended bycom.raritantechnologies.utils.tagging.RegExprTermExtractor
All Implemented Interfaces:
IConfigurable, ITermExtractor

public class RegExprTermExtractor
extends java.lang.Object
implements ITermExtractor

Uses Regular Expressions to extract terms from a string.

XML Configuration Template:
  <TermExtractor class="com.raritantechnologies.utils.tagging.RegExprTermExtractor" 
                    inputPattern="[ regular expression pattern used to extract terms from text ]"
                    startPattern="[ pattern that marks the beginning of the extracted term ]"
                    includeStartPattern="[ true if startPattern should be included, false(default) if it is a prefix marker ]"
                    endPattern="[ pattern that marks the end of the extracted term ]"
                    includeEndPattern="[ true if endPattern is part of extracted term, false(default) if it is a postfix marker ]" />
 

Developed by Raritan Technologies Inc..

Author:
Ted Sullivan

Constructor Summary
RegExprTermExtractor()
           
RegExprTermExtractor(java.lang.String inPattern)
           
RegExprTermExtractor(java.lang.String startPattern, java.lang.String endPattern)
           
 
Method Summary
 java.util.Map extractTerms(java.lang.String sessionID, java.lang.String fromString)
          returns a map of terms - key is the term, value is either an AttributeWordsTagger or an Attribute string
 void initialize(org.w3c.dom.Element elem)
          Initializes the object from an XML tag or element.
 void setEndPattern(java.lang.String endPattern)
           
 void setIncludeEndPattern(boolean includeEndPattern)
           
 void setIncludeStartPattern(boolean includeStartPattern)
           
 void setInputPattern(java.lang.String inPattern)
           
 void setStartPattern(java.lang.String startPattern)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RegExprTermExtractor

public RegExprTermExtractor()

RegExprTermExtractor

public RegExprTermExtractor(java.lang.String inPattern)

RegExprTermExtractor

public RegExprTermExtractor(java.lang.String startPattern,
                            java.lang.String endPattern)
Method Detail

extractTerms

public java.util.Map extractTerms(java.lang.String sessionID,
                                  java.lang.String fromString)
Description copied from interface: ITermExtractor
returns a map of terms - key is the term, value is either an AttributeWordsTagger or an Attribute string

Specified by:
extractTerms in interface ITermExtractor

initialize

public void initialize(org.w3c.dom.Element elem)
Description copied from interface: IConfigurable
Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:
initialize in interface IConfigurable

setInputPattern

public void setInputPattern(java.lang.String inPattern)

setStartPattern

public void setStartPattern(java.lang.String startPattern)

setEndPattern

public void setEndPattern(java.lang.String endPattern)

setIncludeStartPattern

public void setIncludeStartPattern(boolean includeStartPattern)

setIncludeEndPattern

public void setIncludeEndPattern(boolean includeEndPattern)