com.raritantechnologies.concept.classifier
Class OrDocumentMatcher

java.lang.Object
  com.raritantechnologies.concept.classifier.BasicDocumentMatcher
      com.raritantechnologies.concept.classifier.OrDocumentMatcher

All Implemented Interfaces:

IConfigurable, IDocumentMatcher, ITermExtractor

public class OrDocumentMatcher

extends BasicDocumentMatcher

Uses the boolean OR of two child matchers to compute a match.

XML Configuration Template:

  <DocumentMatcher class="com.raritantechnologies.concept.classifier.OrDocumentMatcher" >

     <DocumentMatcher class="[ class of com.raritantechnologies.concept.classifier.IDocumentMatcher ]" >

     </DocumentMatcher>

     <DocumentMatcher class="[ class of com.raritantechnologies.concept.classifier.IDocumentMatcher ]" >

     </DocumentMatcher>

  </DocumentMatcher>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Constructor Summary

OrDocumentMatcher()

OrDocumentMatcher(IDocumentMatcher matcherOne, IDocumentMatcher matcherTwo)

Method Summary

protected void	collectPhraseSet(java.util.HashSet phraseSet)
protected void	collectTermSet(java.util.HashSet termSet)
void	extractTerms(IndexedDocument fromDocument, java.util.HashMap termsMap) Extracts the matching terms contained in the document.
void	extractTerms(IndexedDocument fromDocument, java.util.Set termsSet)
DocumentMatchBean	getMatchCriteria(IndexedDocument document, java.util.Map termsMap) if one matches - returns DocumentMatchBean with higher score.
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
boolean	isStopWord(IndexedDocument document) Adds stop word support.
boolean	matches(IndexedDocument document) returns true if the matcher matches the IndexedDocument, false otherwise.
java.lang.String	render() Renders a human-readable version of the matcher's logic.

Methods inherited from class com.raritantechnologies.concept.classifier.BasicDocumentMatcher

addAttribute, addTerms, addTermsAsAttributes, extractTerms, getAttribute, getAttributeNames, getMatchCriteria, getName, getPhraseSet, getTermSet, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

OrDocumentMatcher

public OrDocumentMatcher()

OrDocumentMatcher

public OrDocumentMatcher(IDocumentMatcher matcherOne,
                         IDocumentMatcher matcherTwo)

Method Detail

matches

public boolean matches(IndexedDocument document)

Description copied from interface: IDocumentMatcher

returns true if the matcher matches the IndexedDocument, false otherwise.

Specified by:

matches in interface IDocumentMatcher

Specified by:

matches in class BasicDocumentMatcher

isStopWord

public boolean isStopWord(IndexedDocument document)

Description copied from interface: IDocumentMatcher

Adds stop word support. This is typically done by checking if the matchers terms are stop words by calling the IndexedDocument method isStopWord( string ). See TermDocumentMatcher.

Specified by:

isStopWord in interface IDocumentMatcher

Overrides:

isStopWord in class BasicDocumentMatcher

getMatchCriteria

public DocumentMatchBean getMatchCriteria(IndexedDocument document,
                                          java.util.Map termsMap)

if one matches - returns DocumentMatchBean with higher score.

Specified by:

getMatchCriteria in interface IDocumentMatcher

Overrides:

getMatchCriteria in class BasicDocumentMatcher

extractTerms

public void extractTerms(IndexedDocument fromDocument,
                         java.util.HashMap termsMap)

Description copied from interface: IDocumentMatcher

Extracts the matching terms contained in the document.

Specified by:

extractTerms in interface IDocumentMatcher

Specified by:

extractTerms in class BasicDocumentMatcher

extractTerms

public void extractTerms(IndexedDocument fromDocument,
                         java.util.Set termsSet)

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.

collectTermSet

protected void collectTermSet(java.util.HashSet termSet)

Specified by:

collectTermSet in class BasicDocumentMatcher

collectPhraseSet

protected void collectPhraseSet(java.util.HashSet phraseSet)

Specified by:

collectPhraseSet in class BasicDocumentMatcher

render

public java.lang.String render()

Description copied from interface: IDocumentMatcher

Renders a human-readable version of the matcher's logic.