org.egothor.text

Class Snipper

java.lang.Object

org.egothor.text.Snipper

Direct Known Subclasses:

SnipperOfStrings, SnipperOfStringsDiacritics, SnipperOfTokens

public abstract class Snipper
extends Object

This class is part of the Egothor Project

Author:

Leo Galambos

Constructor Summary

Constructors

Constructor and Description
Snipper(boolean htmlAware, String startHit, String endHit) Constructor for the Snipper object

Method Summary

Modifier and Type	Method and Description
String	filter(Sequence<Token> tokens) Description of the Method
abstract boolean	matches(Token w) Description of the Method

Methods inherited from class java.lang.Object

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

Constructor Detail

Snipper

public Snipper(boolean htmlAware,
               String startHit,
               String endHit)

Constructor for the Snipper object

Parameters:

htmlAware - Print all string in HTML format (translate characters to HTML entities)

startHit -

endHit -

Method Detail

filter

public String filter(Sequence<Token> tokens)

Description of the Method

Parameters:

tokens - Description of the Parameter

Returns:

Description of the Return Value

matches

public abstract boolean matches(Token w)

Description of the Method

Parameters:

w - Description of the Parameter

Returns:

Description of the Return Value