Cheshire3 Objects: Extractor

Description

An Extractor is a processing object called by an Index with the value of an evaluated XPath expression or with a string. Example normalizers might extract keywords from an element or the entire contents thereof as a single string. Extractors must also be used on the query terms to apply the same keyword processing rules, for example.

Implementations

The following implementations are pre-configured and ready to use by getting the object from a Server. They may be used out-of-the-box in configurations for Indexes, Workflows etc.

API

Module: cheshire3.extractor
Classes:

Methods:

FunctionParametersReturnsDescription
__init__config, parent 
process_stringsession, stringhashProcess a raw string, e.g. from an attribute value
process_nodesession, domNodehashProcess a DOM node
process_eventListsession, list of SAX eventshashProcess a list of SAX events
process_xpathResultsession, xpathResulthashProcess the result returned by a configured XPath Selector object (historically Cheshire3 only dealt with XPath selectors, hence the name.) Convenience function to wrap the other process_* functions and do type checking.

Sub-Packages

Sub-Package: graph
Module: cheshire3.graph.extractor
Classes: