nl.inl.blacklab.search.results

Class ContextSize

java.lang.Object

nl.inl.blacklab.search.results.ContextSize

public class ContextSize
extends Object

Represents the size of the context around a hit. WARNING: right now, only left() is used (for both left and right context size)! The other functionality will be added in the future.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ContextSize	get(int size)
static ContextSize	get(int left, int right)
static ContextSize	get(int left, int right, boolean includeHit)
int	hashCode()
static ContextSize	hitOnly()
boolean	includeHit() Should the hit itself be included in the context or not? By default it always is, but for some operations you only need the left context.
int	left()
int	right()
String	toString()
static ContextSize	union(ContextSize a, ContextSize b) Return the minimal context size that encompasses both parameters.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static ContextSize get(int left,
                              int right,
                              boolean includeHit)

get

public static ContextSize get(int left,
                              int right)

get

public static ContextSize get(int size)

hitOnly

public static ContextSize hitOnly()

left

public int left()

union

public static ContextSize union(ContextSize a,
                                ContextSize b)

Return the minimal context size that encompasses both parameters.

Parameters:

a - first context size

b - second context size

Returns:

union of both context sizes

right

public int right()

includeHit

public boolean includeHit()

Should the hit itself be included in the context or not? By default it always is, but for some operations you only need the left context. And to determine collocations you might only want left and right context and not the hit context itself (because you're counting words that occur around the hit)

Returns:

whether or not the hit context should be included

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object