com.groupdocs.search

Class Extractor

java.lang.Object

com.groupdocs.search.events.EventHubBase

com.groupdocs.search.Extractor

public class Extractor
extends EventHubBase

Represents a tool for preliminary data extraction from documents for separating the stage of subsequent fast indexing.

Field Summary

Fields

Modifier and Type	Field and Description
Event<EventHandler<IndexErrorEventArgs>>	ErrorOccurred Occurs when an error happens during an extractor operation.
Event<EventHandler<ImagePreparingEventArgs>>	ImagePreparing Occurs when an image is going to be prepared for indexing.
Event<EventHandler<PasswordRequiredEventArgs>>	PasswordRequired Occurs when a document requires password for opening.

Constructor Summary

Constructors

Constructor and Description
Extractor() Initializes a new instance of the Extractor class.

Method Summary

Modifier and Type	Method and Description
ExtractedData	extract(Document document, ExtractionOptions extractionOptions) Extracts data from a document.
ExtractorSettings	getSettings() Gets the extractor settings.
void	raiseErrorOccurredPublic(String message, boolean isCritical)
void	raiseImagePreparingPublic(String documentKey, String[] innerPath, int imageIndex, ImageFrame[] frames, InputStream stream)
String	raisePasswordRequiredPublic(String filePath)

Methods inherited from class java.lang.Object

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

Field Detail

ErrorOccurred

public final Event<EventHandler<IndexErrorEventArgs>> ErrorOccurred

Occurs when an error happens during an extractor operation.

ImagePreparing

public final Event<EventHandler<ImagePreparingEventArgs>> ImagePreparing

Occurs when an image is going to be prepared for indexing.

PasswordRequired

public final Event<EventHandler<PasswordRequiredEventArgs>> PasswordRequired

Occurs when a document requires password for opening.

Constructor Detail

Extractor

public Extractor()

Initializes a new instance of the Extractor class.

Method Detail

extract

public final ExtractedData extract(Document document,
                                   ExtractionOptions extractionOptions)

Extracts data from a document.

Parameters:

document - The document from file system, stream or structure.

extractionOptions - The extraction options.

Returns:

The extracted data of the document.

getSettings

public final ExtractorSettings getSettings()

Gets the extractor settings.

Returns:

The extractor settings.

raiseErrorOccurredPublic

public final void raiseErrorOccurredPublic(String message,
                                           boolean isCritical)

Specified by:

raiseErrorOccurredPublic in class EventHubBase

raiseImagePreparingPublic

public final void raiseImagePreparingPublic(String documentKey,
                                            String[] innerPath,
                                            int imageIndex,
                                            ImageFrame[] frames,
                                            InputStream stream)

Specified by:

raiseImagePreparingPublic in class EventHubBase

raisePasswordRequiredPublic

public final String raisePasswordRequiredPublic(String filePath)

Specified by:

raisePasswordRequiredPublic in class EventHubBase