org.apache.solr.analysis

Class LegacyHTMLStripCharFilter

java.lang.Object

java.io.Reader

org.apache.lucene.analysis.CharStream

org.apache.lucene.analysis.CharFilter

org.apache.lucene.analysis.BaseCharFilter

org.apache.solr.analysis.LegacyHTMLStripCharFilter

All Implemented Interfaces:

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

Deprecated.

use HTMLStripCharFilter

@Deprecated
public class LegacyHTMLStripCharFilter
extends org.apache.lucene.analysis.BaseCharFilter

This class is NOT recommended for new users and should be considered UNSUPPORTED.

In Solr version 3.5 and earlier, HTMLStripCharFilter(Factory) had known bugs in the offsets it provided, triggering e.g. exceptions in highlighting.

This class is provided as possible alternative for people who depend on the "broken" behavior of HTMLStripCharFilter in Solr version 3.5 and earlier, and/or who don't like the changes introduced by the Solr 3.6+ version of HTMLStripCharFilterFactory. (See the 3.6.0 release section of solr/CHANGES.txt for a list of differences in behavior.)

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_READ_AHEAD Deprecated.
private static java.util.HashMap<java.lang.String,java.lang.Character>	entityTable Deprecated.
private static int	EOF Deprecated.
private java.util.Set<java.lang.String>	escapedTags Deprecated.
private int	lastMark Deprecated.
private static int	MATCH Deprecated.
private static int	MISMATCH Deprecated.
private int	numEaten Deprecated.
private int	numRead Deprecated.
private int	numReturned Deprecated.
private int	numWhitespace Deprecated.
private java.lang.StringBuilder	pushed Deprecated.
private int	readAheadLimit Deprecated.
private int	safeReadAheadLimit Deprecated.
private java.lang.StringBuilder	sb Deprecated.

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

input

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated.
private int	eatSSI() Deprecated.
(package private) int	findEndTag() Deprecated.
int	getReadAheadLimit() Deprecated.
private boolean	isAlpha(int ch) Deprecated.
private boolean	isDigit(int ch) Deprecated.
private boolean	isFirstIdChar(int ch) Deprecated.
private boolean	isHex(int ch) Deprecated.
private boolean	isIdChar(int ch) Deprecated. From HTML 4.0 [4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' | CombiningChar | Extender [5] Name ::= (Letter | '_' | ':') (NameChar)* [6] Names ::= Name (#x20 Name)* [7] Nmtoken ::= (NameChar)+ [8] Nmtokens ::= Nmtoken (#x20 Nmtoken)*
private boolean	isSpace(int ch) Deprecated.
static void	main(java.lang.String[] args) Deprecated.
private int	next() Deprecated.
private int	nextSkipWS() Deprecated.
private int	peek() Deprecated.
private void	push(int ch) Deprecated.
int	read() Deprecated.
int	read(char[] cbuf, int off, int len) Deprecated.
private int	readAttr2() Deprecated. [10] AttValue ::= '"' ([^<&"] | Reference)* '"' | "'" ([^<&'] | Reference)* "'" need to also handle unquoted attributes, and attributes w/o values:
private int	readBang(boolean inScript) Deprecated. valid comments according to HTML specs Hello --> #comments inside of an entity decl: Turns out, IE & mozilla don't parse comments correctly.
private int	readComment(boolean inScript) Deprecated.
private int	readEntity() Deprecated.
private int	readName(boolean checkEscaped) Deprecated.
private int	readNumericEntity() Deprecated.
private int	readProcessingInstruction() Deprecated.
private int	readScriptString() Deprecated.
private int	readTag() Deprecated.
private void	restoreState() Deprecated.
private void	saveState() Deprecated.

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

Field Detail

readAheadLimit

private int readAheadLimit

Deprecated.

safeReadAheadLimit

private int safeReadAheadLimit

Deprecated.

numWhitespace

private int numWhitespace

Deprecated.

numRead

private int numRead

Deprecated.

numEaten

private int numEaten

Deprecated.

numReturned

private int numReturned

Deprecated.

lastMark

private int lastMark

Deprecated.

escapedTags

private java.util.Set<java.lang.String> escapedTags

Deprecated.

pushed

private final java.lang.StringBuilder pushed

Deprecated.

EOF

private static final int EOF

Deprecated.

See Also:

Constant Field Values

MISMATCH

private static final int MISMATCH

Deprecated.

See Also:

Constant Field Values

MATCH

private static final int MATCH

Deprecated.

See Also:

Constant Field Values

sb

private final java.lang.StringBuilder sb

Deprecated.

DEFAULT_READ_AHEAD

public static final int DEFAULT_READ_AHEAD

Deprecated.

See Also:

Constant Field Values

entityTable

private static final java.util.HashMap<java.lang.String,java.lang.Character> entityTable

Deprecated.

Constructor Detail

LegacyHTMLStripCharFilter

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

Deprecated.

LegacyHTMLStripCharFilter

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

Deprecated.

LegacyHTMLStripCharFilter

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

Deprecated.

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

getReadAheadLimit

public int getReadAheadLimit()

Deprecated.

next

private int next()
          throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

nextSkipWS

private int nextSkipWS()
                throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

peek

private int peek()
          throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

push

private void push(int ch)

Deprecated.

isSpace

private boolean isSpace(int ch)

Deprecated.

isHex

private boolean isHex(int ch)

Deprecated.

isAlpha

private boolean isAlpha(int ch)

Deprecated.

isDigit

private boolean isDigit(int ch)

Deprecated.

isIdChar

private boolean isIdChar(int ch)

Deprecated.

From HTML 4.0 [4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' | CombiningChar | Extender [5] Name ::= (Letter | '_' | ':') (NameChar)* [6] Names ::= Name (#x20 Name)* [7] Nmtoken ::= (NameChar)+ [8] Nmtokens ::= Nmtoken (#x20 Nmtoken)*

isFirstIdChar

private boolean isFirstIdChar(int ch)

Deprecated.

saveState

private void saveState()
                throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

restoreState

private void restoreState()
                   throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

readNumericEntity

private int readNumericEntity()
                       throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

readEntity

private int readEntity()
                throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

readBang

private int readBang(boolean inScript)
              throws java.io.IOException

Deprecated.

valid comments according to HTML specs Hello --> #comments inside of an entity decl: Turns out, IE & mozilla don't parse comments correctly. Since this is meant to be a practical stripper, I'll just try and duplicate what the browsers do.

Throws:

java.io.IOException

readComment

private int readComment(boolean inScript)
                 throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

readTag

private int readTag()
             throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

findEndTag

int findEndTag()
        throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

readScriptString

private int readScriptString()
                      throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

readName

private int readName(boolean checkEscaped)
              throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

readAttr2

private int readAttr2()
               throws java.io.IOException

Deprecated.

[10] AttValue ::= '"' ([^<&"] | Reference)* '"' | "'" ([^<&'] | Reference)* "'" need to also handle unquoted attributes, and attributes w/o values:

Throws:

java.io.IOException

eatSSI

private int eatSSI()
            throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

readProcessingInstruction

private int readProcessingInstruction()
                               throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

read

public int read()
         throws java.io.IOException

Deprecated.

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

Deprecated.

Overrides:

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

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Deprecated.

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