com.exalead.mot.core

Class MOTPipe

java.lang.Object

com.exalead.gni.GNIObject

com.exalead.mot.core.MOTPipeInterface

com.exalead.mot.core.MOTPipe

public class MOTPipe
extends MOTPipeInterface

Exalead's Natural Language Processing pipeline. A MOTPipe is composed by 1 Converter and N Processors referencing Resources

Field Summary

Fields

Modifier and Type	Field and Description
Converter	Converter The converter
boolean	enableReference If true, some processors add the annotation sources
java.util.List<Processor>	Processor The list of processors
java.util.List<Resource>	Resource The list of resources

Fields inherited from class com.exalead.mot.core.MOTPipeInterface

InvalidTID

Constructor Summary

Constructors

Constructor and Description
MOTPipe(Converter converter, Resource[] resources, Processor[] processors) Build a MOTPipe.
MOTPipe(Converter converter, Resource[] resources, Processor[] processors, boolean enableReference) Build a MOTPipe.

Method Summary

Modifier and Type	Method and Description
static void	checkLicense(Converter converter, java.util.List<Processor> processors)
static void	destroyProcessorHelper(Processor p)
protected void	finalize()
Processor	getProcessor(java.lang.String name) Get a processor according to its name.
boolean	hasResourceGroupDependancy(java.lang.String groupName)
void	init() Initialize a MOTPipe.
void	init(Referential referential) Initialize a MOTPipe with a non-empty referential (JavaCustomTokenizer/SemanticProcessor) This gets the pipe ready for receiving binary tokens as input.
void	init(TokenFactory factory) Initialize a MOTPipe using an allocated TokenFactory.
void	init(TokenFactory factory, Referential referential) Initialize a MOTPipe using an allocated TokenFactory and Referential (JavaCustomTokenizer/SemanticProcessor)
void	release(boolean finalizeElements) Release the resources referenced by the pipe.

Methods inherited from class com.exalead.mot.core.MOTPipeInterface

disableAllProcessors, disableProcessor, displayProfilingStats, displayProfilingStats, displayXML, enableProcessor, enableProfiling, endDocument, feed, getDocumentAnnotations, getNextAnnotation, getNextTokens, getReferential, getTag, getTID, getTIDs, newDocument, newDocument, newDocument, newField, process, process, process, processAllTokens, processBytes, processBytes, processBytes, processFeed, processFeed, processFeed, release, setTimeout

Methods inherited from class com.exalead.gni.GNIObject

printInternalCppPointer

Methods inherited from class java.lang.Object

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

Field Detail

Converter

public Converter Converter

The converter

Resource

public java.util.List<Resource> Resource

The list of resources

Processor

public java.util.List<Processor> Processor

The list of processors

enableReference

public boolean enableReference

If true, some processors add the annotation sources

Constructor Detail

MOTPipe

public MOTPipe(Converter converter,
               Resource[] resources,
               Processor[] processors)

Build a MOTPipe.

Parameters:

converter - The tokenizer.

resources - The list of resources.

processors - The list of processors.

MOTPipe

public MOTPipe(Converter converter,
               Resource[] resources,
               Processor[] processors,
               boolean enableReference)

Build a MOTPipe.

Parameters:

converter - The tokenizer.

resources - The list of resources.

processors - The list of processors.

enableReference - If true, some processors will add references to their annotations.

Method Detail

init

public void init()
          throws ResourceNotFoundException,
                 ResourceAllocationFailedException

Initialize a MOTPipe.

Throws:

ResourceAllocationFailedException

ResourceNotFoundException

init

public void init(Referential referential)
          throws java.lang.Exception

Initialize a MOTPipe with a non-empty referential (JavaCustomTokenizer/SemanticProcessor) This gets the pipe ready for receiving binary tokens as input.

Throws:

java.lang.Exception

init

public void init(TokenFactory factory)
          throws ResourceNotFoundException,
                 ResourceAllocationFailedException

Initialize a MOTPipe using an allocated TokenFactory.

Parameters:

factory - The pre-allocated TokenFactory.

Throws:

ResourceAllocationFailedException

ResourceNotFoundException

init

public void init(TokenFactory factory,
                 Referential referential)
          throws ResourceNotFoundException,
                 ResourceAllocationFailedException

Initialize a MOTPipe using an allocated TokenFactory and Referential (JavaCustomTokenizer/SemanticProcessor)

Parameters:

factory - The pre-allocated TokenFactory.

referential - A non-empty referential making the pipe ready for receiving binary tokens as input (may be null)

Throws:

ResourceAllocationFailedException

ResourceNotFoundException

checkLicense

public static final void checkLicense(Converter converter,
                                      java.util.List<Processor> processors)

release

public void release(boolean finalizeElements)

Description copied from class: MOTPipeInterface

Release the resources referenced by the pipe. The pipe cannot be used anymore afterwards.

Specified by:

release in class MOTPipeInterface

Parameters:

finalizeElements - If true, the processors, converters, and the pipe itself are finalized.

getProcessor

public Processor getProcessor(java.lang.String name)

Get a processor according to its name.

Parameters:

name - The name of the processor to retrieve.

Returns:

The processor, null if not found.

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

hasResourceGroupDependancy

public boolean hasResourceGroupDependancy(java.lang.String groupName)

Specified by:

hasResourceGroupDependancy in class MOTPipeInterface

destroyProcessorHelper

public static void destroyProcessorHelper(Processor p)