Package org.apache.tika.parser.hook

Class ParseHooks.Run

java.lang.Object

org.apache.tika.parser.hook.ParseHooks.Run

All Implemented Interfaces:

TransientParseState

Enclosing class:

ParseHooks

public static final class ParseHooks.Run
extends Object
implements TransientParseState

Marks a top-level parse in progress; tracks the documents being parsed, outermost last.

Constructor Summary

Constructors

Constructor	Description
Run()

Method Summary

Modifier and Type	Method	Description
Metadata	current()	The document whose parser is running; null between documents.
Metadata	enter(Metadata metadata)	Enters a document; returns the one whose parser embedded it, null at the top.
void	exit()
String	idPath(Metadata metadata)	The id path of an open document; null for the top-level one or a closed one.
Metadata	parent()	The document the current one is embedded in; null at the top.

Methods inherited from class java.lang.Object

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

Constructor Details

Run

public Run()

Method Details

enter

public Metadata enter(Metadata metadata)

Enters a document; returns the one whose parser embedded it, null at the top. A document the recursive wrapper did not number gets an id path in the wrapper's scheme, so a result written outside the wrapper still names where it came from.

exit

public void exit()

current

public Metadata current()

The document whose parser is running; null between documents.

parent

public Metadata parent()

The document the current one is embedded in; null at the top.

idPath

public String idPath(Metadata metadata)

The id path of an open document; null for the top-level one or a closed one.