org.grobid.core.engines

Class ProcessEngine

java.lang.Object

org.grobid.core.engines.ProcessEngine

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class ProcessEngine
extends java.lang.Object
implements java.io.Closeable

Perform the batch processing for the different engine methods.

Constructor Summary

Constructors

Constructor and Description
ProcessEngine()

Method Summary

Modifier and Type	Method and Description
void	close() Close engine resources.
void	createTraining(GrobidMainArgs pGbdArgs) Generate training data for all models
void	createTrainingBlank(GrobidMainArgs pGbdArgs) Generate blank training data from provided directory of PDF documents, i.e.
void	createTrainingCitationPatent(GrobidMainArgs pGbdArgs) Generate training data for citation extraction from patent documents.
void	createTrainingMonograph(GrobidMainArgs pGbdArgs) Generate training data for the monograph model from provided directory of PDF documents.
protected Engine	getEngine()
static java.util.List<java.lang.String>	getUsableMethods() List the engine methods that can be called.
protected static void	inferOutputPath(GrobidMainArgs pGbdArgs) Infer the output path if not given in arguments.
protected static void	inferPdfInputPath(GrobidMainArgs pGbdArgs) Infer the input path for pdfs if not given in arguments.
protected static boolean	isUsableMethod(java.lang.String pMethod) Check if the method is usable.
void	processAffiliation(GrobidMainArgs pGbdArgs) Process the affiliation using pGbdArgs parameters.
void	processAuthorsCitation(GrobidMainArgs pGbdArgs) Process the author citation using pGbdArgs parameters.
void	processAuthorsHeader(GrobidMainArgs pGbdArgs) Process the author header using pGbdArgs parameters.
void	processCitationPatentPDF(GrobidMainArgs pGbdArgs) Process a patent available in PDF using pGbdArgs parameters.
void	processCitationPatentST36(GrobidMainArgs pGbdArgs) Process a patent encoded in ST.36 using pGbdArgs parameters.
void	processCitationPatentTXT(GrobidMainArgs pGbdArgs) Process a patent in utf-8 text using pGbdArgs parameters.
void	processDate(GrobidMainArgs pGbdArgs) Process the date using pGbdArgs parameters.
void	processFullText(GrobidMainArgs pGbdArgs) Process the full text using pGbdArgs parameters.
void	processHeader(GrobidMainArgs pGbdArgs) Process the headers using pGbdArgs parameters.
void	processPDFAnnotation(GrobidMainArgs pGbdArgs) Process a patent available in PDF using pGbdArgs parameters.
void	processRawReference(GrobidMainArgs pGbdArgs) Process the raw reference using pGbdArgs parameters.
void	processReferences(GrobidMainArgs pGbdArgs) Process all the references using pGbdArgs parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessEngine

public ProcessEngine()

Method Detail

getEngine

protected Engine getEngine()

Returns:

the engine instance.

close

public void close()
           throws java.io.IOException

Close engine resources.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

processHeader

public void processHeader(GrobidMainArgs pGbdArgs)
                   throws java.lang.Exception

Process the headers using pGbdArgs parameters.

Parameters:

pGbdArgs - The parameters.

Throws:

java.lang.Exception

processFullText

public void processFullText(GrobidMainArgs pGbdArgs)
                     throws java.lang.Exception

Process the full text using pGbdArgs parameters.

Parameters:

pGbdArgs - The parameters.

Throws:

java.lang.Exception

processDate

public void processDate(GrobidMainArgs pGbdArgs)
                 throws java.lang.Exception

Process the date using pGbdArgs parameters.

Parameters:

pGbdArgs - The parameters.

Throws:

java.lang.Exception

processAuthorsHeader

public void processAuthorsHeader(GrobidMainArgs pGbdArgs)
                          throws java.lang.Exception

Process the author header using pGbdArgs parameters.

Parameters:

pGbdArgs - The parameters.

Throws:

java.lang.Exception

processAuthorsCitation

public void processAuthorsCitation(GrobidMainArgs pGbdArgs)
                            throws java.lang.Exception

Process the author citation using pGbdArgs parameters.

Parameters:

pGbdArgs - The parameters

Throws:

java.lang.Exception

processAffiliation

public void processAffiliation(GrobidMainArgs pGbdArgs)
                        throws java.lang.Exception

Process the affiliation using pGbdArgs parameters.

Parameters:

pGbdArgs - The parameters.

Throws:

java.lang.Exception

processRawReference

public void processRawReference(GrobidMainArgs pGbdArgs)
                         throws java.lang.Exception

Process the raw reference using pGbdArgs parameters.

Parameters:

pGbdArgs - The parameters.

Throws:

java.lang.Exception

processReferences

public void processReferences(GrobidMainArgs pGbdArgs)
                       throws java.lang.Exception

Process all the references using pGbdArgs parameters.

Parameters:

pGbdArgs - The parameters.

Throws:

java.lang.Exception

createTraining

public void createTraining(GrobidMainArgs pGbdArgs)

Generate training data for all models

Parameters:

pGbdArgs - The parameters.

createTrainingMonograph

public void createTrainingMonograph(GrobidMainArgs pGbdArgs)
                             throws java.lang.Exception

Generate training data for the monograph model from provided directory of PDF documents.

Parameters:

pGbdArgs - The parameters.

Throws:

java.lang.Exception

createTrainingBlank

public void createTrainingBlank(GrobidMainArgs pGbdArgs)
                         throws java.lang.Exception

Generate blank training data from provided directory of PDF documents, i.e. where TEI files are text only without tags. This can be used to start from scratch any new model.

Parameters:

pGbdArgs - The parameters.

Throws:

java.lang.Exception

createTrainingCitationPatent

public void createTrainingCitationPatent(GrobidMainArgs pGbdArgs)
                                  throws java.lang.Exception

Generate training data for citation extraction from patent documents.

Parameters:

pGbdArgs - The parameters.

Throws:

java.lang.Exception

processCitationPatentST36

public void processCitationPatentST36(GrobidMainArgs pGbdArgs)
                               throws java.lang.Exception

Process a patent encoded in ST.36 using pGbdArgs parameters.

Parameters:

pGbdArgs - The parameters.

Throws:

java.lang.Exception

processCitationPatentTXT

public void processCitationPatentTXT(GrobidMainArgs pGbdArgs)
                              throws java.lang.Exception

Process a patent in utf-8 text using pGbdArgs parameters.

Parameters:

pGbdArgs - The parameters.

Throws:

java.lang.Exception

processCitationPatentPDF

public void processCitationPatentPDF(GrobidMainArgs pGbdArgs)
                              throws java.lang.Exception

Process a patent available in PDF using pGbdArgs parameters.

Parameters:

pGbdArgs - The parameters.

Throws:

java.lang.Exception

processPDFAnnotation

public void processPDFAnnotation(GrobidMainArgs pGbdArgs)
                          throws java.lang.Exception

Process a patent available in PDF using pGbdArgs parameters.

Parameters:

pGbdArgs - The parameters.

Throws:

java.lang.Exception

getUsableMethods

public static final java.util.List<java.lang.String> getUsableMethods()

List the engine methods that can be called.

Returns:

List containing the list of the methods.

isUsableMethod

protected static final boolean isUsableMethod(java.lang.String pMethod)

Check if the method is usable.

Parameters:

pMethod - method name.

Returns:

if it is usable

inferPdfInputPath

protected static final void inferPdfInputPath(GrobidMainArgs pGbdArgs)

Infer the input path for pdfs if not given in arguments.

Parameters:

pGbdArgs - The GrobidArgs.

inferOutputPath

protected static final void inferOutputPath(GrobidMainArgs pGbdArgs)

Infer the output path if not given in arguments.

Parameters:

pGbdArgs - The GrobidArgs.