Docs For Class Zend_Search_Lucene

Description

A field is a section of a Document. Each field has two parts,

a name and a value. Values may be free text or they may be atomic keywords, which are not further processed. Such keywords may be used to represent dates, urls, etc. Fields are optionally stored in the index, so that they may be returned with hits on the document.

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /Search/Lucene/Field.php (line 38)

Variable Summary

float $boost

string $encoding

boolean $isBinary

boolean $isIndexed

boolean $isStored

boolean $isTokenized

string $name

boolean $storeTermVector

boolean $value

Method Summary

static Zend_Search_Lucene_Field binary (string $name, string $value, string $encoding)

static Zend_Search_Lucene_Field keyword (string $name, string $value, [string $encoding = ''])

static Zend_Search_Lucene_Field text (string $name, string $value, [string $encoding = ''])

static Zend_Search_Lucene_Field unIndexed (string $name, string $value, [string $encoding = ''])

static Zend_Search_Lucene_Field unStored (string $name, string $value, [string $encoding = ''])

Zend_Search_Lucene_Field __construct (string $name, string $value, string $encoding, boolean $isStored, boolean $isIndexed, boolean $isTokenized, [boolean $isBinary = false])

string getUtf8Value ()

Variables

float $boost = 1.0 (line 94)

Field boost factor It's not stored directly in the index, but affects on normalization factor

access: public

string $encoding (line 101)

Field value encoding.

access: public

boolean $isBinary = false (line 79)

Field is stored as binary.

access: public

boolean $isIndexed = true (line 66)

Field is to be indexed, so that it may be searched on.

access: public

boolean $isStored = false (line 59)

Field is to be stored in the index for return with search hits.

access: public

boolean $isTokenized = true (line 73)

Field should be tokenized as text prior to indexing.

access: public

string $name (line 45)

Field name

access: public

boolean $storeTermVector = false (line 86)

Field are stored as a term vector

access: public

boolean $value (line 52)

Field value

access: public

Methods

static binary (line 175)

Constructs a Binary String valued Field that is not tokenized nor indexed, but is stored in the index, for return with hits.

access: public

static Zend_Search_Lucene_Field binary (string $name, string $value, string $encoding)

string $name
string $value
string $encoding

static keyword (line 145)

Constructs a String-valued Field that is not tokenized, but is indexed and stored. Useful for non-text fields, e.g. date or url.

access: public

static Zend_Search_Lucene_Field keyword (string $name, string $value, [string $encoding = ''])

string $name
string $value
string $encoding

static text (line 190)

Constructs a String-valued Field that is tokenized and indexed, and is stored in the index, for return with hits. Useful for short text fields, like "title" or "subject". Term vector will not be stored for this field.

access: public

static Zend_Search_Lucene_Field text (string $name, string $value, [string $encoding = ''])

string $name
string $value
string $encoding

static unIndexed (line 160)

Constructs a String-valued Field that is not tokenized nor indexed, but is stored in the index, for return with hits.

access: public

static Zend_Search_Lucene_Field unIndexed (string $name, string $value, [string $encoding = ''])

string $name
string $value
string $encoding

static unStored (line 205)

Constructs a String-valued Field that is tokenized and indexed, but that is not stored in the index.

access: public

static Zend_Search_Lucene_Field unStored (string $name, string $value, [string $encoding = ''])

string $name
string $value
string $encoding

Constructor __construct (line 114)

Object constructor

access: public

Zend_Search_Lucene_Field __construct (string $name, string $value, string $encoding, boolean $isStored, boolean $isIndexed, boolean $isTokenized, [boolean $isBinary = false])

string $name
string $value
string $encoding
boolean $isStored
boolean $isIndexed
boolean $isTokenized
boolean $isBinary

getUtf8Value (line 215)

Get field value in UTF-8 encoding

access: public

string getUtf8Value ()