com.exalead.mot.core

Class MOTPipeInterface

java.lang.Object

com.exalead.gni.GNIObject

com.exalead.mot.core.MOTPipeInterface

Direct Known Subclasses:

MOTPipe

public abstract class MOTPipeInterface
extends com.exalead.gni.GNIObject

Field Summary

Fields

Modifier and Type	Field and Description
static int	InvalidTID Value of an invalid TID.

Constructor Summary

Constructors

Constructor and Description
MOTPipeInterface()

Method Summary

Modifier and Type	Method and Description
void	disableAllProcessors() Deprecated.
boolean	disableProcessor(java.lang.String processorName) Disable a processor.
void	displayProfilingStats()
void	displayProfilingStats(java.lang.String title)
void	displayXML() Pretty print the pipe in XML
boolean	enableProcessor(java.lang.String processorName) Enable a disabled processor.
void	enableProfiling()
void	endDocument() Tell the pipe we have finished the current document processing.
void	feed(java.lang.String data, int lang) Feed the pipe with data.
Annotation[]	getDocumentAnnotations() Get annotations attached to the document.
AnnotatedToken[]	getNextAnnotation(java.lang.String annotationKind) "Fast forward" to the next token with an annotation of kind annotationKind.
AnnotatedToken[]	getNextTokens(int howMany) After a call to feed(), retrieve the n next produced tokens (at most).
Referential	getReferential() Retrieve a reference to the referential in use (JavaCustomTokenizer/SemanticProcessor)
java.lang.String	getTag(int tid) Get a tag from a TID.
int	getTID(java.lang.String tag) Get the TID associated to a tag.
int[]	getTIDs(java.lang.String prefix) Get a list of TIDs according to a prefix.
abstract boolean	hasResourceGroupDependancy(java.lang.String groupName)
void	newDocument() Tell the pipe we are going to process a new document.
void	newDocument(java.lang.String uri) Tell the pipe we are going to process a new document.
void	newDocument(java.lang.String uri, int lang) Tell the pipe we are going to process a new document.
void	newField(java.lang.String fieldName) Tell the pipe we are going to process a field.
AnnotatedToken[]	process(java.lang.String input, int lang) Process a chunk of text and return the annotated tokens.
AnnotatedToken[]	process(java.lang.String input, int lang, int[] tids) Process a chunk of text and return the annotated tokens.
AnnotatedToken[]	process(java.lang.String input, int lang, int[] tids, int timeoutMS) Process a chunk of text and return the annotated tokens.
void	processAllTokens() Process all tokens available in the input stream without caring about their annotations.
AnnotatedToken[]	processBytes(byte[] bytes, int lang) Process an array of bytes and returns the annotated tokens.
AnnotatedToken[]	processBytes(byte[] bytes, int lang, int[] tids) Process an array of bytes and returns the annotated tokens.
AnnotatedToken[]	processBytes(byte[] bytes, int lang, int[] tids, int timeoutMS) Process an array of bytes and returns the annotated tokens.
AnnotatedToken[]	processFeed() Process the previously feeded chunk and return the annotated token.
AnnotatedToken[]	processFeed(int[] tids) Process the previously feeded chunk and return the annotated token
AnnotatedToken[]	processFeed(int[] tids, int timeoutMS) Process the previously feeded chunk and return the annotated token.
void	release() Release the resources references by the pipe.
abstract void	release(boolean finalizeElements) Release the resources referenced by the pipe.
void	setTimeout(long seconds) Set a per-thread CPU-time limit for chunk processing

Methods inherited from class com.exalead.gni.GNIObject

printInternalCppPointer

Methods inherited from class java.lang.Object

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

Field Detail

InvalidTID

public static final int InvalidTID

Value of an invalid TID.

See Also:

Constant Field Values

Constructor Detail

MOTPipeInterface

public MOTPipeInterface()

Method Detail

release

public abstract void release(boolean finalizeElements)

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

Parameters:

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

release

public void release()

Release the resources references by the pipe.

getTID

public int getTID(java.lang.String tag)

Get the TID associated to a tag.

Parameters:

tag - The tag.

Returns:

The TID if the tag exist, else InvalidTID.

getTIDs

public int[] getTIDs(java.lang.String prefix)

Get a list of TIDs according to a prefix.

Parameters:

prefix - The tags prefix.

Returns:

An array of TID.

getTag

public java.lang.String getTag(int tid)

Get a tag from a TID.

Parameters:

tid - The tid.

Returns:

The tag if it exists, else null.

getReferential

public Referential getReferential()

Retrieve a reference to the referential in use (JavaCustomTokenizer/SemanticProcessor)

setTimeout

public void setTimeout(long seconds)

Set a per-thread CPU-time limit for chunk processing

Parameters:

seconds - CPU-time limit for processing a single feed, in seconds

process

public AnnotatedToken[] process(java.lang.String input,
                                int lang,
                                int[] tids,
                                int timeoutMS)

Process a chunk of text and return the annotated tokens.

Parameters:

input - The chunk of text.

lang - The language to use.

tids - If not null, only the annotations having a TID present in this array will be retrieved.

timeoutMS - If greater than 0, the timeout.

Returns:

The annotated tokens.

process

public AnnotatedToken[] process(java.lang.String input,
                                int lang,
                                int[] tids)

Process a chunk of text and return the annotated tokens.

Parameters:

input - The chunk of text.

lang - The language to use.

tids - If not null, only the annotations having a TID present in this array will be retrieved.

Returns:

The annotated tokens.

process

public AnnotatedToken[] process(java.lang.String input,
                                int lang)

Process a chunk of text and return the annotated tokens.

Parameters:

input - The chunk of text.

lang - The language to use.

Returns:

The annotated tokens.

processBytes

public AnnotatedToken[] processBytes(byte[] bytes,
                                     int lang,
                                     int[] tids,
                                     int timeoutMS)

Process an array of bytes and returns the annotated tokens.

Parameters:

bytes - The bytes array.

lang - The language to use.

tids - If not null, only the annotations having a TID present in this array will be retrieved.

timeoutMS - If greater than 0, the timeout.

Returns:

The annotated tokens.

processBytes

public AnnotatedToken[] processBytes(byte[] bytes,
                                     int lang,
                                     int[] tids)

Process an array of bytes and returns the annotated tokens.

Parameters:

bytes - The bytes array.

lang - The language to use.

tids - if not null, only the annotations having a TID present in this array will be retrieved

Returns:

The annotated tokens.

processBytes

public AnnotatedToken[] processBytes(byte[] bytes,
                                     int lang)

Process an array of bytes and returns the annotated tokens.

Parameters:

bytes - The bytes array.

lang - The language to use.

Returns:

The annotated tokens.

feed

public void feed(java.lang.String data,
                 int lang)

Feed the pipe with data. To be used in conjunction with getNextAnnotation.

See Also:

getNextAnnotation(java.lang.String)

processFeed

public AnnotatedToken[] processFeed(int[] tids,
                                    int timeoutMS)

Process the previously feeded chunk and return the annotated token.

Parameters:

tids - If not null, only the annotations having a TID present in this array will be retrieved.

timeoutMS - If greater than 0, the timeout.

Returns:

The annotated tokens.

processFeed

public AnnotatedToken[] processFeed(int[] tids)

Process the previously feeded chunk and return the annotated token

Parameters:

tids - if not null, only the annotations having a TID present in this array will be retrieved

Returns:

The annotated tokens.

processFeed

public AnnotatedToken[] processFeed()

Process the previously feeded chunk and return the annotated token.

Returns:

The annotated tokens.

newDocument

public void newDocument(java.lang.String uri,
                        int lang)

Tell the pipe we are going to process a new document.

Parameters:

uri - The optional document URI.

lang - The optional document language.

newDocument

public void newDocument(java.lang.String uri)

Tell the pipe we are going to process a new document.

Parameters:

uri - The optional document URI.

newDocument

public void newDocument()

Tell the pipe we are going to process a new document.

endDocument

public void endDocument()

Tell the pipe we have finished the current document processing. Required to flush processors' buffers and to retrieve document annotations.

newField

public void newField(java.lang.String fieldName)

Tell the pipe we are going to process a field.

Parameters:

fieldName - The field name.

enableProcessor

public boolean enableProcessor(java.lang.String processorName)

Enable a disabled processor.

Parameters:

processorName - The processor name.

Returns:

True if the processor was found.

disableProcessor

public boolean disableProcessor(java.lang.String processorName)

Disable a processor.

Parameters:

processorName - The processor name.

Returns:

True if the processor was found.

disableAllProcessors

@Deprecated
public void disableAllProcessors()

Deprecated.

Disable all processors.

getNextAnnotation

public AnnotatedToken[] getNextAnnotation(java.lang.String annotationKind)

"Fast forward" to the next token with an annotation of kind annotationKind. This avoids instanciating all tokens from the stream.

Returns:

The longest sequence of tokens covered by the annotation (possibly empty if none is found).

getNextTokens

public AnnotatedToken[] getNextTokens(int howMany)

After a call to feed(), retrieve the n next produced tokens (at most).

processAllTokens

public void processAllTokens()

Process all tokens available in the input stream without caring about their annotations. This avoids instanciating all tokens from the stream.

getDocumentAnnotations

public Annotation[] getDocumentAnnotations()

Get annotations attached to the document.

Returns:

an array of annotation.

enableProfiling

public void enableProfiling()

displayProfilingStats

public void displayProfilingStats(java.lang.String title)

displayProfilingStats

public void displayProfilingStats()

displayXML

public void displayXML()

Pretty print the pipe in XML

hasResourceGroupDependancy

public abstract boolean hasResourceGroupDependancy(java.lang.String groupName)