com.raritantechnologies.concept.classifier
Class AndNotDocumentMatcher

java.lang.Object
  extended bycom.raritantechnologies.concept.classifier.BasicDocumentMatcher
      extended bycom.raritantechnologies.concept.classifier.AndNotDocumentMatcher
All Implemented Interfaces:
IConfigurable, IDocumentMatcher, ITermExtractor

public class AndNotDocumentMatcher
extends BasicDocumentMatcher
implements IDocumentMatcher

Matches a document if first child matcher matches and second child does not match.

XML Configuration Template:
  <DocumentMatcher class="com.raritantechnologies.concept.classifier.AndNotDocumentMatcher" >

     <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
AndNotDocumentMatcher()
           
AndNotDocumentMatcher(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 both match - returns DocumentMatchBean with lower 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
 
Methods inherited from interface com.raritantechnologies.concept.classifier.IDocumentMatcher
addAttribute, addTermsAsAttributes, getAttribute, getAttributeNames, getMatchCriteria, getName, getPhraseSet, getTermSet, setName
 
Methods inherited from interface com.raritantechnologies.utils.tagging.ITermExtractor
extractTerms
 

Constructor Detail

AndNotDocumentMatcher

public AndNotDocumentMatcher()

AndNotDocumentMatcher

public AndNotDocumentMatcher(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

getMatchCriteria

public DocumentMatchBean getMatchCriteria(IndexedDocument document,
                                          java.util.Map termsMap)
if both match - returns DocumentMatchBean with lower 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)
Specified by:
extractTerms in interface IDocumentMatcher

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

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

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.

Specified by:
render in interface IDocumentMatcher