dragon.ir.index

Interface IndexWriter

All Known Implementing Classes:

AbstractIndexWriter, AbstractSequenceIndexWriter, BasicIndexWriter, BasicSequenceIndexWriter, OnlineIndexWriter, OnlineSequenceIndexWriter

public interface IndexWriter

Interface of index writer

Copyright: Copyright (c) 2005

Company: IST, Drexel University

Version:

1.0

Author:

Davis Zhou

Method Summary

Modifier and Type	Method and Description
void	clean() For disk-based indexing, this method delete all files under the indexing folder.
void	close()
void	flush() For disk-based indexing, this method dump all information in memory to the files on disk.
void	initialize() It is required to call this method before calling the write method
int	size()
boolean	write(IRDoc curDoc, IRTerm[] arrTerms) All fields (doc key, doc index, term count, term number, relation count, and relation number) of the IRDoc object should be set.
boolean	write(IRDoc curDoc, IRTerm[] arrTerms, IRRelation[] arrRelations) All fields (doc key, doc index, term count, term number, relation count, and relation number) of the IRDoc object should be set.

Method Detail

initialize

void initialize()

It is required to call this method before calling the write method

close

void close()

clean

void clean()

For disk-based indexing, this method delete all files under the indexing folder.

write

boolean write(IRDoc curDoc,
              IRTerm[] arrTerms,
              IRRelation[] arrRelations)

All fields (doc key, doc index, term count, term number, relation count, and relation number) of the IRDoc object should be set. Fields of IRTerm including term index and term frequency should be set. Fields of IRRelation including relation index, first term, second term, and relation frequency should be set. No duplicated IRTerm or IRRelation is allowed.

Parameters:

curDoc - the current document

arrTerms - terms in the current document

arrRelations - relations in the current document

Returns:

true if written successfully

write

boolean write(IRDoc curDoc,
              IRTerm[] arrTerms)

All fields (doc key, doc index, term count, term number, relation count, and relation number) of the IRDoc object should be set. Fields of IRTerm including term index and term frequency should be set. No duplicated IRTerm is allowed.

Parameters:

curDoc - the current document

arrTerms - terms in the current document

Returns:

true if written successfully

size

int size()

Returns:

the number of documents indexed.

flush

void flush()

For disk-based indexing, this method dump all information in memory to the files on disk.