firtex::index::CIndexWriter类参考

所有成员的列表。

公有类型
enum	MergeMode { NO_MERGE = 0, MERGE = 1, OPTIMIZE = 2, DELDOCS_OPTIMIZE = 3 }
公有成员
	CIndexWriter (const tchar *indexName, CAnalyzer *analyzer, bool bCreate=true, MergeMode mm=MERGE)
	CIndexWriter (CDirectory *pDirectory, CAnalyzer *analyzer, bool bCreate=true, MergeMode mm=MERGE)
	CIndexWriter (CAnalyzer *analyzer, CIndex *pIndex)
virtual	~CIndexWriter ()
void	open (const tchar *indexName, CAnalyzer *analyzer, bool bCreate=true, MergeMode mm=MERGE)
void	open (CDirectory *pDirectory, CAnalyzer *analyzer, bool bCreate=true, MergeMode mm=MERGE)
bool	addDocument (const tchar *filename)
bool	addDocument (CIndexParameter *pIndexParam)
bool	addDocument (document::CDocument *pDoc)
bool	addIndex (CDirectory *pDirectory)
void	mergeIndex ()
void	optimizeIndex (bool bDeleteDocs=false)
void	close ()
void	attachAnalyzer (CAnalyzer *pAnalyzer)
CAnalyzer *	detachAnalyzer ()
void	attachIndex (CIndex *pIndex)
CIndex *	detachIndex ()
CIndex *	getIndex ()
静态公有成员
void	buildIndex (const tchar *argFile)
void	buildIndex (CArgument *pArgument)
firtex::collection::CCollection *	prepareBuildIndex (const tchar *argFile)
firtex::collection::CCollection *	prepareBuildIndex (CArgument *pArgument)
保护属性
CAnalyzer *	m_pAnalyzer
CIndex *	m_pIndexer
MergeMode	m_eMergeMode
bool	m_bMerged

成员枚举类型文档

enum firtex::index::CIndexWriter::MergeMode

枚举值: NO_MERGE  MERGE  OPTIMIZE  DELDOCS_OPTIMIZE

构造及析构函数文档

firtex::index::CIndexWriter::CIndexWriter (  const tchar *  indexName, CAnalyzer *  analyzer, bool  bCreate = true, MergeMode  mm = MERGE )

firtex::index::CIndexWriter::CIndexWriter (  CDirectory *  pDirectory, CAnalyzer *  analyzer, bool  bCreate = true, MergeMode  mm = MERGE )

firtex::index::CIndexWriter::CIndexWriter (  CAnalyzer *  analyzer, CIndex *  pIndex )

virtual firtex::index::CIndexWriter::~CIndexWriter (   )

成员函数文档

bool firtex::index::CIndexWriter::addDocument (  document::CDocument *  pDoc  )  [inline]

添加文档进行索引 参数: pDoc  文档对象 返回: 添加成功则返回true否则返回false

bool firtex::index::CIndexWriter::addDocument (  CIndexParameter *  pIndexParam  )

添加文档进行索引 参数: pArg  索引参数 返回: 添加成功则返回true否则返回false

bool firtex::index::CIndexWriter::addDocument (  const tchar *  filename  )

添加文档进行索引 参数: filename  文档路径名 返回: 添加成功则返回true否则返回false

bool firtex::index::CIndexWriter::addIndex (  CDirectory *  pDirectory  )

添加并合并索引 参数: pDirectory  需要添加并合并的索引,必须是兼容的索引

void firtex::index::CIndexWriter::attachAnalyzer (  CAnalyzer *  pAnalyzer  )

关联分析器 参数: pAnalyzer  分析器,关联后由内部维护，外部不能删除

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

关联索引器 参数: pIndex  索引器,由内部维护，外部不能删除

void firtex::index::CIndexWriter::buildIndex (  CArgument *  pArgument  )  [static]

根据参数对象提供的参数建立索引 参数: pArgument  参数对象,非内部对象，外部维护

void firtex::index::CIndexWriter::buildIndex (  const tchar *  argFile  )  [static]

根据参数文件中的参数设置建立索引 参数: argFile  参数文件 参见: CArgument

void firtex::index::CIndexWriter::close (   )

结束索引,释放资源

CAnalyzer* firtex::index::CIndexWriter::detachAnalyzer (   )

撤销分析器，撤销后外部负责维护分析器，CIndexWriter不再持有该分析器 返回: 分析器，外部维护

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

撤销索引器，撤销后外部负责维护索引器，CIndexWriter不再持有该索引器 返回: 索引器，外部维护

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

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

void firtex::index::CIndexWriter::mergeIndex (   )

合并索引，合并后子索引数目<merge factor

void firtex::index::CIndexWriter::open (  CDirectory *  pDirectory, CAnalyzer *  analyzer, bool  bCreate = true, MergeMode  mm = MERGE )

以读或写方式打开索引 参数: pDirectory  索引存储位置 analyzer  分析器 bCreate  true:创建新的索引，如果该路径索引已经存在则自动删除 false:如果该路径索引已经存在则进行增量索引，否则创建新的索引 mm  索引合并方式

void firtex::index::CIndexWriter::open (  const tchar *  indexName, CAnalyzer *  analyzer, bool  bCreate = true, MergeMode  mm = MERGE )

以读或写方式打开索引 参数: indexName  索引路径名 analyzer  分析器 bCreate  true:创建新的索引，如果该路径索引已经存在则自动删除 false:如果该路径索引已经存在则进行增量索引，否则创建新的索引 mm  索引合并方式

void firtex::index::CIndexWriter::optimizeIndex (  bool  bDeleteDocs = false  )

优化索引，优化后索引数目为1 参数: bDeleteDocs  是否真正删除用户已删除文档的索引数据。删除后将无法恢复删除文档

firtex::collection::CCollection* firtex::index::CIndexWriter::prepareBuildIndex (  CArgument *  pArgument  )  [static]

根据参数文件中的参数设置生成建索引需要的所有对象 参数: pArgument  参数对象,非内部对象，外部维护 返回: Collection对象,可以调用CCollection::scan()开始进行建索引操作 非内部对象,需要外部删除, 参见: CArgument

firtex::collection::CCollection* firtex::index::CIndexWriter::prepareBuildIndex (  const tchar *  argFile  )  [static]

根据参数文件中的参数设置生成建索引需要的所有对象 参数: argFile  参数文件 返回: Collection对象,可以调用CCollection::scan()开始进行建索引操作 非内部对象,需要外部删除, 参见: CArgument

成员数据文档

bool firtex::index::CIndexWriter::m_bMerged [protected]

MergeMode firtex::index::CIndexWriter::m_eMergeMode [protected]

CAnalyzer* firtex::index::CIndexWriter::m_pAnalyzer [protected]

CIndex* firtex::index::CIndexWriter::m_pIndexer [protected]

• include/index/IndexWriter.h

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