org.apache.lucene.analysis.charfilter

Class HTMLStripCharFilter

java.lang.Object

java.io.Reader

org.apache.lucene.analysis.CharStream

org.apache.lucene.analysis.CharFilter

org.apache.lucene.analysis.BaseCharFilter

org.apache.lucene.analysis.charfilter.HTMLStripCharFilter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable

public final class HTMLStripCharFilter
extends org.apache.lucene.analysis.BaseCharFilter

A CharFilter that wraps another Reader and attempts to strip out HTML constructs.

Field Summary

Fields inherited from class org.apache.lucene.analysis.CharFilter

input

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
HTMLStripCharFilter(org.apache.lucene.analysis.CharStream source)
HTMLStripCharFilter(org.apache.lucene.analysis.CharStream source, java.util.Set<java.lang.String> escapedTags)

Method Summary

Modifier and Type	Method and Description
void	close()
int	read()
int	read(char[] cbuf, int off, int len)

Methods inherited from class org.apache.lucene.analysis.BaseCharFilter

addOffCorrectMap, correct, getLastCumulativeDiff

Methods inherited from class org.apache.lucene.analysis.CharFilter

correctOffset, mark, markSupported, reset

Methods inherited from class java.io.Reader

read, read, ready, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLStripCharFilter

public HTMLStripCharFilter(org.apache.lucene.analysis.CharStream source)

Parameters:

source -

HTMLStripCharFilter

public HTMLStripCharFilter(org.apache.lucene.analysis.CharStream source,
                           java.util.Set<java.lang.String> escapedTags)

Parameters:

source -

escapedTags - Tags in this set (both start and end tags) will not be filtered out.

Method Detail

read

public int read()
         throws java.io.IOException

Overrides:

read in class java.io.Reader

Throws:

java.io.IOException

read

public int read(char[] cbuf,
                int off,
                int len)
         throws java.io.IOException

Overrides:

read in class org.apache.lucene.analysis.CharFilter

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class org.apache.lucene.analysis.CharFilter

Throws:

java.io.IOException