API Documentation

Search/Lucene/Analysis/Analyzer.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Search_Lucene
subpackage
Analysis
version
$Id: Analyzer.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Search_Lucene_Analysis_Analyzer

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Search_Lucene_Analysis_Analyzer
jump to top

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Search_Lucene
subpackage
Analysis
Properties
$_defaultImpl
$_input
$_encoding
Methods
tokenize
setInput
reset
nextToken
setDefault
getDefault

Description

An Analyzer is used to analyze text.

It thus represents a policy for extracting index terms from text.

Note: Lucene Java implementation is oriented to streams. It provides effective work with a huge documents (more then 20Mb). But engine itself is not oriented such documents. Thus Zend_Search_Lucene analysis API works with data strings and sets (arrays).

Properties

$_defaultImpl
jump to class

Zend_Search_Lucene_Analysis_Analyzer $_defaultImpl = ''

The Analyzer implementation used by default.

Details

$_defaultImpl
Zend_Search_Lucene_Analysis_Analyzer
visibility
private
default
final
false
static
true

$_encoding
jump to class

string $_encoding = ''

Input string encoding

Details

$_encoding
string
visibility
protected
default
final
false
static
false

$_input
jump to class

string $_input = 'null'

Input string

Details

$_input
string
visibility
protected
default
null
final
false
static
false

Methods

getDefault
jump to class

getDefault( ) : Zend_Search_Lucene_Analysis_Analyzer

Return the default Analyzer implementation used by indexing code.

Output
Zend_Search_Lucene_Analysis_Analyzer
Details
visibility
public
final
false
static
true

nextToken
jump to class

nextToken( ) : Zend_Search_Lucene_Analysis_Token|null

Tokenization stream API Get next token Returns null at the end of stream

Tokens are returned in UTF-8 (internal Zend_Search_Lucene encoding)

Output
Zend_Search_Lucene_Analysis_Token|null
Details
visibility
public
final
false
static
false

reset
jump to class

reset( ) :

Reset token stream

Details
visibility
public
final
false
static
false

setDefault
jump to class

setDefault(  $analyzer ) :

Set the default Analyzer implementation used by indexing code.

Arguments
$analyzer
Details
visibility
public
final
false
static
true

setInput
jump to class

setInput( string $data,  $encoding ) :

Tokenization stream API Set input

Arguments
$data
string
$encoding
Details
visibility
public
final
false
static
false

tokenize
jump to class

tokenize( string $data,  $encoding ) : array

Tokenize text to a terms Returns array of Zend_Search_Lucene_Analysis_Token objects

Tokens are returned in UTF-8 (internal Zend_Search_Lucene encoding)

Arguments
$data
string
$encoding
Output
array
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.