Package org.apache.tika.parser.enricher

Class ContentEnrichers

java.lang.Object

org.apache.tika.parser.enricher.ContentEnrichers

public final class ContentEnrichers
extends Object

Resolves the content enricher for a media type.

Call sites: wrap the handler (an EmbeddedContentHandler over a BodyContentHandler) so the enricher cannot dump structure or metadata into the caller's XHTML; resolve on the detected type, captured before a parser can refine Content-Type mid-parse; pass the target's metadata, or a probe carrying its Content-Type and EMBEDDED_RESOURCE_TYPE when resolving ahead of a render; and pass the caller's own ParseContext through -- the recursion guard rides it, so a fresh context defeats it.

Since:

Apache Tika 4.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ContentEnrichers.Suspension	Scope of a suspend(org.apache.tika.parser.ParseContext) or suspendRecognizers(org.apache.tika.parser.ParseContext); closing restores the prior state.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MIN_PIXELS	Below this in either dimension an image is a spacer, not a picture: no engine sees it.

Method Summary

Modifier and Type	Method	Description
static TextRecognizer	asTextRecognizer(Parser parser)	The TextRecognizer under any decorators; null if the parser is not one.
static Parser	get(CompositeContentEnricher enrichers, MediaType mediaType, Metadata target, ParseContext context)	The enricher to invoke for a media type, or null.
static boolean	hasTextRecognizer(CompositeContentEnricher enrichers, MediaType mediaType, Metadata target, ParseContext context)	Whether the enricher get(org.apache.tika.parser.enricher.CompositeContentEnricher, org.apache.tika.mime.MediaType, org.apache.tika.metadata.Metadata, org.apache.tika.parser.ParseContext) would return produces the document's text: a TextRecognizer that recognizes for this context, or a legacy image/ocr-* claimant.
static boolean	isDisabled(ParseContext context)	Whether the request switched the list off: {"text-recognizers": {"enabled": false}}.
static boolean	isEnricher(Parser parser)	True if the parser, under any decorators, is a ContentEnricher.
static boolean	isLegacyOcrType(MediaType mediaType)	True for a retired image/ocr-* pseudo-type.
static CompositeContentEnricher	resolve(Parser root)	One enricher per type from the enrichers found in a parser tree: an engine outside DefaultParser beats one inside it, the last wins within a tier, and an entry's _mime-include/_mime-exclude applies at every node.
static MediaType	stripLegacyOcrPrefix(MediaType mediaType)	The real type behind a retired pseudo-type; any other type unchanged.
static ContentEnrichers.Suspension	suspend(ParseContext context)	Suspends dispatch in this context until the returned scope closes.
static ContentEnrichers.Suspension	suspendRecognizers(ParseContext context)	Suspends text recognizers only, until the returned scope closes: get(org.apache.tika.parser.enricher.CompositeContentEnricher, org.apache.tika.mime.MediaType, org.apache.tika.metadata.Metadata, org.apache.tika.parser.ParseContext) returns the annotators (embedders, taggers, captioners) and hasTextRecognizer(org.apache.tika.parser.enricher.CompositeContentEnricher, org.apache.tika.mime.MediaType, org.apache.tika.metadata.Metadata, org.apache.tika.parser.ParseContext) is false.

Methods inherited from class java.lang.Object

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

Field Details

MIN_PIXELS

public static final int MIN_PIXELS

Below this in either dimension an image is a spacer, not a picture: no engine sees it.

See Also:

• Constant Field Values

Method Details

get

public static Parser get(CompositeContentEnricher enrichers,
 MediaType mediaType,
 Metadata target,
 ParseContext context)

The enricher to invoke for a media type, or null. A configured list is authoritative: every matching member runs in order and an uncovered type gets nothing. With no list, the ContentEnrichers in the composite bound to the context are candidates and one runs, chosen as resolve(org.apache.tika.parser.Parser) chooses. Null while an enrichment is in progress in this context, so an enricher cannot recurse.

Parameters:

enrichers - the injected composite; null when none is configured

mediaType - the real, normalized media type of the bytes; may be null

target - the metadata of the image the engine will be handed, or a probe for a render not yet made; dispatch reads only facts from it: an image whose recorded size is under MIN_PIXELS gets nothing

suspend

public static ContentEnrichers.Suspension suspend(ParseContext context)

Suspends dispatch in this context until the returned scope closes. A container that enriches a rendering itself wraps the embedded parse of that rendering, so the embedded copy is not enriched a second time. Scopes nest; each restores the state it found.

suspendRecognizers

public static ContentEnrichers.Suspension suspendRecognizers(ParseContext context)

Suspends text recognizers only, until the returned scope closes: get(org.apache.tika.parser.enricher.CompositeContentEnricher, org.apache.tika.mime.MediaType, org.apache.tika.metadata.Metadata, org.apache.tika.parser.ParseContext) returns the annotators (embedders, taggers, captioners) and hasTextRecognizer(org.apache.tika.parser.enricher.CompositeContentEnricher, org.apache.tika.mime.MediaType, org.apache.tika.metadata.Metadata, org.apache.tika.parser.ParseContext) is false. A recognizer that declines this parse is still a recognizer, not an annotator. Scopes nest as for suspend(org.apache.tika.parser.ParseContext).

hasTextRecognizer

public static boolean hasTextRecognizer(CompositeContentEnricher enrichers,
 MediaType mediaType,
 Metadata target,
 ParseContext context)

Whether the enricher get(org.apache.tika.parser.enricher.CompositeContentEnricher, org.apache.tika.mime.MediaType, org.apache.tika.metadata.Metadata, org.apache.tika.parser.ParseContext) would return produces the document's text: a TextRecognizer that recognizes for this context, or a legacy image/ocr-* claimant. False while an enrichment is in progress. target is as for get(org.apache.tika.parser.enricher.CompositeContentEnricher, org.apache.tika.mime.MediaType, org.apache.tika.metadata.Metadata, org.apache.tika.parser.ParseContext).

resolve

public static CompositeContentEnricher resolve(Parser root)

One enricher per type from the enrichers found in a parser tree: an engine outside DefaultParser beats one inside it, the last wins within a tier, and an entry's _mime-include/_mime-exclude applies at every node. A collision within the winning tier is logged once. Empty when the tree holds no enricher. This is what the loader injects when no "text-recognizers" list is configured; the runtime fallback for an unloaded AutoDetectParser applies the same rules.

isEnricher

public static boolean isEnricher(Parser parser)

True if the parser, under any decorators, is a ContentEnricher.

asTextRecognizer

public static TextRecognizer asTextRecognizer(Parser parser)

The TextRecognizer under any decorators; null if the parser is not one.

isLegacyOcrType

public static boolean isLegacyOcrType(MediaType mediaType)

True for a retired image/ocr-* pseudo-type.

stripLegacyOcrPrefix

public static MediaType stripLegacyOcrPrefix(MediaType mediaType)

The real type behind a retired pseudo-type; any other type unchanged.

isDisabled

public static boolean isDisabled(ParseContext context)

Whether the request switched the list off: {"text-recognizers": {"enabled": false}}.