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) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

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


	
			
Variable Summary
 float $boost
 string $encoding
 mixed $isBinary
 mixed $isIndexed
 mixed $isStored
 mixed $isTokenized
 string $name
 mixed $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 61)

Field boos factor It's not stored directly in the index, but affects on normalizetion factor

  • access: public
string $encoding (line 68)

Field value encoding.

  • access: public
mixed $isBinary = false (line 51)
  • access: public
mixed $isIndexed = true (line 49)
  • access: public
mixed $isStored = false (line 48)
  • access: public
mixed $isTokenized = true (line 50)
  • access: public
string $name (line 44)

Field name

  • access: public
mixed $storeTermVector = false (line 53)
  • access: public
mixed $value (line 47)
  • access: public
Methods
static Binary (line 142)

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 112)

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 157)

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 127)

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 172)

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 81)

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 182)

Get field value in UTF-8 encoding

  • access: public
string getUtf8Value ()

Documentation generated on Wed, 21 Feb 2007 11:47:40 -0800 by phpDocumentor 1.3.1