org.archive.cdxserver.writer

Class CDXWriter

java.lang.Object

org.archive.cdxserver.writer.CDXWriter

All Implemented Interfaces:

BaseProcessor

Direct Known Subclasses:

CDXListWriter, CDXToSearchResultWriter, HttpCDXWriter

public abstract class CDXWriter
extends Object
implements BaseProcessor

Constructor Summary

Constructors

Constructor and Description
CDXWriter()

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
boolean	isAborted()
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	printNumPages(int numPages, boolean printInBody)
void	serverError(Exception io)
void	setContentType(String contentType)
void	setMaxLines(int numLines, String remoteClusterUri)
void	trackLine(org.archive.format.cdx.CDXLine line) Called on each CDX line, just before timestamp range filtering (to and from parameters), regexp filtering, and collapser processing.
void	writeMiscLine(String text)

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

begin, end, writeLine, writeResumeKey

Constructor Detail

CDXWriter

public CDXWriter()

Method Detail

setContentType

public void setContentType(String contentType)

isAborted

public boolean isAborted()

printError

public void printError(String msg)

writeMiscLine

public void writeMiscLine(String text)

setMaxLines

public void setMaxLines(int numLines,
               String remoteClusterUri)

printNumPages

public void printNumPages(int numPages,
                 boolean printInBody)

close

public void close()

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

Parameters:

format - input format

Returns:

output format

See Also:

CDXFieldConstants

trackLine

public void trackLine(org.archive.format.cdx.CDXLine line)

Description copied from interface: BaseProcessor

Called on each CDX line, just before timestamp range filtering (to and from parameters), regexp filtering, and collapser processing. Typically used for counting the number of CDX lines collapsed / grouped.

Specified by:

trackLine in interface BaseProcessor

Parameters:

line - CDX line

serverError

public void serverError(Exception io)