org.apache.lucene.analysis.charfilter

Class HTMLStripCharFilter

java.lang.Object

java.io.Reader

org.apache.lucene.analysis.CharFilter

org.apache.lucene.analysis.charfilter.BaseCharFilter

org.apache.lucene.analysis.charfilter.HTMLStripCharFilter

All Implemented Interfaces:

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

public final class HTMLStripCharFilter
extends 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(java.io.Reader in) Creates a new scanner
HTMLStripCharFilter(java.io.Reader in, java.util.Set<java.lang.String> escapedTags) Creates a new HTMLStripCharFilter over the provided Reader with the specified start and end tags.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying input stream.
int	read()
int	read(char[] cbuf, int off, int len)

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

addOffCorrectMap, correct, getLastCumulativeDiff

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

correctOffset

Methods inherited from class java.io.Reader

mark, markSupported, read, read, ready, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLStripCharFilter

public HTMLStripCharFilter(java.io.Reader in,
                           java.util.Set<java.lang.String> escapedTags)

Creates a new HTMLStripCharFilter over the provided Reader with the specified start and end tags.

Parameters:

in - Reader to strip html tags from.

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

HTMLStripCharFilter

public HTMLStripCharFilter(java.io.Reader in)

Creates a new scanner

Parameters:

in - the java.io.Reader to read input from.

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

Specified by:

read in class java.io.Reader

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Description copied from class: CharFilter

Closes the underlying input stream.

NOTE: The default implementation closes the input Reader, so be sure to call super.close() when overriding this method.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class CharFilter

Throws:

java.io.IOException