org.galagosearch.core.index
Class DocumentNameWriter

java.lang.Object
  org.galagosearch.core.index.DocumentNameWriter

All Implemented Interfaces:

org.galagosearch.tupleflow.Processor<org.galagosearch.core.types.NumberedDocumentData>, org.galagosearch.tupleflow.Step

@InputClass(className="org.galagosearch.core.types.NumberedDocumentData")
public class DocumentNameWriter
extends java.lang.Object
implements org.galagosearch.tupleflow.Processor<org.galagosearch.core.types.NumberedDocumentData>

Writes a list of document names to a binary file. This class assumes that a document name is a string that contains at least one hyphen ('-') followed entirely by numbers. All TREC document names follow this convention, e.g.: WTX-B01-0001.

Author:

Trevor Strohman

Constructor Summary

DocumentNameWriter(org.galagosearch.tupleflow.TupleFlowParameters parameters)

Method Summary

void	close()
void	flush()
void	process(org.galagosearch.core.types.NumberedDocumentData numberedDocumentData)
void	putName(java.lang.String header, int footer, int footerWidth)
static void	verify(org.galagosearch.tupleflow.TupleFlowParameters parameters, org.galagosearch.tupleflow.execution.ErrorHandler handler)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentNameWriter

public DocumentNameWriter(org.galagosearch.tupleflow.TupleFlowParameters parameters)
                   throws java.io.FileNotFoundException,
                          java.io.IOException

Throws:

java.io.FileNotFoundException

java.io.IOException

Method Detail

flush

public void flush()
           throws java.io.IOException

Throws:

java.io.IOException

process

public void process(org.galagosearch.core.types.NumberedDocumentData numberedDocumentData)
             throws java.io.IOException

Specified by:

process in interface org.galagosearch.tupleflow.Processor<org.galagosearch.core.types.NumberedDocumentData>

Throws:

java.io.IOException

putName

public void putName(java.lang.String header,
                    int footer,
                    int footerWidth)
             throws java.io.IOException

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface org.galagosearch.tupleflow.Processor<org.galagosearch.core.types.NumberedDocumentData>

Throws:

java.io.IOException

verify

public static void verify(org.galagosearch.tupleflow.TupleFlowParameters parameters,
                          org.galagosearch.tupleflow.execution.ErrorHandler handler)