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.

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


	
			
Variable Summary
 mixed $boost
 mixed $isBinary
 mixed $isIndexed
 mixed $isStored
 mixed $isTokenized
 mixed $kind
 mixed $name
 mixed $stringValue
Method Summary
 Zend_Search_Lucene_Field __construct (mixed $name, mixed $stringValue, mixed $isStored, mixed $isIndexed, mixed $isTokenized, [mixed $isBinary = false])
 Zend_Search_Lucene_Field Binary (string $name, string $value)
 Zend_Search_Lucene_Field Keyword (string $name, string $value)
 Zend_Search_Lucene_Field Text (string $name, string $value)
 Zend_Search_Lucene_Field UnIndexed (string $name, string $value)
 Zend_Search_Lucene_Field UnStored (string $name, string $value)
Variables
mixed $boost = 1.0 (line 48)
  • access: public
mixed $isBinary = false (line 44)
  • access: public
mixed $isIndexed = true (line 42)
  • access: public
mixed $isStored = false (line 41)
  • access: public
mixed $isTokenized = true (line 43)
  • access: public
mixed $kind (line 37)
  • access: public
mixed $name = 'body' (line 39)
  • access: public
mixed $storeTermVector = false (line 46)
  • access: public
mixed $stringValue = null (line 40)
  • access: public
Methods
Constructor __construct (line 50)
  • access: public
Zend_Search_Lucene_Field __construct (mixed $name, mixed $stringValue, mixed $isStored, mixed $isIndexed, mixed $isTokenized, [mixed $isBinary = false])
Binary (line 100)

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
Keyword (line 72)

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
Text (line 114)

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
UnIndexed (line 86)

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
UnStored (line 128)

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

Documentation generated on Tue, 18 Apr 2006 11:54:58 -0700 by phpDocumentor 1.3.0RC3