com.exalead.pdoc.analysis

Class AnalysisDocumentProcessingContext

java.lang.Object

com.exalead.pdoc.analysis.AnalysisDocumentProcessingContext

All Implemented Interfaces:

DocumentProcessingContext

public class AnalysisDocumentProcessingContext
extends java.lang.Object
implements DocumentProcessingContext

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnalysisDocumentProcessingContext.Error

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<AnalysisDocumentProcessingContext.Error>	errors

Constructor Summary

Constructors

Constructor and Description
AnalysisDocumentProcessingContext()
AnalysisDocumentProcessingContext(java.lang.String buildGroup, java.lang.String dataModel, com.exalead.indexing.analysis.v10.AnalysisPipeline pipe, java.lang.String blacklistPath)
AnalysisDocumentProcessingContext(java.lang.String buildGroup, java.lang.String dataModel, com.exalead.indexing.analysis.v10.AnalysisPipeline pipe, java.lang.String blacklistPath, boolean testing)
AnalysisDocumentProcessingContext(java.lang.String buildGroup, exa.io2.fs.WormFS buildGroupFS, java.lang.String dataModel, com.exalead.indexing.analysis.v10.AnalysisPipeline pipe, java.lang.String blacklistPath)
AnalysisDocumentProcessingContext(java.lang.String buildGroup, exa.io2.fs.WormFS buildGroupFS, java.lang.String dataModel, com.exalead.indexing.analysis.v10.AnalysisPipeline pipe, java.lang.String blacklistPath, boolean testing)

Method Summary

Modifier and Type	Method and Description
void	addDocumentProcessorListener(DocumentProcessorListener listener)
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.
void	fireDocumentProcessorConditionTested(java.lang.String docProcName, ProcessableDocument document, DocumentProcessingContext context, boolean matched)
void	fireDocumentProcessorProcessingFinished(java.lang.String docProcName, ProcessableDocument document, DocumentProcessingContext context)
void	fireDocumentProcessorProcessingStarted(java.lang.String docProcName, ProcessableDocument document, DocumentProcessingContext context)
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
java.util.List<AnalysisDocumentProcessingContext.Error>	getErrors()
com.exalead.ndoc.NativeDocumentProcessingContext	getNativeContext()
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.
void	removeDocumentProcessorListener(DocumentProcessorListener listener)
void	reset() To be called after the processing of each doc
void	resetContinueStatus()
void	setErrorGenerator(java.lang.String generator)
boolean	shouldContinueOnError()
boolean	shouldStopProcessing()
void	stopProcessingAfterCurrentProcessor() When called the document will not go through the following processors in the pipeline.
void	warn(ProcessableDocument doc, int code, java.lang.String message, java.lang.Throwable t) Log a warning when processing this document.

Methods inherited from class java.lang.Object

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

Field Detail

errors

protected java.util.List<AnalysisDocumentProcessingContext.Error> errors

Constructor Detail

AnalysisDocumentProcessingContext

public AnalysisDocumentProcessingContext()

AnalysisDocumentProcessingContext

public AnalysisDocumentProcessingContext(java.lang.String buildGroup,
                                         java.lang.String dataModel,
                                         com.exalead.indexing.analysis.v10.AnalysisPipeline pipe,
                                         java.lang.String blacklistPath)

AnalysisDocumentProcessingContext

public AnalysisDocumentProcessingContext(java.lang.String buildGroup,
                                         java.lang.String dataModel,
                                         com.exalead.indexing.analysis.v10.AnalysisPipeline pipe,
                                         java.lang.String blacklistPath,
                                         boolean testing)

AnalysisDocumentProcessingContext

public AnalysisDocumentProcessingContext(java.lang.String buildGroup,
                                         exa.io2.fs.WormFS buildGroupFS,
                                         java.lang.String dataModel,
                                         com.exalead.indexing.analysis.v10.AnalysisPipeline pipe,
                                         java.lang.String blacklistPath)

AnalysisDocumentProcessingContext

public AnalysisDocumentProcessingContext(java.lang.String buildGroup,
                                         exa.io2.fs.WormFS buildGroupFS,
                                         java.lang.String dataModel,
                                         com.exalead.indexing.analysis.v10.AnalysisPipeline pipe,
                                         java.lang.String blacklistPath,
                                         boolean testing)

Method Detail

getErrors

public java.util.List<AnalysisDocumentProcessingContext.Error> getErrors()

setErrorGenerator

public void setErrorGenerator(java.lang.String generator)

debug

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

Description copied from interface: DocumentProcessingContext

Log a debug information when processing this document.

Specified by:

debug in interface DocumentProcessingContext

error

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

Description copied from interface: DocumentProcessingContext

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

Specified by:

error in interface DocumentProcessingContext

info

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

Description copied from interface: DocumentProcessingContext

Log an information when processing this document.

Specified by:

info in interface DocumentProcessingContext

warn

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

Description copied from interface: DocumentProcessingContext

Log a warning when processing this document.

Specified by:

warn in interface DocumentProcessingContext

shouldContinueOnError

public boolean shouldContinueOnError()

Specified by:

shouldContinueOnError in interface DocumentProcessingContext

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.

getNativeContext

public com.exalead.ndoc.NativeDocumentProcessingContext getNativeContext()

getCurrentBuildGroup

public java.lang.String getCurrentBuildGroup()

Description copied from interface: DocumentProcessingContext

Get the current job associated buildGroup name

Specified by:

getCurrentBuildGroup in interface DocumentProcessingContext

Returns:

The buildGroup name

getCurrentDataModel

public java.lang.String getCurrentDataModel()

Description copied from interface: DocumentProcessingContext

Get the current job associated dataModel name

Specified by:

getCurrentDataModel in interface DocumentProcessingContext

Returns:

The dataModel name

getCurrentBuildGroupWormFS

public exa.io2.fs.WormFS getCurrentBuildGroupWormFS()

Description copied from interface: DocumentProcessingContext

Get the current WormFS associated with the build group.

Specified by:

getCurrentBuildGroupWormFS in interface DocumentProcessingContext

Returns:

the current WormFS associated with the build group.

isTesting

public boolean isTesting()

Description copied from interface: DocumentProcessingContext

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

Specified by:

isTesting in interface DocumentProcessingContext

Returns:

true if the pipeline is under test, false otherwise.

getCurrentPipeline

public java.lang.String getCurrentPipeline()

Description copied from interface: DocumentProcessingContext

Get the current job associated pipeline name

Specified by:

getCurrentPipeline in interface DocumentProcessingContext

Returns:

The pipeline name

addDocumentProcessorListener

public void addDocumentProcessorListener(DocumentProcessorListener listener)

removeDocumentProcessorListener

public void removeDocumentProcessorListener(DocumentProcessorListener listener)

fireDocumentProcessorProcessingStarted

public void fireDocumentProcessorProcessingStarted(java.lang.String docProcName,
                                                   ProcessableDocument document,
                                                   DocumentProcessingContext context)

fireDocumentProcessorConditionTested

public void fireDocumentProcessorConditionTested(java.lang.String docProcName,
                                                 ProcessableDocument document,
                                                 DocumentProcessingContext context,
                                                 boolean matched)

fireDocumentProcessorProcessingFinished

public void fireDocumentProcessorProcessingFinished(java.lang.String docProcName,
                                                    ProcessableDocument document,
                                                    DocumentProcessingContext context)

stopProcessingAfterCurrentProcessor

public void stopProcessingAfterCurrentProcessor()

When called the document will not go through the following processors in the pipeline. This does not change the handling of the docs after the processing, use the processing flags on the document to discard and/or delete if necessary.

shouldStopProcessing

public boolean shouldStopProcessing()

resetContinueStatus

public void resetContinueStatus()

reset

public void reset()

To be called after the processing of each doc