org.archive.cdxserver.processor

Class WrappedProcessor

java.lang.Object

org.archive.cdxserver.processor.WrappedProcessor

All Implemented Interfaces:

BaseProcessor

Direct Known Subclasses:

ClosestTimestampSorted, DupeCountProcessor, DupeTimestampBestStatusFilter, GroupCountProcessor, LastNLineProcessor

public class WrappedProcessor
extends Object
implements BaseProcessor

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseProcessor	inner

Constructor Summary

Constructors

Constructor and Description
WrappedProcessor(BaseProcessor output)

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.
org.archive.format.cdx.FieldSplitFormat	modifyOutputFormat(org.archive.format.cdx.FieldSplitFormat format) Return output format (list of fields), given input format format.
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.
int	writeLine(org.archive.format.cdx.CDXLine line) Process line.
void	writeResumeKey(String resumeKey) Write resumption key.

Methods inherited from class java.lang.Object

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

Field Detail

inner

protected BaseProcessor inner

Constructor Detail

WrappedProcessor

public WrappedProcessor(BaseProcessor output)

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.

Specified by:

begin in interface BaseProcessor

writeLine

public int writeLine(org.archive.format.cdx.CDXLine line)

Description copied from interface: BaseProcessor

Process line.

Specified by:

writeLine in interface BaseProcessor

Parameters:

line - CDXLine

Returns:

1 if line is sent to output, 0 otherwise.

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.

Specified by:

writeResumeKey in interface BaseProcessor

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.

Specified by:

end in interface BaseProcessor

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

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