org.apache.beam.sdk.io.tika

Class ParseResult

java.lang.Object

org.apache.beam.sdk.io.tika.ParseResult

All Implemented Interfaces:

java.io.Serializable

public class ParseResult
extends java.lang.Object
implements java.io.Serializable

The result of parsing a single file with Tika: contains the file's location, metadata, extracted text, and optionally an error. If there is an error, the metadata and extracted text may be partial (i.e. not represent the entire file).

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static ParseResult	failure(java.lang.String fileLocation, java.lang.String partialContent, Metadata partialMetadata, java.lang.Throwable error)
java.lang.String	getContent() Returns the extracted text.
java.lang.Throwable	getError() Returns the parse error, if the file was parsed unsuccessfully.
java.lang.String	getErrorAsString() Same as getError(), but returns the complete stack trace of the error as a String.
java.lang.String	getFileLocation() Returns the absolute path to the input file.
Metadata	getMetadata() Returns the extracted metadata.
int	hashCode()
boolean	isSuccess() Returns whether this file was parsed successfully.
static ParseResult	success(java.lang.String fileLocation, java.lang.String content)
static ParseResult	success(java.lang.String fileLocation, java.lang.String content, Metadata metadata)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

success

public static ParseResult success(java.lang.String fileLocation,
                                  java.lang.String content,
                                  Metadata metadata)

success

public static ParseResult success(java.lang.String fileLocation,
                                  java.lang.String content)

failure

public static ParseResult failure(java.lang.String fileLocation,
                                  java.lang.String partialContent,
                                  Metadata partialMetadata,
                                  java.lang.Throwable error)

getFileLocation

public java.lang.String getFileLocation()

Returns the absolute path to the input file.

isSuccess

public boolean isSuccess()

Returns whether this file was parsed successfully.

getError

public java.lang.Throwable getError()

Returns the parse error, if the file was parsed unsuccessfully.

getErrorAsString

public java.lang.String getErrorAsString()

Same as getError(), but returns the complete stack trace of the error as a String.

getContent

public java.lang.String getContent()

Returns the extracted text. May be partial, if this parse result contains a failure.

getMetadata

public Metadata getMetadata()

Returns the extracted metadata. May be partial, if this parse result contains a failure.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object