FirteX－高性能全文索引和检索平台

API Documentation

首页 | 名字空间列表 | 类继承关系 | 组合类型列表 | $(BL\录(B | 文件列表 | 名字空间成员 | 组合类型成员 | 文件成员

firtex::index::CSingleIndexBarrelReader类参考

#include <SingleIndexBarrelReader.h>

继承图，类firtex::index::CSingleIndexBarrelReader

firtex::index::CIndexBarrelReader 所有成员的列表。

公有成员

 CSingleIndexBarrelReader (CDirectory *pDirectory, const tchar *name)
virtual ~CSingleIndexBarrelReader (void)
void open (const tchar *name)
document::CDocument * document (docid_t docID)
document::CField * field (docid_t docID, fieldid_t fid)
void deleteDocument (docid_t docID)
void undeleteAll ()
bool isDeleted (docid_t docID)
bool hasDeletions ()
count_t numDeletedDocs ()
CTermReader * termReader ()
CTermReader * termReader (const tchar *field)
CTermVectorReader * getTermVectorReader ()
CNormBytes * norms (const tchar *field)
CNormBytes * norms (fieldid_t fid)
CFieldsInfo & getFieldsInfo ()
uint64_t numTerms ()
void close ()

构造及析构函数文档

firtex::index::CSingleIndexBarrelReader::CSingleIndexBarrelReader (  CDirectory *  pDirectory,
const tchar *  name
) 
 

virtual firtex::index::CSingleIndexBarrelReader::~CSingleIndexBarrelReader (  void   )  [virtual]
 

成员函数文档

void firtex::index::CSingleIndexBarrelReader::close (   )  [virtual]
 

关闭索引桶，释放资源

实现了firtex::index::CIndexBarrelReader。

void firtex::index::CSingleIndexBarrelReader::deleteDocument (  docid_t  docID  )  [virtual]
 

删除索引文档

参数:
docID 文档编号

实现了firtex::index::CIndexBarrelReader。

document::CDocument* firtex::index::CSingleIndexBarrelReader::document (  docid_t  docID  )  [virtual]
 

返回文档docID的stored fields

参数:
docID 文档编号
返回:
文档对象，需外部维护内存

实现了firtex::index::CIndexBarrelReader。

document::CField* firtex::index::CSingleIndexBarrelReader::field (  docid_t  docID,
fieldid_t  fid
)  [virtual]
 

获取指定文档编号指定字段编号的文档对象

参数:
docID 文档编号
fid 字段编号
返回:
字段对象,当该字段不是存储字段或不存在时返回NULL 非内部对象,需外部删除

实现了firtex::index::CIndexBarrelReader。

CFieldsInfo& firtex::index::CSingleIndexBarrelReader::getFieldsInfo (   )  [inline, virtual]
 

获取域信息

实现了firtex::index::CIndexBarrelReader。

CTermVectorReader* firtex::index::CSingleIndexBarrelReader::getTermVectorReader (   )  [virtual]
 

获取词向量阅读器

返回:
词向量阅读器对象 内部对象,外部不能删除

实现了firtex::index::CIndexBarrelReader。

bool firtex::index::CSingleIndexBarrelReader::hasDeletions (   )  [virtual]
 

判断是否删除过文档

实现了firtex::index::CIndexBarrelReader。

bool firtex::index::CSingleIndexBarrelReader::isDeleted (  docid_t  docID  )  [virtual]
 

判断文档编号为docID的文档是否已经删除

参数:
docID 文档编号

实现了firtex::index::CIndexBarrelReader。

CNormBytes* firtex::index::CSingleIndexBarrelReader::norms (  fieldid_t  fid  )  [virtual]
 

获取指定域的norms Bytes

参数:
fid 域编号

实现了firtex::index::CIndexBarrelReader。

CNormBytes* firtex::index::CSingleIndexBarrelReader::norms (  const tchar *  field  )  [virtual]
 

获取指定域的norms Bytes

参数:
field 域名

实现了firtex::index::CIndexBarrelReader。

count_t firtex::index::CSingleIndexBarrelReader::numDeletedDocs (   )  [virtual]
 

删除文档总数

实现了firtex::index::CIndexBarrelReader。

uint64_t firtex::index::CSingleIndexBarrelReader::numTerms (   )  [virtual]
 

获取词总数

实现了firtex::index::CIndexBarrelReader。

void firtex::index::CSingleIndexBarrelReader::open (  const tchar *  name  )  [virtual]
 

打开指定的索引桶读

参数:
pDirectory 存储位置
name 索引桶名称

实现了firtex::index::CIndexBarrelReader。

CTermReader* firtex::index::CSingleIndexBarrelReader::termReader (  const tchar *  field  ) 
 

获取索引桶指定域的TermReader

参数:
如果失败则返回NULL 内存对象，外部不能删除

CTermReader* firtex::index::CSingleIndexBarrelReader::termReader (   )  [inline, virtual]
 

获取索引桶的TermReader

参数:
如果失败则返回NULL 内存对象，外部不能删除

实现了firtex::index::CIndexBarrelReader。

void firtex::index::CSingleIndexBarrelReader::undeleteAll (   )  [virtual]
 

恢复先前删除的所有文档，只有在调用optimize()前调用才有效

实现了firtex::index::CIndexBarrelReader。

该类的文档由以下文件生成：

http://www.firtex.org http://www.sourceforge.net/projects/firtex