Search/Lucene/Field.php

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: Document
version: $Id: Field.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Search_Lucene_Field

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_Field
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: Document
Properties: $name; $value; $isStored; $isIndexed; $isTokenized; $isBinary; $storeTermVector; $boost; $encoding
Methods: __construct; keyword; unIndexed; binary; text; unStored; getUtf8Value

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.

Properties

$boost
jump to class

float $boost = '1.0'

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

Details

$boost: float
visibility: public
default: 1.0
final: false
static: false

$encoding
jump to class

string $encoding = ''

Field value encoding.

Details

$encoding: string
visibility: public
default
final: false
static: false

$isBinary
jump to class

boolean $isBinary = 'false'

Field is stored as binary.

Details

$isBinary: boolean
visibility: public
default: false
final: false
static: false

$isIndexed
jump to class

boolean $isIndexed = 'true'

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

Details

$isIndexed: boolean
visibility: public
default: true
final: false
static: false

$isStored
jump to class

boolean $isStored = 'false'

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

Details

$isStored: boolean
visibility: public
default: false
final: false
static: false

$isTokenized
jump to class

boolean $isTokenized = 'true'

Field should be tokenized as text prior to indexing.

Details

$isTokenized: boolean
visibility: public
default: true
final: false
static: false

$name
jump to class

string $name = ''

Field name

Details

$name: string
visibility: public
default
final: false
static: false

$storeTermVector
jump to class

boolean $storeTermVector = 'false'

Field are stored as a term vector

Details

$storeTermVector: boolean
visibility: public
default: false
final: false
static: false

$value
jump to class

boolean $value = ''

Field value

Details

$value: boolean
visibility: public
default
final: false
static: false

Methods

__construct
jump to class

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

Object constructor

Arguments

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

Details

visibility: public
final: false
static: false

binary
jump to class

binary(
          string $name, string $value
          )
        
        :
        Zend_Search_Lucene_Field

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

Arguments

$name: string
$value: string

Output

Zend_Search_Lucene_Field

Details

visibility: public
final: false
static: true

getUtf8Value
jump to class

getUtf8Value(
          
          )
        
        :
        string

Get field value in UTF-8 encoding

Output

string

Details

visibility: public
final: false
static: false

keyword
jump to class

keyword(
          string $name, string $value, string $encoding
          )
        
        :
        Zend_Search_Lucene_Field

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

Arguments

$name: string
$value: string
$encoding: string

Output

Zend_Search_Lucene_Field

Details

visibility: public
final: false
static: true

text
jump to class

text(
          string $name, string $value, string $encoding
          )
        
        :
        Zend_Search_Lucene_Field

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.

Arguments

$name: string
$value: string
$encoding: string

Output

Zend_Search_Lucene_Field

Details

visibility: public
final: false
static: true

unIndexed
jump to class

unIndexed(
          string $name, string $value, string $encoding
          )
        
        :
        Zend_Search_Lucene_Field

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

Arguments

$name: string
$value: string
$encoding: string

Output

Zend_Search_Lucene_Field

Details

visibility: public
final: false
static: true

unStored
jump to class

unStored(
          string $name, string $value, string $encoding
          )
        
        :
        Zend_Search_Lucene_Field

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

Arguments

$name: string
$value: string
$encoding: string

Output

Zend_Search_Lucene_Field

Details

visibility: public
final: false
static: true

API Documentation

Search/Lucene/Field.php

Description

Zend_Search_Lucene_Fieldjump to top

Description

Properties

$boostjump to class

Details

$encodingjump to class

Details

$isBinaryjump to class

Details

$isIndexedjump to class

Details

$isStoredjump to class

Details

$isTokenizedjump to class

Details

$namejump to class

Details

$storeTermVectorjump to class

Details

$valuejump to class

Details

Methods

__constructjump to class

Arguments

Details

binaryjump to class

Arguments

Output

Details

getUtf8Valuejump to class

Output

Details

keywordjump to class

Arguments

Output

Details

textjump to class

Arguments

Output

Details

unIndexedjump to class

Arguments

Output

Details

unStoredjump to class

Arguments

Output

Details

Zend_Search_Lucene_Field
jump to top

$boost
jump to class

$encoding
jump to class

$isBinary
jump to class

$isIndexed
jump to class

$isStored
jump to class

$isTokenized
jump to class

$name
jump to class

$storeTermVector
jump to class

$value
jump to class

__construct
jump to class

binary
jump to class

getUtf8Value
jump to class

keyword
jump to class

text
jump to class

unIndexed
jump to class

unStored
jump to class