firtex::index::CIndexReader类参考

所有成员的列表。

公有成员
	CIndexReader ()
	CIndexReader (const tchar *indexname)
	CIndexReader (CDirectory *pDirectory)
	CIndexReader (CIndex *pIndex)
virtual	~CIndexReader (void)
string	getVersion ()
bool	isDeleted (docid_t docID)
bool	hasDeletions ()
count_t	deletedNumDocs ()
virtual void	open (const tchar *indexname)
virtual void	open (CDirectory *pDirectory)
virtual void	close ()
count_t	numDocs ()
count_t	maxDoc ()
document::CDocument *	document (docid_t docID)
document::CField *	field (docid_t docID, fieldid_t fid)
bool	seek (CTerm *term)
CTermDocs *	termDocs ()
CTermPositions *	termPositions ()
freq_t	docFreq (CTerm *term)
CTermInfo *	termInfo (CTerm *term)
CBarrelsInfo &	getBarrelsInfo ()
CIndexBarrelReader *	getBarrelReader ()
CFieldsInfo &	getFieldsInfo ()
void	attachIndex (CIndex *pIndex)
CIndex *	detachIndex ()
CIndex *	getIndex ()
CTermReader *	getTermReader ()
CTermVectorReader *	getTermVectorReader ()
int64_t	lastModified ()
void	lastModified (CDateTime &dt)
静态公有成员
int64_t	lastModified (CDirectory *pDirectory)
void	lastModified (CDirectory *pDirectory, CDateTime &dt)
保护属性
CIndex *	m_pIndex
CTermReader *	m_pTermReader
bool	m_bOwn

构造及析构函数文档

firtex::index::CIndexReader::CIndexReader (   )

firtex::index::CIndexReader::CIndexReader (  const tchar *  indexname  )

firtex::index::CIndexReader::CIndexReader (  CDirectory *  pDirectory  )

firtex::index::CIndexReader::CIndexReader (  CIndex *  pIndex  )

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

成员函数文档

void firtex::index::CIndexReader::attachIndex (  CIndex *  pIndex  )

捆绑索引器 参数: pIndex  索引器, attachIndex后,内存由内部维护，外部不能删除

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

关闭索引释放资源

count_t firtex::index::CIndexReader::deletedNumDocs (   )

删除文档总数

CIndex* firtex::index::CIndexReader::detachIndex (   )

释放索引器，释放后外部负责维护索引器，CIndexWriter不再持有该索引器 返回: 索引器 调用此函数后,外部负责删除

freq_t firtex::index::CIndexReader::docFreq (  CTerm *  term  )  [inline]

获取指定Term的文档频率 返回: 返回文档频率

document::CDocument * firtex::index::CIndexReader::document (  docid_t  docID  )  [inline]

返回文档docID的stored fields 参数: docID  文档编号 非内部对象,由外部删除

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

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

CIndexBarrelReader * firtex::index::CIndexReader::getBarrelReader (   )  [inline]

获取索引桶的读接口，适合高级用户 返回: 返回索引桶读接口引用 内部对象,外部不能删除

CBarrelsInfo& firtex::index::CIndexReader::getBarrelsInfo (   )

获取索引桶信息

CFieldsInfo & firtex::index::CIndexReader::getFieldsInfo (   )  [inline]

获取字段信息 返回: 字段信息,内部对象

CIndex* firtex::index::CIndexReader::getIndex (   )  [inline]

获取内部索引对象 返回: 内部索引器对象 内部对象,外部不能删除

CTermReader* firtex::index::CIndexReader::getTermReader (   )

获取内部TermReader对象 返回: 内部Term Reader对象 内部对象,外部不能删除

CTermVectorReader * firtex::index::CIndexReader::getTermVectorReader (   )  [inline]

获取Term Vector 阅读器 返回: 阅读器对象指针 内部对象,外部不能删除

string firtex::index::CIndexReader::getVersion (   )  [inline]

获取索引的版本号 返回: 版本号字符串，格式：名称.版本号

bool firtex::index::CIndexReader::hasDeletions (   )

判断是否有文档删除过

bool firtex::index::CIndexReader::isDeleted (  docid_t  docID  )

判断文档编号为docID的文档是否 参数: docID  文档编号

void firtex::index::CIndexReader::lastModified (  CDirectory *  pDirectory, CDateTime &  dt )  [inline, static]

获取索引的最后修改时间 参数: dt  CDateTime对象,用于返回值

int64_t firtex::index::CIndexReader::lastModified (  CDirectory *  pDirectory  )  [static]

获取索引的最后修改时间 参数: pDirectory  索引位置

void firtex::index::CIndexReader::lastModified (  CDateTime &  dt  )  [inline]

获取索引的最后修改时间 参数: dt  CDateTime对象,用于返回值

int64_t firtex::index::CIndexReader::lastModified (   )

获取索引的最后修改时间 返回: 64位整数,可以用localtime()获取 struct tm形式表示的时间

count_t firtex::index::CIndexReader::maxDoc (   )  [inline]

返回可能最大的文档编号，一般情况下如果没有删除文档则maxDoc()=numDocs() 可以用来决定分配文档数组的大小

count_t firtex::index::CIndexReader::numDocs (   )  [inline]

索引中包含的文档总数

virtual void firtex::index::CIndexReader::open (  CDirectory *  pDirectory  )  [virtual]

打开索引进行读 参数: pDirectory  索引存储位置，

virtual void firtex::index::CIndexReader::open (  const tchar *  indexname  )  [virtual]

打开索引进行读 参数: indexname  索引路径，

bool firtex::index::CIndexReader::seek (  CTerm *  term  )  [inline]

定位到指定term

CTermDocs * firtex::index::CIndexReader::termDocs (   )  [inline]

调用seek成功后，调用此函数返回当前搜索的term的docs信息 返回: 返回Docs 非内部对象,由外部删除

CTermInfo * firtex::index::CIndexReader::termInfo (  CTerm *  term  )  [inline]

获取指定Term的Term Info 返回: 返回Term Info

CTermPositions * firtex::index::CIndexReader::termPositions (   )  [inline]

调用search搜索成功后，调用此函数返回当前搜索term的positions信息 返回: 返回positions 非内部对象,由外部删除

成员数据文档

bool firtex::index::CIndexReader::m_bOwn [protected]

CIndex* firtex::index::CIndexReader::m_pIndex [protected]

CTermReader* firtex::index::CIndexReader::m_pTermReader [protected]

• include/index/IndexReader.h

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