org.egothor.text
Class Snipper

java.lang.Object
  extended by org.egothor.text.Snipper
Direct Known Subclasses:
SnipperOfStrings, SnipperOfTokens

public abstract class Snipper
extends java.lang.Object

This class is part of the Egothor Project

Author:
Leo Galambos

Constructor Summary
Snipper(boolean htmlAware, java.lang.String startHit, java.lang.String endHit)
          Constructor for the Snipper object
 
Method Summary
 java.lang.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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Snipper

public Snipper(boolean htmlAware,
               java.lang.String startHit,
               java.lang.String endHit)
Constructor for the Snipper object

Parameters:
word - Description of the Parameter
htmlAware - Print all string in HTML format (translate characters to HTML entities)
Method Detail

filter

public java.lang.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