org.docgene.help.utils

Class FullTextSearchHelper

java.lang.Object

org.docgene.help.utils.FullTextSearchHelper

public class FullTextSearchHelper
extends java.lang.Object

This class allows to get the context for a full text search result.

Since:

1.6.18

Constructor Summary

Constructors

Constructor and Description
FullTextSearchHelper()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTextContext(java.io.File file, java.lang.String term) Return the search context for a term.
java.lang.String	getTextContext(java.io.File file, java.lang.String term, boolean boldTerm) Return the search context for a term.
java.lang.String	getTextContext(java.net.URL url, java.lang.String term) Return the search context for a term.
java.lang.String	getTextContext(java.net.URL url, java.lang.String term, boolean boldTerm) Return the search context for a term.
boolean	isJSoupAvailable() Return true if jSoup is available.

Methods inherited from class java.lang.Object

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

Constructor Detail

FullTextSearchHelper

public FullTextSearchHelper()

Method Detail

isJSoupAvailable

public boolean isJSoupAvailable()

Return true if jSoup is available.

Returns:

true if jSoup is available

getTextContext

public java.lang.String getTextContext(java.io.File file,
                                       java.lang.String term)

Return the search context for a term.

Parameters:

file - the file

term - the term

Returns:

the search context

getTextContext

public java.lang.String getTextContext(java.net.URL url,
                                       java.lang.String term,
                                       boolean boldTerm)

Return the search context for a term.

Parameters:

url - the URL

term - the term

boldTerm - true if the term should be shown in bold font

Returns:

the search context

getTextContext

public java.lang.String getTextContext(java.net.URL url,
                                       java.lang.String term)

Return the search context for a term.

Parameters:

url - the URL

term - the term

Returns:

the search context

getTextContext

public java.lang.String getTextContext(java.io.File file,
                                       java.lang.String term,
                                       boolean boldTerm)

Return the search context for a term.

Parameters:

file - the file

term - the term

boldTerm - true if the term should be shown in bold font

Returns:

the search context