Package org.apache.tika.parser.pages

Class PagesConfig

java.lang.Object

org.apache.tika.parser.pages.PagesConfig

All Implemented Interfaces:

Serializable

public class PagesConfig
extends Object
implements Serializable

What a parser does with a document's pages when the document has to be rendered to get pixels: how it renders (render), where a page's text comes from (text), the recognizer budget and verdict (ocr), what is released to inference bindings (inference), and whether renders are emitted as embedded documents (emit). One block for every rendering parser; the PDF parser and the EMF/WMF parsers read it.

Every field is nullable so an instance can be an overlay, and the same class is read at four layers, later ones winning per field: the config's "parse-context": {"pages": ...}, a request's "pages" (which replaces the config's, as every parse-context key does), a parser's own "pages" under "parsers", and that parser's "pages" in the request. resolve(org.apache.tika.parser.ParseContext, org.apache.tika.parser.pages.PagesConfig...) folds them onto defaults().

Since:

Apache Tika 4.1

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PagesConfig.Auto	When TextPolicy.AUTO sends a page to OCR: too few characters, or too many glyphs without a Unicode mapping.
static class	PagesConfig.Emit	Whether, and for which documents, renders are emitted as RENDERING embedded documents.
static class	PagesConfig.Ocr	The recognizer side of text: how many pages may be OCR'd, how AUTO decides.
static final record	PagesConfig.OperatorPages	The operator's top-level "pages" (config plus preset; null when neither sets one), which a request's own block replaces.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY

Constructor Summary

Constructors

Constructor	Description
PagesConfig()

Method Summary

Modifier and Type	Method	Description
static PagesConfig	defaults()	Every field set: default render, AUTO, no OCR budget, TEXT released, nothing emitted.
PagesConfig.Emit	emit()	The emit overlay, created if unset: pages.emit().setEnabled(true).
boolean	emitsSameImage()	Whether emitted renders are the same image as the render OCR and inference see.
RenderSettings	emittedRender()	The settings emitted renders use: render with emit.render applied.
PagesConfig.Emit	getEmit()
List<InputKind>	getInference()
PagesConfig.Ocr	getOcr()
RenderSettings	getRender()
TextPolicy	getText()
PagesConfig.Ocr	ocr()	The OCR overlay, created if unset.
PagesConfig	over(PagesConfig overlay)	A copy of this with every set field of overlay applied; null overlay is this.
RenderSettings	render()	The render overlay, created if unset: pages.render().setDpi(96).
static PagesConfig	resolve(ParseContext context, String componentName, PagesConfig operatorOverlay, PagesConfig localOverlay)	The effective block for a rendering parser: as resolve(ParseContext, PagesConfig...) with the parser's operatorOverlay and its per-parse localOverlay.
static PagesConfig	resolve(ParseContext context, PagesConfig... overlays)	The effective block for a parse: defaults(), the context's "pages" (JSON, or a PagesConfig set on the context by class), then each overlay in order.
void	setEmit(PagesConfig.Emit emit)
void	setInference(List<InputKind> inference)	TEXT, PAGES, or both; what the parser releases to inference bindings.
void	setOcr(PagesConfig.Ocr ocr)
void	setRender(RenderSettings render)
void	setText(TextPolicy text)

Methods inherited from class java.lang.Object

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

Field Details

KEY

public static final String KEY

See Also:

• Constant Field Values

Constructor Details

PagesConfig

public PagesConfig()

Method Details

defaults

public static PagesConfig defaults()

Every field set: default render, AUTO, no OCR budget, TEXT released, nothing emitted.

resolve

public static PagesConfig resolve(ParseContext context,
 PagesConfig... overlays)
                           throws TikaConfigException,
IOException

The effective block for a parse: defaults(), the context's "pages" (JSON, or a PagesConfig set on the context by class), then each overlay in order.

Throws:

TikaConfigException

IOException

resolve

public static PagesConfig resolve(ParseContext context,
 String componentName,
 PagesConfig operatorOverlay,
 PagesConfig localOverlay)
                           throws TikaConfigException,
IOException

The effective block for a rendering parser: as resolve(ParseContext, PagesConfig...) with the parser's operatorOverlay and its per-parse localOverlay. In the pipes worker (where PagesConfig.OperatorPages is set), when the context's "pages" or the parser's componentName config is untrusted request JSON, the render limits (RenderSettings.tightenedTo(org.apache.tika.renderer.RenderSettings)) may tighten the operator's but not loosen them.

Throws:

TikaConfigException

IOException

Since:

Apache Tika 4.2

over

public PagesConfig over(PagesConfig overlay)

A copy of this with every set field of overlay applied; null overlay is this.

emittedRender

public RenderSettings emittedRender()

The settings emitted renders use: render with emit.render applied.

emitsSameImage

public boolean emitsSameImage()

Whether emitted renders are the same image as the render OCR and inference see.

getRender

public RenderSettings getRender()

setRender

public void setRender(RenderSettings render)

render

public RenderSettings render()

The render overlay, created if unset: pages.render().setDpi(96).

getText

public TextPolicy getText()

setText

public void setText(TextPolicy text)

getOcr

public PagesConfig.Ocr getOcr()

setOcr

public void setOcr(PagesConfig.Ocr ocr)

ocr

public PagesConfig.Ocr ocr()

The OCR overlay, created if unset.

getInference

public List<InputKind> getInference()

setInference

public void setInference(List<InputKind> inference)

TEXT, PAGES, or both; what the parser releases to inference bindings.

getEmit

public PagesConfig.Emit getEmit()

setEmit

public void setEmit(PagesConfig.Emit emit)

emit

public PagesConfig.Emit emit()

The emit overlay, created if unset: pages.emit().setEnabled(true).