AnalysisPipeline (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.indexing.analysis.v10.AnalysisPipeline

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class AnalysisPipeline
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable
```
A document analysis pipeline.
Each pipeline has an associated accept condition. This condition is tested for each input document.
If a document matches the condition, it is processed by this pipeline.
If not, the condition is tested for the next pipeline in the list of pipelines defined in a DocumentAnalysis object.
A document refused by all pipelines is neither processed nor indexed.

Pipeline processing is made of several stages:
- Document Processing Stage - is performed by a list of DocumentProcessor which process each Document sequentially. Document Processors manipulate the 'DocumentParts' (binary data pushed through the PAPI) and the 'DocumentChunks' (textual data obtained either from PAPI meta or by processing of Document Part or by processing of pre-existing Document Chunks)
  Each DocumentChunk has a textual content, a ContextName, a language, a score, may belong to a DocumentPart.
  A DocumentChunk belonging to no DocumentPart is called a root DocumentChunk.
- Semantic Processing Stage - involves a list of SemanticProcessor which process each Document Chunk of each Document sequentially (except those for which Semantic Processing is disabled in the mapping).
  Semantic Processing segments text into 'tokens' and then processes text as a flow of tokens. SemanticAnnotations are produced on each token.
- Mapping - involves mapping DocumentChunk and Semantic Annotations to index fields.
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`AcceptCondition`	`acceptCondition`
`boolean`	`autoBlacklistDocuments`
`boolean`	`autoconfigureFromDataModel`
`static boolean`	`DEFAULT_AUTO_BLACKLIST_DOCUMENTS`
`static boolean`	`DEFAULT_AUTOCONFIGURE_FROM_DATA_MODEL`
`static boolean`	`DEFAULT_DOCUMENT_PROCESSORS_PROFILING`
`static java.lang.String`	`DEFAULT_ERROR_ACTION`
`static boolean`	`DEFAULT_GLOBAL_LOG_DOCUMENT_ERRORS`
`static boolean`	`DEFAULT_REPORT_DOCUMENT_ERRORS`
`static int`	`DEFAULT_SEMANTIC_PIPE_TIMEOUT`
`static boolean`	`DEFAULT_SEMANTIC_PROCESSORS_PROFILING`
`static long`	`DEFAULT_SLOW_DOCUMENT_WARNING_TIME_U_S`
`java.util.List<DocumentProcessor>`	`documentProcessor`
`boolean`	`documentProcessorsProfiling`
`java.lang.String`	`errorAction`
`FilteringConfiguration`	`filteringConfiguration`
`boolean`	`globalLogDocumentErrors`
`java.util.List<LanguageConfiguration>`	`languageConfiguration`
`MappingConfiguration`	`mappingConfiguration`
`java.lang.String`	`name`
`boolean`	`reportDocumentErrors`
`int`	`semanticPipeTimeout`
`java.util.List<SemanticProcessor>`	`semanticProcessor`
`boolean`	`semanticProcessorsProfiling`
`long`	`slowDocumentWarningTimeUS`
`java.lang.String`	`tokenizationConfig`

Constructor Summary

Constructors
Constructor and Description

AnalysisPipeline()

AnalysisPipeline(AnalysisPipeline o)
Copy constructor

Constructors
Constructor and Description
`AnalysisPipeline()`
`AnalysisPipeline(AnalysisPipeline o)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this AnalysisPipeline.
`static AnalysisPipeline`	`fromString(java.lang.String s)` String representation of this AnalysisPipeline.
`AcceptCondition`	`getAcceptCondition()`
`java.util.List<DocumentProcessor>`	`getDocumentProcessor()`
`java.util.Map<java.lang.String,DocumentProcessor>`	`getDocumentProcessorAsMap()` Get the map of DocumentProcessor, indexed by name
`DocumentProcessor`	`getDocumentProcessorByName(java.lang.String _lookup)` Get the DocumentProcessor for which the name matches _lookup
`java.lang.String`	`getErrorAction()` Specifies the action to launch if there is a document error during processing: "discard": Discards the document from the job.
`FilteringConfiguration`	`getFilteringConfiguration()`
`java.util.List<LanguageConfiguration>`	`getLanguageConfiguration()`
`java.util.Map<java.lang.String,LanguageConfiguration>`	`getLanguageConfigurationAsMap()` Get the map of LanguageConfiguration, indexed by language
`LanguageConfiguration`	`getLanguageConfigurationByLanguage(java.lang.String _lookup)` Get the LanguageConfiguration for which the language matches _lookup
`MappingConfiguration`	`getMappingConfiguration()`
`java.lang.String`	`getName()`
`int`	`getSemanticPipeTimeout()` CPU-time limit for the processing of a text chunk by the semantic pipe, in seconds.
`java.util.List<SemanticProcessor>`	`getSemanticProcessor()`
`java.util.Map<java.lang.String,SemanticProcessor>`	`getSemanticProcessorAsMap()` Get the map of SemanticProcessor, indexed by name
`SemanticProcessor`	`getSemanticProcessorByName(java.lang.String _lookup)` Get the SemanticProcessor for which the name matches _lookup
`long`	`getSlowDocumentWarningTimeUS()` If the processing of a document is longer than this time, a message will be printed in the analyzer log. A value of 0 disables the warning feature.
`java.lang.String`	`getTokenizationConfig()` Reference to the TokenizationConfig object to use for tokenization during Semantic Processing Stage.
`boolean`	`isAutoBlacklistDocuments()` Tries to add to a block list the documents triggering serious failure automatically. This option helps preventing loop failures, that is to say, when documents always trigger the same analysis process failures.
`boolean`	`isAutoconfigureFromDataModel()`
`boolean`	`isDocumentProcessorsProfiling()` Logs the CPU time spent for each document processor and for the main indexing phase. The total time spent for each processor is dumped in the analyzer log at the end of the job.
`boolean`	`isGlobalLogDocumentErrors()` Logs errors and exceptions reported by the processors in the global log (without stack trace).
`boolean`	`isReportDocumentErrors()` Reports the document errors in the global reporting store, for further analysis.
`boolean`	`isSemanticProcessorsProfiling()` Logs the CPU time spent for each semantic processor. The total time spent for each processor is dumped in the analyzer log at the end of the job. Warning: This feature strongly impacts performance, only enable it if required.
`AnalysisPipeline`	`makeCopy()` Creates and returns a deep copy of this AnalysisPipeline.
`static AnalysisPipeline`	`readFrom(java.io.InputStream is)` Read this AnalysisPipeline from an XML fragment.
`boolean`	`removeDocumentProcessorByName(java.lang.String _lookup)` Removes the DocumentProcessor for which the name matches _lookup
`boolean`	`removeLanguageConfigurationByLanguage(java.lang.String _lookup)` Removes the LanguageConfiguration for which the language matches _lookup
`boolean`	`removeSemanticProcessorByName(java.lang.String _lookup)` Removes the SemanticProcessor for which the name matches _lookup
`void`	`setAcceptCondition(AcceptCondition acceptCondition)`
`void`	`setAutoBlacklistDocuments(boolean autoBlacklistDocuments)` Tries to add to a block list the documents triggering serious failure automatically. This option helps preventing loop failures, that is to say, when documents always trigger the same analysis process failures.
`void`	`setAutoconfigureFromDataModel(boolean autoconfigureFromDataModel)`
`void`	`setDocumentProcessorsProfiling(boolean documentProcessorsProfiling)` Logs the CPU time spent for each document processor and for the main indexing phase. The total time spent for each processor is dumped in the analyzer log at the end of the job.
`void`	`setErrorAction(java.lang.String errorAction)` Specifies the action to launch if there is a document error during processing: "discard": Discards the document from the job.
`void`	`setFilteringConfiguration(FilteringConfiguration filteringConfiguration)`
`void`	`setGlobalLogDocumentErrors(boolean globalLogDocumentErrors)` Logs errors and exceptions reported by the processors in the global log (without stack trace).
`void`	`setMappingConfiguration(MappingConfiguration mappingConfiguration)`
`void`	`setName(java.lang.String name)`
`void`	`setReportDocumentErrors(boolean reportDocumentErrors)` Reports the document errors in the global reporting store, for further analysis.
`void`	`setSemanticPipeTimeout(int semanticPipeTimeout)` CPU-time limit for the processing of a text chunk by the semantic pipe, in seconds.
`void`	`setSemanticProcessorsProfiling(boolean semanticProcessorsProfiling)` Logs the CPU time spent for each semantic processor. The total time spent for each processor is dumped in the analyzer log at the end of the job. Warning: This feature strongly impacts performance, only enable it if required.
`void`	`setSlowDocumentWarningTimeUS(long slowDocumentWarningTimeUS)` If the processing of a document is longer than this time, a message will be printed in the analyzer log. A value of 0 disables the warning feature.
`void`	`setTokenizationConfig(java.lang.String tokenizationConfig)` Reference to the TokenizationConfig object to use for tokenization during Semantic Processing Stage.
`java.lang.String`	`toString()` String representation of this AnalysisPipeline.
`AnalysisPipeline`	`withAcceptCondition(AcceptCondition acceptCondition)`
`AnalysisPipeline`	`withAutoBlacklistDocuments(boolean autoBlacklistDocuments)`
`AnalysisPipeline`	`withAutoBlacklistDocuments(java.lang.Boolean autoBlacklistDocuments)`
`AnalysisPipeline`	`withAutoconfigureFromDataModel(boolean autoconfigureFromDataModel)`
`AnalysisPipeline`	`withAutoconfigureFromDataModel(java.lang.Boolean autoconfigureFromDataModel)`
`AnalysisPipeline`	`withDocumentProcessor(java.util.Collection<DocumentProcessor> __values)`
`AnalysisPipeline`	`withDocumentProcessor(DocumentProcessor... __values)`
`AnalysisPipeline`	`withDocumentProcessorsProfiling(boolean documentProcessorsProfiling)`
`AnalysisPipeline`	`withDocumentProcessorsProfiling(java.lang.Boolean documentProcessorsProfiling)`
`AnalysisPipeline`	`withErrorAction(java.lang.String errorAction)`
`AnalysisPipeline`	`withFilteringConfiguration(FilteringConfiguration filteringConfiguration)`
`AnalysisPipeline`	`withGlobalLogDocumentErrors(boolean globalLogDocumentErrors)`
`AnalysisPipeline`	`withGlobalLogDocumentErrors(java.lang.Boolean globalLogDocumentErrors)`
`AnalysisPipeline`	`withLanguageConfiguration(java.util.Collection<LanguageConfiguration> __values)`
`AnalysisPipeline`	`withLanguageConfiguration(LanguageConfiguration... __values)`
`AnalysisPipeline`	`withMappingConfiguration(MappingConfiguration mappingConfiguration)`
`AnalysisPipeline`	`withName(java.lang.String name)`
`AnalysisPipeline`	`withReportDocumentErrors(boolean reportDocumentErrors)`
`AnalysisPipeline`	`withReportDocumentErrors(java.lang.Boolean reportDocumentErrors)`
`AnalysisPipeline`	`withSemanticPipeTimeout(int semanticPipeTimeout)`
`AnalysisPipeline`	`withSemanticPipeTimeout(java.lang.Integer semanticPipeTimeout)`
`AnalysisPipeline`	`withSemanticProcessor(java.util.Collection<SemanticProcessor> __values)`
`AnalysisPipeline`	`withSemanticProcessor(SemanticProcessor... __values)`
`AnalysisPipeline`	`withSemanticProcessorsProfiling(boolean semanticProcessorsProfiling)`
`AnalysisPipeline`	`withSemanticProcessorsProfiling(java.lang.Boolean semanticProcessorsProfiling)`
`AnalysisPipeline`	`withSlowDocumentWarningTimeUS(long slowDocumentWarningTimeUS)`
`AnalysisPipeline`	`withSlowDocumentWarningTimeUS(java.lang.Long slowDocumentWarningTimeUS)`
`AnalysisPipeline`	`withTokenizationConfig(java.lang.String tokenizationConfig)`
`void`	`writeTo(java.io.OutputStream os)` Write this AnalysisPipeline as an XML fragment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

documentProcessor

public java.util.List<DocumentProcessor> documentProcessor

semanticProcessor

public java.util.List<SemanticProcessor> semanticProcessor

acceptCondition
```
public AcceptCondition acceptCondition
```

mappingConfiguration

public MappingConfiguration mappingConfiguration

filteringConfiguration

public FilteringConfiguration filteringConfiguration

languageConfiguration

public java.util.List<LanguageConfiguration> languageConfiguration

name
```
public java.lang.String name
```

errorAction
```
public java.lang.String errorAction
```

DEFAULT_ERROR_ACTION

public static final java.lang.String DEFAULT_ERROR_ACTION

See Also:: Constant Field Values

reportDocumentErrors
```
public boolean reportDocumentErrors
```

DEFAULT_REPORT_DOCUMENT_ERRORS
```
public static final boolean DEFAULT_REPORT_DOCUMENT_ERRORS
```
See Also:

Constant Field Values

globalLogDocumentErrors
```
public boolean globalLogDocumentErrors
```

DEFAULT_GLOBAL_LOG_DOCUMENT_ERRORS
```
public static final boolean DEFAULT_GLOBAL_LOG_DOCUMENT_ERRORS
```
See Also:

Constant Field Values

autoBlacklistDocuments
```
public boolean autoBlacklistDocuments
```

DEFAULT_AUTO_BLACKLIST_DOCUMENTS
```
public static final boolean DEFAULT_AUTO_BLACKLIST_DOCUMENTS
```
See Also:

Constant Field Values

tokenizationConfig

public java.lang.String tokenizationConfig

autoconfigureFromDataModel

public boolean autoconfigureFromDataModel

DEFAULT_AUTOCONFIGURE_FROM_DATA_MODEL
```
public static final boolean DEFAULT_AUTOCONFIGURE_FROM_DATA_MODEL
```
See Also:

Constant Field Values

documentProcessorsProfiling

public boolean documentProcessorsProfiling

DEFAULT_DOCUMENT_PROCESSORS_PROFILING
```
public static final boolean DEFAULT_DOCUMENT_PROCESSORS_PROFILING
```
See Also:

Constant Field Values

semanticPipeTimeout
```
public int semanticPipeTimeout
```

DEFAULT_SEMANTIC_PIPE_TIMEOUT
```
public static final int DEFAULT_SEMANTIC_PIPE_TIMEOUT
```
See Also:

Constant Field Values

slowDocumentWarningTimeUS
```
public long slowDocumentWarningTimeUS
```

DEFAULT_SLOW_DOCUMENT_WARNING_TIME_U_S
```
public static final long DEFAULT_SLOW_DOCUMENT_WARNING_TIME_U_S
```
See Also:

Constant Field Values

semanticProcessorsProfiling

public boolean semanticProcessorsProfiling

DEFAULT_SEMANTIC_PROCESSORS_PROFILING
```
public static final boolean DEFAULT_SEMANTIC_PROCESSORS_PROFILING
```
See Also:

Constant Field Values

Constructor Detail

AnalysisPipeline
```
public AnalysisPipeline()
```

AnalysisPipeline

public AnalysisPipeline(AnalysisPipeline o)

Copy constructor

Method Detail
- getDocumentProcessor
```
public java.util.List<DocumentProcessor> getDocumentProcessor()
```
- getDocumentProcessorByName
```
public DocumentProcessor getDocumentProcessorByName(java.lang.String _lookup)
```
  Get the DocumentProcessor for which the name matches _lookup
  
  Returns:
  
  null if no matching DocumentProcessor is found
- getDocumentProcessorAsMap
```
public java.util.Map<java.lang.String,DocumentProcessor> getDocumentProcessorAsMap()
```
  Get the map of DocumentProcessor, indexed by name
- removeDocumentProcessorByName
```
public boolean removeDocumentProcessorByName(java.lang.String _lookup)
```
  Removes the DocumentProcessor for which the name matches _lookup
  
  Returns:
  
  false if no matching DocumentProcessor is found, true if one was found
- withDocumentProcessor
```
public AnalysisPipeline withDocumentProcessor(DocumentProcessor... __values)
```
- withDocumentProcessor
```
public AnalysisPipeline withDocumentProcessor(java.util.Collection<DocumentProcessor> __values)
```
- getSemanticProcessor
```
public java.util.List<SemanticProcessor> getSemanticProcessor()
```
- getSemanticProcessorByName
```
public SemanticProcessor getSemanticProcessorByName(java.lang.String _lookup)
```
  Get the SemanticProcessor for which the name matches _lookup
  
  Returns:
  
  null if no matching SemanticProcessor is found
- getSemanticProcessorAsMap
```
public java.util.Map<java.lang.String,SemanticProcessor> getSemanticProcessorAsMap()
```
  Get the map of SemanticProcessor, indexed by name
- removeSemanticProcessorByName
```
public boolean removeSemanticProcessorByName(java.lang.String _lookup)
```
  Removes the SemanticProcessor for which the name matches _lookup
  
  Returns:
  
  false if no matching SemanticProcessor is found, true if one was found
- withSemanticProcessor
```
public AnalysisPipeline withSemanticProcessor(SemanticProcessor... __values)
```
- withSemanticProcessor
```
public AnalysisPipeline withSemanticProcessor(java.util.Collection<SemanticProcessor> __values)
```
- setAcceptCondition
```
public void setAcceptCondition(AcceptCondition acceptCondition)
```
- getAcceptCondition
```
public AcceptCondition getAcceptCondition()
```
- withAcceptCondition
```
public AnalysisPipeline withAcceptCondition(AcceptCondition acceptCondition)
```
- setMappingConfiguration
```
public void setMappingConfiguration(MappingConfiguration mappingConfiguration)
```
- getMappingConfiguration
```
public MappingConfiguration getMappingConfiguration()
```
- withMappingConfiguration
```
public AnalysisPipeline withMappingConfiguration(MappingConfiguration mappingConfiguration)
```
- setFilteringConfiguration
```
public void setFilteringConfiguration(FilteringConfiguration filteringConfiguration)
```
- getFilteringConfiguration
```
public FilteringConfiguration getFilteringConfiguration()
```
- withFilteringConfiguration
```
public AnalysisPipeline withFilteringConfiguration(FilteringConfiguration filteringConfiguration)
```
- getLanguageConfiguration
```
public java.util.List<LanguageConfiguration> getLanguageConfiguration()
```
- getLanguageConfigurationByLanguage
```
public LanguageConfiguration getLanguageConfigurationByLanguage(java.lang.String _lookup)
```
  Get the LanguageConfiguration for which the language matches _lookup
  
  Returns:
  
  null if no matching LanguageConfiguration is found
- getLanguageConfigurationAsMap
```
public java.util.Map<java.lang.String,LanguageConfiguration> getLanguageConfigurationAsMap()
```
  Get the map of LanguageConfiguration, indexed by language
- removeLanguageConfigurationByLanguage
```
public boolean removeLanguageConfigurationByLanguage(java.lang.String _lookup)
```
  Removes the LanguageConfiguration for which the language matches _lookup
  
  Returns:
  
  false if no matching LanguageConfiguration is found, true if one was found
- withLanguageConfiguration
```
public AnalysisPipeline withLanguageConfiguration(LanguageConfiguration... __values)
```
- withLanguageConfiguration
```
public AnalysisPipeline withLanguageConfiguration(java.util.Collection<LanguageConfiguration> __values)
```
- setName
```
public void setName(java.lang.String name)
```
- getName
```
public java.lang.String getName()
```
- withName
```
public AnalysisPipeline withName(java.lang.String name)
```
- setErrorAction
```
public void setErrorAction(java.lang.String errorAction)
```
  Specifies the action to launch if there is a document error during processing:
  - "discard": Discards the document from the job. If the document was already in the index, it's not removed if it already existed.
  - "delete": Discards the document from the job and deletes it from the index.
  - "continue": Keeps processing the document. The document will probably be incomplete in the index.
- getErrorAction
```
public java.lang.String getErrorAction()
```
  Specifies the action to launch if there is a document error during processing:
  - "discard": Discards the document from the job. If the document was already in the index, it's not removed if it already existed.
  - "delete": Discards the document from the job and deletes it from the index.
  - "continue": Keeps processing the document. The document will probably be incomplete in the index.
- withErrorAction
```
public AnalysisPipeline withErrorAction(java.lang.String errorAction)
```
- setReportDocumentErrors
```
public void setReportDocumentErrors(boolean reportDocumentErrors)
```
  Reports the document errors in the global reporting store, for further analysis.
- isReportDocumentErrors
```
public boolean isReportDocumentErrors()
```
  Reports the document errors in the global reporting store, for further analysis.
- withReportDocumentErrors
```
public AnalysisPipeline withReportDocumentErrors(boolean reportDocumentErrors)
```
- withReportDocumentErrors
```
public AnalysisPipeline withReportDocumentErrors(java.lang.Boolean reportDocumentErrors)
```
- setGlobalLogDocumentErrors
```
public void setGlobalLogDocumentErrors(boolean globalLogDocumentErrors)
```
  Logs errors and exceptions reported by the processors in the global log (without stack trace).
- isGlobalLogDocumentErrors
```
public boolean isGlobalLogDocumentErrors()
```
  Logs errors and exceptions reported by the processors in the global log (without stack trace).
- withGlobalLogDocumentErrors
```
public AnalysisPipeline withGlobalLogDocumentErrors(boolean globalLogDocumentErrors)
```
- withGlobalLogDocumentErrors
```
public AnalysisPipeline withGlobalLogDocumentErrors(java.lang.Boolean globalLogDocumentErrors)
```
- setAutoBlacklistDocuments
```
public void setAutoBlacklistDocuments(boolean autoBlacklistDocuments)
```
  Tries to add to a block list the documents triggering serious failure automatically.
  This option helps preventing loop failures, that is to say, when documents always trigger the same analysis process failures.
- isAutoBlacklistDocuments
```
public boolean isAutoBlacklistDocuments()
```
  Tries to add to a block list the documents triggering serious failure automatically.
  This option helps preventing loop failures, that is to say, when documents always trigger the same analysis process failures.
- withAutoBlacklistDocuments
```
public AnalysisPipeline withAutoBlacklistDocuments(boolean autoBlacklistDocuments)
```
- withAutoBlacklistDocuments
```
public AnalysisPipeline withAutoBlacklistDocuments(java.lang.Boolean autoBlacklistDocuments)
```
- setTokenizationConfig
```
public void setTokenizationConfig(java.lang.String tokenizationConfig)
```
  Reference to the TokenizationConfig object to use for tokenization during Semantic Processing Stage.
- getTokenizationConfig
```
public java.lang.String getTokenizationConfig()
```
  Reference to the TokenizationConfig object to use for tokenization during Semantic Processing Stage.
- withTokenizationConfig
```
public AnalysisPipeline withTokenizationConfig(java.lang.String tokenizationConfig)
```
- setAutoconfigureFromDataModel
```
public void setAutoconfigureFromDataModel(boolean autoconfigureFromDataModel)
```
- isAutoconfigureFromDataModel
```
public boolean isAutoconfigureFromDataModel()
```
- withAutoconfigureFromDataModel
```
public AnalysisPipeline withAutoconfigureFromDataModel(boolean autoconfigureFromDataModel)
```
- withAutoconfigureFromDataModel
```
public AnalysisPipeline withAutoconfigureFromDataModel(java.lang.Boolean autoconfigureFromDataModel)
```
- setDocumentProcessorsProfiling
```
public void setDocumentProcessorsProfiling(boolean documentProcessorsProfiling)
```
  Logs the CPU time spent for each document processor and for the main indexing phase.
  The total time spent for each processor is dumped in the analyzer log at the end of the job.
- isDocumentProcessorsProfiling
```
public boolean isDocumentProcessorsProfiling()
```
  Logs the CPU time spent for each document processor and for the main indexing phase.
  The total time spent for each processor is dumped in the analyzer log at the end of the job.
- withDocumentProcessorsProfiling
```
public AnalysisPipeline withDocumentProcessorsProfiling(boolean documentProcessorsProfiling)
```
- withDocumentProcessorsProfiling
```
public AnalysisPipeline withDocumentProcessorsProfiling(java.lang.Boolean documentProcessorsProfiling)
```
- setSemanticPipeTimeout
```
public void setSemanticPipeTimeout(int semanticPipeTimeout)
```
  CPU-time limit for the processing of a text chunk by the semantic pipe, in seconds.
- getSemanticPipeTimeout
```
public int getSemanticPipeTimeout()
```
  CPU-time limit for the processing of a text chunk by the semantic pipe, in seconds.
- withSemanticPipeTimeout
```
public AnalysisPipeline withSemanticPipeTimeout(int semanticPipeTimeout)
```
- withSemanticPipeTimeout
```
public AnalysisPipeline withSemanticPipeTimeout(java.lang.Integer semanticPipeTimeout)
```
- setSlowDocumentWarningTimeUS
```
public void setSlowDocumentWarningTimeUS(long slowDocumentWarningTimeUS)
```
  If the processing of a document is longer than this time, a message will be printed in the analyzer log.
  A value of 0 disables the warning feature.
- getSlowDocumentWarningTimeUS
```
public long getSlowDocumentWarningTimeUS()
```
  If the processing of a document is longer than this time, a message will be printed in the analyzer log.
  A value of 0 disables the warning feature.
- withSlowDocumentWarningTimeUS
```
public AnalysisPipeline withSlowDocumentWarningTimeUS(long slowDocumentWarningTimeUS)
```
- withSlowDocumentWarningTimeUS
```
public AnalysisPipeline withSlowDocumentWarningTimeUS(java.lang.Long slowDocumentWarningTimeUS)
```
- setSemanticProcessorsProfiling
```
public void setSemanticProcessorsProfiling(boolean semanticProcessorsProfiling)
```
  Logs the CPU time spent for each semantic processor.
  The total time spent for each processor is dumped in the analyzer log at the end of the job.
  Warning: This feature strongly impacts performance, only enable it if required.
- isSemanticProcessorsProfiling
```
public boolean isSemanticProcessorsProfiling()
```
  Logs the CPU time spent for each semantic processor.
  The total time spent for each processor is dumped in the analyzer log at the end of the job.
  Warning: This feature strongly impacts performance, only enable it if required.
- withSemanticProcessorsProfiling
```
public AnalysisPipeline withSemanticProcessorsProfiling(boolean semanticProcessorsProfiling)
```
- withSemanticProcessorsProfiling
```
public AnalysisPipeline withSemanticProcessorsProfiling(java.lang.Boolean semanticProcessorsProfiling)
```
- makeCopy
```
public AnalysisPipeline makeCopy()
```
  Creates and returns a deep copy of this AnalysisPipeline.
- readFrom
```
public static AnalysisPipeline readFrom(java.io.InputStream is)
                                 throws javax.xml.bind.JAXBException
```
  Read this AnalysisPipeline from an XML fragment.
  
  Throws:
  
  javax.xml.bind.JAXBException
- writeTo
```
public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException
```
  Write this AnalysisPipeline as an XML fragment
  
  Throws:
  
  javax.xml.bind.JAXBException
  
  java.io.IOException
- fromString
```
public static AnalysisPipeline fromString(java.lang.String s)
                                   throws javax.xml.bind.JAXBException,
                                          java.io.UnsupportedEncodingException
```
  String representation of this AnalysisPipeline.
  
  Throws:
  
  javax.xml.bind.JAXBException
  
  java.io.UnsupportedEncodingException
- toString
```
public java.lang.String toString()
```
  String representation of this AnalysisPipeline.
  
  Overrides:
  
  toString in class java.lang.Object
- check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
  Checks this AnalysisPipeline.
  
  Specified by:
  
  check in interface com.exalead.util.Checkable
  
  Throws:
  
  com.exalead.util.TypedException

Class AnalysisPipeline

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

documentProcessor

semanticProcessor

acceptCondition

mappingConfiguration

filteringConfiguration

languageConfiguration

name

errorAction

DEFAULT_ERROR_ACTION

reportDocumentErrors

DEFAULT_REPORT_DOCUMENT_ERRORS

globalLogDocumentErrors

DEFAULT_GLOBAL_LOG_DOCUMENT_ERRORS

autoBlacklistDocuments

DEFAULT_AUTO_BLACKLIST_DOCUMENTS

tokenizationConfig

autoconfigureFromDataModel

DEFAULT_AUTOCONFIGURE_FROM_DATA_MODEL

documentProcessorsProfiling

DEFAULT_DOCUMENT_PROCESSORS_PROFILING

semanticPipeTimeout

DEFAULT_SEMANTIC_PIPE_TIMEOUT

slowDocumentWarningTimeUS

DEFAULT_SLOW_DOCUMENT_WARNING_TIME_U_S

semanticProcessorsProfiling

DEFAULT_SEMANTIC_PROCESSORS_PROFILING

Constructor Detail

AnalysisPipeline

AnalysisPipeline

Method Detail

getDocumentProcessor

getDocumentProcessorByName

getDocumentProcessorAsMap

removeDocumentProcessorByName

withDocumentProcessor

withDocumentProcessor

getSemanticProcessor

getSemanticProcessorByName

getSemanticProcessorAsMap

removeSemanticProcessorByName

withSemanticProcessor

withSemanticProcessor

setAcceptCondition

getAcceptCondition

withAcceptCondition

setMappingConfiguration

getMappingConfiguration

withMappingConfiguration

setFilteringConfiguration

getFilteringConfiguration

withFilteringConfiguration

getLanguageConfiguration

getLanguageConfigurationByLanguage

getLanguageConfigurationAsMap

removeLanguageConfigurationByLanguage

withLanguageConfiguration

withLanguageConfiguration

setName

getName

withName

setErrorAction

getErrorAction

withErrorAction

setReportDocumentErrors

isReportDocumentErrors

withReportDocumentErrors

withReportDocumentErrors

setGlobalLogDocumentErrors

isGlobalLogDocumentErrors

withGlobalLogDocumentErrors

withGlobalLogDocumentErrors

setAutoBlacklistDocuments

isAutoBlacklistDocuments

withAutoBlacklistDocuments