org.archive.wayback.resourceindex.cdxserver

Class CDXToSearchResultWriter

java.lang.Object

org.archive.cdxserver.writer.CDXWriter

org.archive.wayback.resourceindex.cdxserver.CDXToSearchResultWriter

All Implemented Interfaces:

BaseProcessor

Direct Known Subclasses:

CDXToCaptureSearchResultsWriter, CDXToUrlSearchResultWriter

public abstract class CDXToSearchResultWriter
extends CDXWriter

Receive CDXLines, produce SearchResults.

Used for implementing ResourceIndex on top of CDXServer.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	msg
protected CDXQuery	query

Constructor Summary

Constructors

Constructor and Description
CDXToSearchResultWriter(CDXQuery query)

Method Summary

Methods

Modifier and Type	Method and Description
void	begin() This method will be called just before looping over the sequence of CDX lines.
void	end() Called at the end.
String	getErrorMsg()
CDXQuery	getQuery()
abstract SearchResults	getSearchResults()
org.archive.format.cdx.FieldSplitFormat	modifyOutputFormat(org.archive.format.cdx.FieldSplitFormat format) Return output format (list of fields), given input format format.
void	printError(String msg)
void	writeResumeKey(String resumeKey) Write resumption key.

Methods inherited from class org.archive.cdxserver.writer.CDXWriter

close, isAborted, printNumPages, serverError, setContentType, setMaxLines, trackLine, writeMiscLine

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.archive.cdxserver.processor.BaseProcessor

writeLine

Field Detail

query

protected CDXQuery query

msg

protected String msg

Constructor Detail

CDXToSearchResultWriter

public CDXToSearchResultWriter(CDXQuery query)

Method Detail

begin

public void begin()

Description copied from interface: BaseProcessor

This method will be called just before looping over the sequence of CDX lines. Intermediary processor must call begin() on nested processor.

writeResumeKey

public void writeResumeKey(String resumeKey)

Description copied from interface: BaseProcessor

Write resumption key. Only the final CDXWriter should do actual work. All intermediaries shall simply call writeResumeKey(resumeKey) on nested processor.

end

public void end()

Description copied from interface: BaseProcessor

Called at the end. Perform any clean ups / finalizations here. Intermediaries processor should call end() on nested processor.

getSearchResults

public abstract SearchResults getSearchResults()

getQuery

public CDXQuery getQuery()

printError

public void printError(String msg)

Overrides:

printError in class CDXWriter

getErrorMsg

public String getErrorMsg()

modifyOutputFormat

public org.archive.format.cdx.FieldSplitFormat modifyOutputFormat(org.archive.format.cdx.FieldSplitFormat format)

Description copied from interface: BaseProcessor

Return output format (list of fields), given input format format. Intermediaries should call modifyOutputFormat(format) on nested processor first, then make appropriate changes to it if they add/remove fields.

Specified by:

modifyOutputFormat in interface BaseProcessor

Overrides:

modifyOutputFormat in class CDXWriter

Parameters:

format - input format

Returns:

output format

See Also:

CDXFieldConstants