net.yacy.search.snippet

Class TextSnippet

java.lang.Object

net.yacy.search.snippet.TextSnippet

All Implemented Interfaces:

java.lang.Comparable<TextSnippet>, java.util.Comparator<TextSnippet>

public class TextSnippet
extends java.lang.Object
implements java.lang.Comparable<TextSnippet>, java.util.Comparator<TextSnippet>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextSnippet.Cache
static class	TextSnippet.ResultClass

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	descriptionline
private java.lang.String	error
private int	hashCache
private boolean	isMarked
private java.lang.String	line
private static int	MAX_CACHE
private static java.util.regex.Pattern	p1 \\A[^\\p{L}\\p{N}].+
private static java.util.regex.Pattern	p2 .+[^\\p{L}\\p{N}]\\Z
private static java.util.regex.Pattern	p3 \\A[\\p{L}\\p{N}]+[^\\p{L}\\p{N}].+\\Z updated to \\A([\\p{L}\\p{N}]+[^\\p{L}\\p{N}].+)([\\p{N}]+[.,][\\p{N}])+\\Z to detect words with none alphanumeric chars (1) allow comma/dot surrounded by number (2)
private static java.util.regex.Pattern	p4 [^\\p{L}\\p{N}]
private TextSnippet.ResultClass	resultStatus
static TextSnippet.Cache	snippetsCache
private static java.util.regex.Pattern	SPLIT_PATTERN
private byte[]	urlhash

Constructor Summary

Constructors

Constructor and Description
TextSnippet(byte[] urlhash, java.lang.String line, boolean isMarked, TextSnippet.ResultClass errorCode, java.lang.String errortext)
TextSnippet(LoaderDispatcher loader, URIMetadataNode row, HandleSet queryhashes, CacheStrategy cacheStrategy, boolean pre, int snippetMaxLength, boolean reindexing)

Method Summary

Methods

Modifier and Type	Method and Description
int	compare(TextSnippet o1, TextSnippet o2)
int	compareTo(TextSnippet o)
java.lang.String	descriptionline(QueryGoal queryGoal) Snippet line formatted/encoded for display in browser possible html code in raw line is html encoded query words marked by ..
boolean	exists()
java.lang.String	getError()
TextSnippet.ResultClass	getErrorCode()
java.lang.String	getLineMarked(QueryGoal queryGoal) Marks all words in current line which have the same hash values as the ones contained in argument.
java.lang.String	getLineRaw()
private static java.lang.String	getWordMarked(java.lang.String word, java.util.Set<byte[]> queryHashes) Marks words with <b>-tags.
int	hashCode()
private void	init(byte[] urlhash, java.lang.String line, boolean isMarked, TextSnippet.ResultClass errorCode, java.lang.String errortext) Init a snippet line for urlhash
boolean	isMarked()
private static void	removeMatchingHashes(java.lang.String sentence, HandleSet queryhashes)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals

Field Detail

MAX_CACHE

private static final int MAX_CACHE

See Also:

Constant Field Values

p1

private static final java.util.regex.Pattern p1

\\A[^\\p{L}\\p{N}].+

p2

private static final java.util.regex.Pattern p2

.+[^\\p{L}\\p{N}]\\Z

p3

private static final java.util.regex.Pattern p3

\\A[\\p{L}\\p{N}]+[^\\p{L}\\p{N}].+\\Z updated to \\A([\\p{L}\\p{N}]+[^\\p{L}\\p{N}].+)([\\p{N}]+[.,][\\p{N}])+\\Z to detect words with none alphanumeric chars (1) allow comma/dot surrounded by number (2)

p4

private static final java.util.regex.Pattern p4

[^\\p{L}\\p{N}]

snippetsCache

public static final TextSnippet.Cache snippetsCache

urlhash

private byte[] urlhash

line

private java.lang.String line

isMarked

private boolean isMarked

error

private java.lang.String error

resultStatus

private TextSnippet.ResultClass resultStatus

SPLIT_PATTERN

private static final java.util.regex.Pattern SPLIT_PATTERN

descriptionline

private java.lang.String descriptionline

hashCache

private int hashCache

Constructor Detail

TextSnippet

public TextSnippet(byte[] urlhash,
           java.lang.String line,
           boolean isMarked,
           TextSnippet.ResultClass errorCode,
           java.lang.String errortext)

TextSnippet

public TextSnippet(LoaderDispatcher loader,
           URIMetadataNode row,
           HandleSet queryhashes,
           CacheStrategy cacheStrategy,
           boolean pre,
           int snippetMaxLength,
           boolean reindexing)

Method Detail

init

private void init(byte[] urlhash,
        java.lang.String line,
        boolean isMarked,
        TextSnippet.ResultClass errorCode,
        java.lang.String errortext)

Init a snippet line for urlhash

Parameters:

urlhash - hash of the url for this snippet

line - text to use as snippet

isMarked - true if query words already marked in input text

errorCode -

errortext -

exists

public boolean exists()

isMarked

public boolean isMarked()

getLineRaw

public java.lang.String getLineRaw()

getError

public java.lang.String getError()

getErrorCode

public TextSnippet.ResultClass getErrorCode()

getLineMarked

public java.lang.String getLineMarked(QueryGoal queryGoal)

Marks all words in current line which have the same hash values as the ones contained in argument.

Parameters:

queryHashes - hashes of search words

Returns:

line with marked words

descriptionline

public java.lang.String descriptionline(QueryGoal queryGoal)

Snippet line formatted/encoded for display in browser possible html code in raw line is html encoded query words marked by ..

Parameters:

queryGoal -

Returns:

html encoded snippet line

compareTo

public int compareTo(TextSnippet o)

Specified by:

compareTo in interface java.lang.Comparable<TextSnippet>

compare

public int compare(TextSnippet o1,
          TextSnippet o2)

Specified by:

compare in interface java.util.Comparator<TextSnippet>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getWordMarked

private static java.lang.String getWordMarked(java.lang.String word,
                             java.util.Set<byte[]> queryHashes)

Marks words with <b>-tags. Beware: Method has side effects! Certain characters in words will be escaped to HTML encoding. Using this method a second time with already escaped characters might lead to undesired results.

Parameters:

word - the word to mark

queryHashes - hashes of the words to mark

Returns:

the marked word if one of the hashes matches, else the unmarked word

See Also:

#getLineMarked(Set)

removeMatchingHashes

private static void removeMatchingHashes(java.lang.String sentence,
                        HandleSet queryhashes)