org.apache.tika.utils

Class ParserUtils

java.lang.Object

org.apache.tika.utils.ParserUtils

public class ParserUtils
extends Object

Helper util methods for Parsers themselves.

Field Summary

Fields

Modifier and Type	Field and Description
static Property	EMBEDDED_PARSER

Constructor Summary

Constructors

Constructor and Description
ParserUtils()

Method Summary

Modifier and Type	Method and Description
static Metadata	cloneMetadata(Metadata m) Does a deep clone of a Metadata object.
static InputStream	ensureStreamReReadable(InputStream stream, TemporaryResources tmp, Metadata metadata) Ensures that the Stream will be able to be re-read, by buffering to a temporary file if required.
static String	getParserClassname(Parser parser) Identifies the real class name of the Parser, unwrapping any ParserDecorator decorations on top of it.
static void	recordParserDetails(Parser parser, Metadata metadata) Records details of the Parser used to the Metadata, typically wanted where multiple parsers could be picked between or used.
static void	recordParserDetails(String parserClassName, Metadata metadata) Records details of the Parser used to the Metadata, typically wanted where multiple parsers could be picked between or used.
static void	recordParserFailure(Parser parser, Throwable failure, Metadata metadata) Records details of a Parser's failure to the Metadata, so you can check what went wrong even if the Exception wasn't immediately thrown (eg when several different Parsers are used)
static InputStream	streamResetForReRead(InputStream stream, TemporaryResources tmp) Resets the given TikaInputStream (checked by ensureStreamReReadable(InputStream, TemporaryResources, Metadata)) so that it can be re-read again.

Methods inherited from class java.lang.Object

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

Field Detail

EMBEDDED_PARSER

public static final Property EMBEDDED_PARSER

Constructor Detail

ParserUtils

public ParserUtils()

Method Detail

cloneMetadata

public static Metadata cloneMetadata(Metadata m)

Does a deep clone of a Metadata object.

getParserClassname

public static String getParserClassname(Parser parser)

Identifies the real class name of the Parser, unwrapping any ParserDecorator decorations on top of it.

recordParserDetails

public static void recordParserDetails(Parser parser,
                                       Metadata metadata)

Records details of the Parser used to the Metadata, typically wanted where multiple parsers could be picked between or used.

recordParserDetails

public static void recordParserDetails(String parserClassName,
                                       Metadata metadata)

Records details of the Parser used to the Metadata, typically wanted where multiple parsers could be picked between or used.

recordParserFailure

public static void recordParserFailure(Parser parser,
                                       Throwable failure,
                                       Metadata metadata)

Records details of a Parser's failure to the Metadata, so you can check what went wrong even if the Exception wasn't immediately thrown (eg when several different Parsers are used)

ensureStreamReReadable

public static InputStream ensureStreamReReadable(InputStream stream,
                                                 TemporaryResources tmp,
                                                 Metadata metadata)
                                          throws IOException

Ensures that the Stream will be able to be re-read, by buffering to a temporary file if required. Streams that are automatically OK include TikaInputStreams created from Files or InputStreamFactories, and RereadableInputStream.

Throws:

IOException

streamResetForReRead

public static InputStream streamResetForReRead(InputStream stream,
                                               TemporaryResources tmp)
                                        throws IOException

Resets the given TikaInputStream (checked by ensureStreamReReadable(InputStream, TemporaryResources, Metadata)) so that it can be re-read again.

Throws:

IOException