org.grobid.core.document

Class TEIFormatter

java.lang.Object

org.grobid.core.document.TEIFormatter

public class TEIFormatter
extends java.lang.Object

Class for generating a TEI representation of a document.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TEIFormatter.SchemaDeclaration

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Set<TaggingLabel>	MARKER_LABELS

Constructor Summary

Constructors

Constructor and Description
TEIFormatter(Document document, FullTextParser fullTextParser)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getCoordsAttribute(java.util.List<BoundingBox> boundingBoxes, boolean generateCoordinates)
java.util.List<Node>	markReferencesEquationTEI(java.lang.String text, java.util.List<LayoutToken> refTokens, java.util.List<Equation> equations, boolean generateCoordinates)
java.util.List<Node>	markReferencesFigureTEI(java.lang.String text, java.util.List<LayoutToken> refTokens, java.util.List<Figure> figures, boolean generateCoordinates)
java.util.List<Node>	markReferencesTableTEI(java.lang.String text, java.util.List<LayoutToken> refTokens, java.util.List<Table> tables, boolean generateCoordinates)
java.util.List<Node>	markReferencesTEILuceneBased(java.util.List<LayoutToken> refTokens, ReferenceMarkerMatcher markerMatcher, boolean generateCoordinates, boolean keepUnsolvedCallout) Mark using TEI annotations the identified references in the text body build with the machine learning model.
java.lang.StringBuilder	toTEIAcknowledgement(java.lang.StringBuilder buffer, java.lang.String reseAcknowledgement, java.util.List<LayoutToken> tokenizationsAcknowledgement, java.util.List<BibDataSet> bds, GrobidAnalysisConfig config)
java.lang.StringBuilder	toTEIAnnex(java.lang.StringBuilder buffer, java.lang.String result, BiblioItem biblio, java.util.List<BibDataSet> bds, java.util.List<LayoutToken> tokenizations, Document doc, GrobidAnalysisConfig config)
java.lang.StringBuilder	toTEIBody(java.lang.StringBuilder buffer, java.lang.String result, BiblioItem biblio, java.util.List<BibDataSet> bds, LayoutTokenization layoutTokenization, java.util.List<Figure> figures, java.util.List<Table> tables, java.util.List<Equation> equations, Document doc, GrobidAnalysisConfig config) TEI formatting of the body where only basic logical document structures are present.
java.lang.StringBuilder	toTEIHeader(BiblioItem biblio, java.lang.String defaultPublicationStatement, java.util.List<BibDataSet> bds, GrobidAnalysisConfig config)
java.lang.StringBuilder	toTEIHeader(BiblioItem biblio, TEIFormatter.SchemaDeclaration schemaDeclaration, java.lang.String defaultPublicationStatement, java.util.List<BibDataSet> bds, GrobidAnalysisConfig config)
java.lang.StringBuilder	toTEIReferences(java.lang.StringBuilder tei, java.util.List<BibDataSet> bds, GrobidAnalysisConfig config)

Methods inherited from class java.lang.Object

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

Field Detail

MARKER_LABELS

public static final java.util.Set<TaggingLabel> MARKER_LABELS

Constructor Detail

TEIFormatter

public TEIFormatter(Document document,
                    FullTextParser fullTextParser)

Method Detail

toTEIHeader

public java.lang.StringBuilder toTEIHeader(BiblioItem biblio,
                                           java.lang.String defaultPublicationStatement,
                                           java.util.List<BibDataSet> bds,
                                           GrobidAnalysisConfig config)

toTEIHeader

public java.lang.StringBuilder toTEIHeader(BiblioItem biblio,
                                           TEIFormatter.SchemaDeclaration schemaDeclaration,
                                           java.lang.String defaultPublicationStatement,
                                           java.util.List<BibDataSet> bds,
                                           GrobidAnalysisConfig config)

toTEIBody

public java.lang.StringBuilder toTEIBody(java.lang.StringBuilder buffer,
                                         java.lang.String result,
                                         BiblioItem biblio,
                                         java.util.List<BibDataSet> bds,
                                         LayoutTokenization layoutTokenization,
                                         java.util.List<Figure> figures,
                                         java.util.List<Table> tables,
                                         java.util.List<Equation> equations,
                                         Document doc,
                                         GrobidAnalysisConfig config)
                                  throws java.lang.Exception

TEI formatting of the body where only basic logical document structures are present. This TEI format avoids most of the risks of ill-formed TEI due to structure recognition errors and frequent PDF noises. It is adapted to fully automatic process and simple exploitation of the document structures like structured indexing and search.

Throws:

java.lang.Exception

toTEIAcknowledgement

public java.lang.StringBuilder toTEIAcknowledgement(java.lang.StringBuilder buffer,
                                                    java.lang.String reseAcknowledgement,
                                                    java.util.List<LayoutToken> tokenizationsAcknowledgement,
                                                    java.util.List<BibDataSet> bds,
                                                    GrobidAnalysisConfig config)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

toTEIAnnex

public java.lang.StringBuilder toTEIAnnex(java.lang.StringBuilder buffer,
                                          java.lang.String result,
                                          BiblioItem biblio,
                                          java.util.List<BibDataSet> bds,
                                          java.util.List<LayoutToken> tokenizations,
                                          Document doc,
                                          GrobidAnalysisConfig config)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

toTEIReferences

public java.lang.StringBuilder toTEIReferences(java.lang.StringBuilder tei,
                                               java.util.List<BibDataSet> bds,
                                               GrobidAnalysisConfig config)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getCoordsAttribute

public static java.lang.String getCoordsAttribute(java.util.List<BoundingBox> boundingBoxes,
                                                  boolean generateCoordinates)

markReferencesTEILuceneBased

public java.util.List<Node> markReferencesTEILuceneBased(java.util.List<LayoutToken> refTokens,
                                                         ReferenceMarkerMatcher markerMatcher,
                                                         boolean generateCoordinates,
                                                         boolean keepUnsolvedCallout)
                                                  throws EntityMatcherException

Mark using TEI annotations the identified references in the text body build with the machine learning model.

Throws:

EntityMatcherException

markReferencesFigureTEI

public java.util.List<Node> markReferencesFigureTEI(java.lang.String text,
                                                    java.util.List<LayoutToken> refTokens,
                                                    java.util.List<Figure> figures,
                                                    boolean generateCoordinates)

markReferencesTableTEI

public java.util.List<Node> markReferencesTableTEI(java.lang.String text,
                                                   java.util.List<LayoutToken> refTokens,
                                                   java.util.List<Table> tables,
                                                   boolean generateCoordinates)

markReferencesEquationTEI

public java.util.List<Node> markReferencesEquationTEI(java.lang.String text,
                                                      java.util.List<LayoutToken> refTokens,
                                                      java.util.List<Equation> equations,
                                                      boolean generateCoordinates)