com.exalead.fetchapi.client

Interface FetchClient

public interface FetchClient

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FetchClient.Parameter Untyped additional parameter.

Method Summary

Modifier and Type	Method and Description
com.exalead.pdoc.ProcessableDocument	fetch(Hit hit, FetchClient.Parameter... params) Fetch the document represented by a Hit.
com.exalead.pdoc.ProcessableDocument	fetch(java.lang.String source, java.lang.String uri, FetchClient.Parameter... params) Fetch the document represented by a Hit.
com.exalead.pdoc.ProcessableDocument	fetch(java.lang.String source, java.lang.String uri, java.lang.String buildGroup, FetchClient.Parameter... params) Fetch the document represented by a Hit.
java.io.InputStream	preview(Hit hit, FetchClient.Parameter... params) Proxify the preview of this Hit.
java.io.InputStream	preview(java.lang.String source, java.lang.String uri, FetchClient.Parameter... params) Proxify the preview of this Hit.
java.io.InputStream	preview(java.lang.String source, java.lang.String uri, java.lang.String buildGroup, FetchClient.Parameter... params) Proxify the preview of this Hit.
Preview	previewExt(java.lang.String source, java.lang.String uri, java.lang.String buildGroup, FetchClient.Parameter... parameters) Get the preview of this Hit.
void	setFetchCommand(java.lang.String command)
void	setPreviewCommand(java.lang.String command)
void	setThumbnailCommand(java.lang.String command)
Thumbnail	thumbnail(Hit hit, FetchClient.Parameter... params) Fetch a thumbnail-ed representation of this Hit.
Thumbnail	thumbnail(java.lang.String source, java.lang.String uri, FetchClient.Parameter... params) Fetch a thumbnail-ed representation of this Hit.
Thumbnail	thumbnail(java.lang.String source, java.lang.String uri, java.lang.String buildGroup, FetchClient.Parameter... params) Fetch a thumbnail-ed representation of this Hit.

Method Detail

fetch

com.exalead.pdoc.ProcessableDocument fetch(Hit hit,
                                           FetchClient.Parameter... params)
                                    throws FetchException

Fetch the document represented by a Hit. Will try to use the cache, before asking the source. Filename of the fetched document won't be available in ALL_PARTS mode.

Parameters:

hit - The index Hit representing the document

Returns:

The original document

Throws:

FetchException

fetch

com.exalead.pdoc.ProcessableDocument fetch(java.lang.String source,
                                           java.lang.String uri,
                                           FetchClient.Parameter... params)
                                    throws FetchException

Fetch the document represented by a Hit. Always fetch from the source directly. Filename of the fetched document won't be available in ALL_PARTS mode.

Parameters:

source - Name of the connector or crawler

uri - Uri of the document

Returns:

The original document

Throws:

FetchException

fetch

com.exalead.pdoc.ProcessableDocument fetch(java.lang.String source,
                                           java.lang.String uri,
                                           java.lang.String buildGroup,
                                           FetchClient.Parameter... params)
                                    throws FetchException

Fetch the document represented by a Hit. Will try to use the cache, before asking the source. Filename of the fetched document won't be available in ALL_PARTS mode.

Parameters:

source - Name of the connector or crawler

uri - Uri of the document

buildGroup - Build Group having indexed this document

Returns:

The original document

Throws:

FetchException

thumbnail

Thumbnail thumbnail(Hit hit,
                    FetchClient.Parameter... params)
             throws FetchException

Fetch a thumbnail-ed representation of this Hit. Will try to use the thumbnail store, before thumbnailing on-demand.

Parameters:

hit - The index Hit representing the document

Returns:

The original document

Throws:

FetchException

thumbnail

Thumbnail thumbnail(java.lang.String source,
                    java.lang.String uri,
                    FetchClient.Parameter... params)
             throws FetchException

Fetch a thumbnail-ed representation of this Hit. Will always generate thumbnail on-demand.

Parameters:

source - Name of the connector or crawler

uri - Uri of the document

Returns:

The original document

Throws:

FetchException

thumbnail

Thumbnail thumbnail(java.lang.String source,
                    java.lang.String uri,
                    java.lang.String buildGroup,
                    FetchClient.Parameter... params)
             throws FetchException

Fetch a thumbnail-ed representation of this Hit. Will try to use the thumbnail store, before thumbnailing on-demand.

Parameters:

source - Name of the connector or crawler

uri - Uri of the document

buildGroup - Build Group having indexed this document

Returns:

The original document

Throws:

FetchException

preview

java.io.InputStream preview(Hit hit,
                            FetchClient.Parameter... params)
                     throws FetchException

Proxify the preview of this Hit.

Parameters:

hit - The index Hit representing the document

Returns:

The previewed document as stream

Throws:

FetchException

preview

java.io.InputStream preview(java.lang.String source,
                            java.lang.String uri,
                            FetchClient.Parameter... params)
                     throws FetchException

Proxify the preview of this Hit.

Parameters:

source - Name of the connector or crawler

uri - Uri of the document

Returns:

The previewed document as stream

Throws:

FetchException

preview

java.io.InputStream preview(java.lang.String source,
                            java.lang.String uri,
                            java.lang.String buildGroup,
                            FetchClient.Parameter... params)
                     throws FetchException

Proxify the preview of this Hit.

Parameters:

source - Name of the connector or crawler

uri - Uri of the document

buildGroup - Build Group having indexed this document

Returns:

The previewed document as stream

Throws:

FetchException

previewExt

Preview previewExt(java.lang.String source,
                   java.lang.String uri,
                   java.lang.String buildGroup,
                   FetchClient.Parameter... parameters)
            throws FetchException

Get the preview of this Hit.

Parameters:

source - Name of the connector or crawler

uri - Uri of the document

buildGroup - Build Group having indexed this document

parameters - additional parameters

Throws:

FetchException

setFetchCommand

void setFetchCommand(java.lang.String command)

setPreviewCommand

void setPreviewCommand(java.lang.String command)

setThumbnailCommand

void setThumbnailCommand(java.lang.String command)