Package com.funnelback.publicui.search.model.transaction.cache

Class CacheQuestion

java.lang.Object

com.funnelback.publicui.search.model.transaction.cache.CacheQuestion

public class CacheQuestion
extends Object

This class contains all the input parameters for a cache request

Since:

15.0

Field Summary

Fields

Modifier and Type	Field	Description
private @NonNull SearchPackageConfig	collection	Collection to get the cached document from
private String	doc	Relative path of the document in the collection storage to access the document.
private @NonNull @Pattern(regexp="[\\w-_]+") String	form	Form (template) to use to render the cached copy
private int	len	Length of the document in the WARC file
private long	off	Offset of the document in the WARC file
private @NonNull @Pattern(regexp="[\\w-_]+") String	profile	Profile where to lookup the cached copies template to use
private String	url	URL of the document to retrieve the cached copy of

Constructor Summary

Constructors

Constructor	Description
CacheQuestion()
CacheQuestion(@NonNull SearchPackageConfig collection, @NonNull String profile, @NonNull String form, String url, String doc, long off, int len)

Method Summary

Modifier and Type	Method	Description
@NonNull SearchPackageConfig	getCollection()	Collection to get the cached document from
String	getDoc()	Relative path of the document in the collection storage to access the document.
@NonNull String	getForm()	Form (template) to use to render the cached copy
int	getLen()	Length of the document in the WARC file
long	getOff()	Offset of the document in the WARC file
@NonNull String	getProfile()	Profile where to lookup the cached copies template to use
String	getUrl()	URL of the document to retrieve the cached copy of
void	setCollection(@NonNull SearchPackageConfig collection)	Collection to get the cached document from
void	setDoc(String doc)	Relative path of the document in the collection storage to access the document.
void	setForm(@NonNull String form)	Form (template) to use to render the cached copy
void	setLen(int len)	Length of the document in the WARC file
void	setOff(long off)	Offset of the document in the WARC file
void	setProfile(@NonNull String profile)	Profile where to lookup the cached copies template to use
void	setUrl(String url)	URL of the document to retrieve the cached copy of

Methods inherited from class java.lang.Object

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

Field Detail

collection

@NonNull
private @NonNull SearchPackageConfig collection

Collection to get the cached document from

profile

@NonNull
@Pattern(regexp="[\\w-_]+")
private @NonNull @Pattern(regexp="[\\w-_]+") String profile

Profile where to lookup the cached copies template to use

form

@NonNull
@Pattern(regexp="[\\w-_]+")
private @NonNull @Pattern(regexp="[\\w-_]+") String form

Form (template) to use to render the cached copy

The template is expected to be prefixed with cache. and have the extension .ftl

url

private String url

URL of the document to retrieve the cached copy of

doc

private String doc

Relative path of the document in the collection storage to access the document.

This is used as a fallback method if the document cannot be found via its URL, for example if the URL has been rewritten

off

private long off

Offset of the document in the WARC file

len

private int len

Length of the document in the WARC file

Constructor Detail

CacheQuestion

public CacheQuestion(@NonNull
                     @NonNull SearchPackageConfig collection,
                     @NonNull
                     @NonNull String profile,
                     @NonNull
                     @NonNull String form,
                     String url,
                     String doc,
                     long off,
                     int len)

CacheQuestion

public CacheQuestion()

Method Detail

getCollection

@NonNull
public @NonNull SearchPackageConfig getCollection()

Collection to get the cached document from

setCollection

public void setCollection(@NonNull
                          @NonNull SearchPackageConfig collection)

Collection to get the cached document from

getProfile

@NonNull
public @NonNull String getProfile()

Profile where to lookup the cached copies template to use

setProfile

public void setProfile(@NonNull
                       @NonNull String profile)

Profile where to lookup the cached copies template to use

getForm

@NonNull
public @NonNull String getForm()

Form (template) to use to render the cached copy

The template is expected to be prefixed with cache. and have the extension .ftl

setForm

public void setForm(@NonNull
                    @NonNull String form)

Form (template) to use to render the cached copy

The template is expected to be prefixed with cache. and have the extension .ftl

getUrl

public String getUrl()

URL of the document to retrieve the cached copy of

setUrl

public void setUrl(String url)

URL of the document to retrieve the cached copy of

getDoc

public String getDoc()

Relative path of the document in the collection storage to access the document.

This is used as a fallback method if the document cannot be found via its URL, for example if the URL has been rewritten

setDoc

public void setDoc(String doc)

Relative path of the document in the collection storage to access the document.

This is used as a fallback method if the document cannot be found via its URL, for example if the URL has been rewritten

getOff

public long getOff()

Offset of the document in the WARC file

setOff

public void setOff(long off)

Offset of the document in the WARC file

getLen

public int getLen()

Length of the document in the WARC file

setLen

public void setLen(int len)

Length of the document in the WARC file