## engine.Analyzer


Return a lucene Analyzer which chains together a tokenizer and filters.


Usage

``` python
engine.Analyzer(
    tokenizer,
    *filters,
)
```


## Parameters

| Name | Type | Description | Default |
|----|----|----|----|
| tokenizer |  | lucene Tokenizer class or callable, called with no args \*filters: lucene TokenFilter classes or callables, successively called on input tokens | \- |


## Methods

| Name | Description |
|----|----|
| [highlight()](#highlight) | Return highlighted content. |
| [parse()](#parse) | Return parsed lucene Query. |
| [standard()](#standard) | Return equivalent of StandardAnalyzer with additional filters. |
| [tokens()](#tokens) | Return lucene TokenStream from text. |
| [whitespace()](#whitespace) | Return equivalent of WhitespaceAnalyzer with additional filters. |

------------------------------------------------------------------------


#### highlight()


Return highlighted content.


Usage

``` python
highlight(query, field, content, count=1)
```


##### Parameters

| Name    | Type | Description                         | Default |
|---------|------|-------------------------------------|---------|
| query   |      | lucene Query                        | \-      |
| field   |      | field name                          | \-      |
| content |      | text                                | \-      |
| count   |      | optional maximum number of passages | \-      |

------------------------------------------------------------------------


#### parse()


Return parsed lucene Query.


Usage

``` python
parse(query, field="", op="", parser=None, **attrs)
```


##### Parameters

| Name | Type | Description | Default |
|----|----|----|----|
| query |  | query string | \- |
| field |  | default query field name, sequence of names, or boost mapping | \- |
| op |  | default query operator ('or', 'and') | \- |
| parser |  | custom PythonQueryParser class \*\*attrs: additional attributes to set on the parser | \- |

------------------------------------------------------------------------


#### standard()


Return equivalent of StandardAnalyzer with additional filters.


Usage

``` python
standard(*filters)
```


------------------------------------------------------------------------


#### tokens()


Return lucene TokenStream from text.


Usage

``` python
tokens(text, field=None)
```


------------------------------------------------------------------------


#### whitespace()


Return equivalent of WhitespaceAnalyzer with additional filters.


Usage

``` python
whitespace(*filters)
```
