dragon.ir.index.sequence

Class AbstractSequenceIndexWriter

java.lang.Object

dragon.ir.index.sequence.AbstractSequenceIndexWriter

All Implemented Interfaces:

IndexWriter

Direct Known Subclasses:

BasicSequenceIndexWriter, OnlineSequenceIndexWriter

public abstract class AbstractSequenceIndexWriter
extends Object
implements IndexWriter

The abstract index writer for sequencial data

Copyright: Copyright (c) 2005

Company: IST, Drexel University

Version:

1.0

Author:

Davis Zhou

Field Summary

Fields

Modifier and Type	Field and Description
protected IRCollection	collection
protected static int	doc_cache_size
protected IRDocIndexList	docIndexList
protected SimpleElementList	docKeyList
protected SequenceWriter	doctermMatrix
protected boolean	initialized
protected SortedArray	termCache
protected IRTermIndexList	termIndexList
protected SimpleElementList	termKeyList

Constructor Summary

Constructors

Constructor and Description
AbstractSequenceIndexWriter()

Method Summary

Modifier and Type	Method and Description
void	flush() For disk-based indexing, this method dump all information in memory to the files on disk.
boolean	indexed(String docKey)
int	size()
boolean	write(IRDoc curDoc, IRTerm[] arrTerm) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dragon.ir.index.IndexWriter

clean, close, initialize

Field Detail

doc_cache_size

protected static int doc_cache_size

termCache

protected SortedArray termCache

termKeyList

protected SimpleElementList termKeyList

docKeyList

protected SimpleElementList docKeyList

termIndexList

protected IRTermIndexList termIndexList

docIndexList

protected IRDocIndexList docIndexList

doctermMatrix

protected SequenceWriter doctermMatrix

collection

protected IRCollection collection

initialized

protected boolean initialized

Constructor Detail

AbstractSequenceIndexWriter

public AbstractSequenceIndexWriter()

Method Detail

indexed

public boolean indexed(String docKey)

size

public int size()

Specified by:

size in interface IndexWriter

Returns:

the number of documents indexed.

flush

public void flush()

Description copied from interface: IndexWriter

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

Specified by:

flush in interface IndexWriter

write

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

Description copied from interface: IndexWriter

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.

Specified by:

write in interface IndexWriter

Parameters:

curDoc - the current document

arrTerms - terms in the current document

arrRelations - relations in the current document

Returns:

true if written successfully

write

public boolean write(IRDoc curDoc,
                     IRTerm[] arrTerm)

Description copied from interface: IndexWriter

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.

Specified by:

write in interface IndexWriter

Parameters:

curDoc - the current document

arrTerm - terms in the current document

Returns:

true if written successfully