Package org.apache.tika.parser.hook

Class ParseHooks

java.lang.Object

org.apache.tika.parser.hook.ParseHooks

All Implemented Interfaces:

TransientParseState

public final class ParseHooks
extends Object
implements TransientParseState

The hooks a parse runs, in config order. Pinning and offering never fail a document: a problem is a warning on that document's metadata.

Since:

Apache Tika 4.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ParseHooks.Run	Marks a top-level parse in progress; tracks the documents being parsed, outermost last.

Constructor Summary

Constructors

Constructor	Description
ParseHooks(List<ParseHook> hooks)

Method Summary

Modifier and Type	Method	Description
void	end(Metadata root, boolean failed, ParseContext context)
List<ParseHook>	getHooks()
boolean	isEmpty()
void	offer(MediaType type, Metadata metadata, Metadata parent, Path bytes, ParseContext context)
void	offerPage(MediaType type, int page, Path bytes, ParseContext context)	A rendered page of the current document, from its own parser; never fails it.
Path	pin(MediaType type, Metadata metadata, TikaInputStream tis, ParseContext context)	The document's bytes as a file when a hook wants them, else null.
void	start(Metadata root, ParseContext context)
boolean	wantsPages(MediaType renderType, ParseContext context)	Whether any hook wants the current document's pages rendered as images of this type.

Methods inherited from class java.lang.Object

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

Constructor Details

ParseHooks

public ParseHooks(List<ParseHook> hooks)

Method Details

getHooks

public List<ParseHook> getHooks()

isEmpty

public boolean isEmpty()

start

public void start(Metadata root,
 ParseContext context)
           throws TikaException

Throws:

TikaException

pin

public Path pin(MediaType type,
 Metadata metadata,
 TikaInputStream tis,
 ParseContext context)
         throws TikaException

The document's bytes as a file when a hook wants them, else null.

Throws:

TikaException

offer

public void offer(MediaType type,
 Metadata metadata,
 Metadata parent,
 Path bytes,
 ParseContext context)

wantsPages

public boolean wantsPages(MediaType renderType,
 ParseContext context)
                   throws TikaException

Whether any hook wants the current document's pages rendered as images of this type.

Throws:

TikaException

offerPage

public void offerPage(MediaType type,
 int page,
 Path bytes,
 ParseContext context)

A rendered page of the current document, from its own parser; never fails it.

end

public void end(Metadata root,
 boolean failed,
 ParseContext context)