com.exalead.pdoc.analysis

Interface DocumentProcessingContext

All Known Implementing Classes:

AnalysisDocumentProcessingContext

public interface DocumentProcessingContext

Context for processing a document in a DocumentProcessor

Method Summary

Modifier and Type	Method and Description
void	debug(ProcessableDocument doc, int code, java.lang.String message, java.lang.Throwable t) Log a debug information when processing this document.
void	error(ProcessableDocument doc, int code, java.lang.String message, java.lang.Throwable t) Log an error when processing this document.
java.lang.String	getCurrentBuildGroup() Get the current job associated buildGroup name
exa.io2.fs.WormFS	getCurrentBuildGroupWormFS() Get the current WormFS associated with the build group.
java.lang.String	getCurrentDataModel() Get the current job associated dataModel name
java.lang.String	getCurrentPipeline() Get the current job associated pipeline name
void	info(ProcessableDocument doc, int code, java.lang.String message, java.lang.Throwable t) Log an information when processing this document.
boolean	isTesting() Returns true if the pipeline is under test, false otherwise.
boolean	shouldContinueOnError()
void	warn(ProcessableDocument doc, int code, java.lang.String message, java.lang.Throwable t) Log a warning when processing this document.

Method Detail

info

void info(ProcessableDocument doc,
          int code,
          java.lang.String message,
          java.lang.Throwable t)

Log an information when processing this document.

warn

void warn(ProcessableDocument doc,
          int code,
          java.lang.String message,
          java.lang.Throwable t)

Log a warning when processing this document.

debug

void debug(ProcessableDocument doc,
           int code,
           java.lang.String message,
           java.lang.Throwable t)

Log a debug information when processing this document.

error

void error(ProcessableDocument doc,
           int code,
           java.lang.String message,
           java.lang.Throwable t)

Log an error when processing this document. A processor must either report an error using this member method OR throw an exception.

shouldContinueOnError

boolean shouldContinueOnError()

Returns:

whether a given processor should keep working when it encounters an error. Processors should only call this member method if they are able to continue despite the error. Even if this member method returns true, the processor *must* also report the encountered error using "error" member method.

getCurrentBuildGroup

java.lang.String getCurrentBuildGroup()

Get the current job associated buildGroup name

Returns:

The buildGroup name

getCurrentDataModel

java.lang.String getCurrentDataModel()

Get the current job associated dataModel name

Returns:

The dataModel name

getCurrentPipeline

java.lang.String getCurrentPipeline()

Get the current job associated pipeline name

Returns:

The pipeline name

getCurrentBuildGroupWormFS

exa.io2.fs.WormFS getCurrentBuildGroupWormFS()

Get the current WormFS associated with the build group.

Returns:

the current WormFS associated with the build group.

isTesting

boolean isTesting()

Returns true if the pipeline is under test, false otherwise. For example, it may be useful to avoid writing on disk during a test.

Returns:

true if the pipeline is under test, false otherwise.