The SolrDocument class

(バージョン情報なし。おそらく SVN 版にしか存在しないでしょう)

導入

Represents a Solr document retrieved from a query response.

クラス概要

final SolrDocument implements ArrayAccess , Iterator , Traversable , Serializable {

/* 定数 */

const integer SORT_DEFAULT = 1 ;

const integer SORT_ASC = 1 ;

const integer SORT_DESC = 2 ;

const integer SORT_FIELD_NAME = 1 ;

const integer SORT_FIELD_VALUE_COUNT = 2 ;

const integer SORT_FIELD_BOOST_VALUE = 4 ;

/* メソッド */

public bool addField ( string $fieldName , string $fieldValue )

public bool clear ( void )

public void __clone ( void )

public __construct ( void )

public SolrDocumentField current ( void )

public bool deleteField ( string $fieldName )

public void __destruct ( void )

public bool fieldExists ( string $fieldName )

public SolrDocumentField __get ( string $fieldName )

public SolrDocumentField getField ( string $fieldName )

public int getFieldCount ( void )

public array getFieldNames ( void )

public SolrInputDocument getInputDocument ( void )

public bool __isset ( string $fieldName )

public string key ( void )

public bool merge ( SolrDocument $sourceDoc [, bool $overwrite = true ] )

public void next ( void )

public bool offsetExists ( string $fieldName )

public SolrDocumentField offsetGet ( string $fieldName )

public void offsetSet ( string $fieldName , string $fieldValue )

public void offsetUnset ( string $fieldName )

public bool reset ( void )

public void rewind ( void )

public string serialize ( void )

public bool __set ( string $fieldName , string $fieldValue )

public bool sort ( int $sortOrderBy [, int $sortDirection = SolrDocument::SORT_ASC ] )

public array toArray ( void )

public void unserialize ( string $serialized )

public bool __unset ( string $fieldName )

public bool valid ( void )

}

定義済み定数

SolrDocument::SORT_DEFAULT: Default mode for sorting fields within the document.
SolrDocument::SORT_ASC: Sorts the fields in ascending order
SolrDocument::SORT_DESC: Sorts the fields in descending order
SolrDocument::SORT_FIELD_NAME: Sorts the fields by field name.
SolrDocument::SORT_FIELD_VALUE_COUNT: Sorts the fields by number of values in each field.
SolrDocument::SORT_FIELD_BOOST_VALUE: Sorts the fields by thier boost values.

SolrDocument::addField — 文書にフィールドを追加
SolrDocument::clear — Drops all the fields in the document
SolrDocument::__clone — SolrDocument オブジェクトのコピーを作成
SolrDocument::__construct — コンストラクタ
SolrDocument::current — 現行のフィールドを取得
SolrDocument::deleteField — 文書からフィールドを除去
SolrDocument::__destruct — デストラクタ
SolrDocument::fieldExists — Checks if a field exists in the document
SolrDocument::__get — プロパティとしてフィールドにアクセス
SolrDocument::getField — 名前でフィールドを取得
SolrDocument::getFieldCount — この文書内のフィールド数を返す
SolrDocument::getFieldNames — 文書内のフィールド名の配列を返す
SolrDocument::getInputDocument — Returns a SolrInputDocument equivalent of the object
SolrDocument::__isset — フィールドが存在するかチェック
SolrDocument::key — 現行のキーを返す
SolrDocument::merge — Merges source to the current SolrDocument
SolrDocument::next — 内部ポインタを次のフィールドに移動
SolrDocument::offsetExists — 特定のフィールドが存在するかどうかチェック
SolrDocument::offsetGet — フィールドを取得
SolrDocument::offsetSet — 文書にフィールドを追加
SolrDocument::offsetUnset — フィールドを除去
SolrDocument::reset — SolrDocument::clear()へのエイリアス
SolrDocument::rewind — 内部ポインタを先頭にリセット
SolrDocument::serialize — カスタムのシリアライズで使われます
SolrDocument::__set — Adds another field to the document
SolrDocument::sort — Sorts the fields in the document
SolrDocument::toArray — 文書の配列表現を返す
SolrDocument::unserialize — Custom serialization of SolrDocument objects
SolrDocument::__unset — 文書からフィールドを除去
SolrDocument::valid — Checks if the current position internally is still valid

The SolrDocument class

導入

クラス概要

定義済み定数

目次