com.norconex.importer.handler.tagger.impl

Class CountMatchesTagger

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.tagger.AbstractDocumentTagger

com.norconex.importer.handler.tagger.AbstractCharStreamTagger

com.norconex.importer.handler.tagger.AbstractStringTagger

com.norconex.importer.handler.tagger.impl.CountMatchesTagger

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTagger

public class CountMatchesTagger
extends AbstractStringTagger

Counts the number of matches of a given string (or string pattern) and store the resulting value in a field in the specified "toField".

If no "fromField" is specified, the document content will be used. If the "toField" already exists before counting begins, it will be overwritten with the result of the match count. If within this tagger the "toField" is repeated, the sum of all count will be added. If the fromField has multiple values, the total count of all matches will be stored as a single value.

Can be used as a pre-parse tagger on text document only when matching strings on document content, or both as a pre-parse or post-parse handler when the "fromField" is used.

XML configuration usage:

  <tagger class="com.norconex.importer.handler.tagger.impl.CountMatchesTagger"
          sourceCharset="(character encoding)"
          maxReadSize="(max characters to read at once)" >  
          
      <restrictTo caseSensitive="[false|true]"
              field="(name of header/metadata field name to match)">
          (regular expression of value to match)
      </restrictTo>
      <!-- multiple "restrictTo" tags allowed (only one needs to match) -->
          
      <countMatches 
              fromField="(optional source field)" 
              toField="(target field)"
              caseSensitive="[false|true]"
              regex="[false|true]">
          (text to match or regular expression)
      </countMatches>
      <!-- multiple countMatches tags allowed -->

  </tagger>
 

Usage example:

The following will count the number of segments in a URL:

  <tagger class="com.norconex.importer.handler.tagger.impl.CountMatchesTagger">  
      <countMatches 
              fromField="document.reference" 
              toField="urlSegmentCount"
              regex="true">
          /[^/]+
      </countMatches>
  </tagger>
 

Since:

2.6.0

Author:

Pascal Essiembre

See Also:

Pattern

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CountMatchesTagger.MatchDetails

Constructor Summary

Constructors

Constructor and Description
CountMatchesTagger()

Method Summary

Modifier and Type	Method and Description
void	addMatchDetails(CountMatchesTagger.MatchDetails matchDetails) Adds a match details.
boolean	equals(Object other)
List<CountMatchesTagger.MatchDetails>	getMatchesDetails()
int	hashCode()
protected void	loadStringTaggerFromXML(org.apache.commons.configuration.XMLConfiguration xml) Loads configuration settings specific to the implementing class.
void	removeMatchDetails(CountMatchesTagger.MatchDetails matchDetails)
protected void	saveStringTaggerToXML(EnhancedXMLStreamWriter writer) Saves configuration settings specific to the implementing class.
protected void	tagStringContent(String reference, StringBuilder content, ImporterMetadata metadata, boolean parsed, int sectionIndex)
String	toString()

Methods inherited from class com.norconex.importer.handler.tagger.AbstractStringTagger

getMaxReadSize, loadCharStreamTaggerFromXML, saveCharStreamTaggerToXML, setMaxReadSize, tagTextDocument

Methods inherited from class com.norconex.importer.handler.tagger.AbstractCharStreamTagger

getSourceCharset, loadHandlerFromXML, saveHandlerToXML, setSourceCharset, tagApplicableDocument

Methods inherited from class com.norconex.importer.handler.tagger.AbstractDocumentTagger

tagDocument

Methods inherited from class com.norconex.importer.handler.AbstractImporterHandler

addRestriction, addRestriction, addRestrictions, clearRestrictions, detectCharsetIfBlank, getRestrictions, isApplicable, loadFromXML, removeRestriction, removeRestriction, saveToXML

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CountMatchesTagger

public CountMatchesTagger()

Method Detail

tagStringContent

protected void tagStringContent(String reference,
                                StringBuilder content,
                                ImporterMetadata metadata,
                                boolean parsed,
                                int sectionIndex)
                         throws ImporterHandlerException

Specified by:

tagStringContent in class AbstractStringTagger

Throws:

ImporterHandlerException

getMatchesDetails

public List<CountMatchesTagger.MatchDetails> getMatchesDetails()

removeMatchDetails

public void removeMatchDetails(CountMatchesTagger.MatchDetails matchDetails)

addMatchDetails

public void addMatchDetails(CountMatchesTagger.MatchDetails matchDetails)

Adds a match details.

Parameters:

matchDetails - the match details

loadStringTaggerFromXML

protected void loadStringTaggerFromXML(org.apache.commons.configuration.XMLConfiguration xml)
                                throws IOException

Description copied from class: AbstractStringTagger

Loads configuration settings specific to the implementing class.

Specified by:

loadStringTaggerFromXML in class AbstractStringTagger

Parameters:

xml - xml configuration

Throws:

IOException - could not load from XML

saveStringTaggerToXML

protected void saveStringTaggerToXML(EnhancedXMLStreamWriter writer)
                              throws XMLStreamException

Description copied from class: AbstractStringTagger

Saves configuration settings specific to the implementing class. The parent tag along with the "class" attribute are already written. Implementors must not close the writer.

Specified by:

saveStringTaggerToXML in class AbstractStringTagger

Parameters:

writer - the xml writer

Throws:

XMLStreamException - could not save to XML

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractStringTagger

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStringTagger

toString

public String toString()

Overrides:

toString in class AbstractStringTagger