Docs For Class Zend_Search_Lucene_Field

## Class Zend_Search_Lucene_Field

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.

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

Located in /Zend/Search/Lucene/Field.php (line 37)

Variable Summary
mixed $boost
mixed $isBinary
mixed $isIndexed
mixed $isStored
mixed $isTokenized
mixed $kind
mixed $name
mixed $storeTermVector
mixed $stringValue
Method Summary
static Zend_Search_Lucene_Field Binary (string $name, string $value)
static Zend_Search_Lucene_Field Keyword (string $name, string $value)
static Zend_Search_Lucene_Field Text (string $name, string $value)
static Zend_Search_Lucene_Field UnIndexed (string $name, string $value)
static Zend_Search_Lucene_Field UnStored (string $name, string $value)
Zend_Search_Lucene_Field __construct ( $name, $stringValue, $isStored, $isIndexed, $isTokenized, [ $isBinary = false])
Variables
mixed $boost = 1.0 (line 50)

- access: public

mixed $isBinary = false (line 46)

- access: public

mixed $isIndexed = true (line 44)

- access: public

mixed $isStored = false (line 43)

- access: public

mixed $isTokenized = true (line 45)

- access: public

mixed $kind (line 39)

- access: public

mixed $name = 'body' (line 41)

- access: public

mixed $storeTermVector = false (line 48)

- access: public

mixed $stringValue = null (line 42)

- access: public

Methods
static method Binary (line 111)

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 $name
- string $value

static method Keyword (line 83)

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 $name
- string $value

static method Text (line 125)

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 $name
- string $value

static method UnIndexed (line 97)

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 $name
- string $value

static method UnStored (line 139)

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 $name
- string $value

Constructor __construct (line 52)

- access: public

Zend_Search_Lucene_Field __construct ( $name, $stringValue, $isStored, $isIndexed, $isTokenized, [ $isBinary = false])

- $name
- $stringValue
- $isStored
- $isIndexed
- $isTokenized
- $isBinary

Documentation generated on Sun, 29 Oct 2006 21:27:13 -0600 by phpDocumentor 1.3.0RC6