Class BoilerpipeHTMLContentHandler

java.lang.Object

com.kohlschutter.boilerpipe.sax.BoilerpipeHTMLContentHandler

All Implemented Interfaces:

ContentHandler

public class BoilerpipeHTMLContentHandler
extends Object
implements ContentHandler

A simple SAX ContentHandler, used by BoilerpipeSAXInput. Can be used by different parser implementations, e.g. NekoHTML and TagSoup.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	BoilerpipeHTMLContentHandler.Event

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final String	ANCHOR_TEXT_END
(package private) static final String	ANCHOR_TEXT_START
(package private) int	blockTagLevel
private BitSet	currentContainedTextElements
private boolean	flush
(package private) LinkedList<Integer>	fontSizeStack
(package private) int	inAnchor
(package private) boolean	inAnchorText
(package private) int	inBody
(package private) int	inIgnorableElement
(package private) LinkedList<LinkedList<LabelAction>>	labelStacks
private String	lastEndTag
private BoilerpipeHTMLContentHandler.Event	lastEvent
private String	lastStartTag
private int	offsetBlocks
private static final Pattern	PAT_VALID_WORD_CHARACTER
(package private) boolean	sbLastWasWhitespace
private final Map<String, TagAction>	tagActions
(package private) int	tagLevel
private final List<TextBlock>	textBlocks
(package private) StringBuilder	textBuffer
private int	textElementIdx
private String	title
(package private) StringBuilder	tokenBuffer

Constructor Summary

Constructors

Constructor	Description
BoilerpipeHTMLContentHandler()	Constructs a BoilerpipeHTMLContentHandler using the DefaultTagActionMap.
BoilerpipeHTMLContentHandler(TagActionMap tagActions)	Constructs a BoilerpipeHTMLContentHandler using the given TagActionMap.

Method Summary

Modifier and Type	Method	Description
void	addLabelAction(LabelAction la)
protected void	addTextBlock(TextBlock tb)
void	addWhitespaceIfNecessary()
void	characters(char[] ch, int start, int length)
void	endDocument()
void	endElement(String uri, String localName, String qName)
void	endPrefixMapping(String prefix)
void	flushBlock()
(package private) List<TextBlock>	getTextBlocks()
String	getTitle()
void	ignorableWhitespace(char[] ch, int start, int length)
private static boolean	isWord(String token)
void	processingInstruction(String target, String data)
void	recycle()	Recycles this instance.
void	setDocumentLocator(Locator locator)
void	setTitle(String s)
void	skippedEntity(String name)
void	startDocument()
void	startElement(String uri, String localName, String qName, Attributes atts)
void	startPrefixMapping(String prefix, String uri)
TextDocument	toTextDocument()	Returns a TextDocument containing the extracted TextBlock s.

Methods inherited from class Object

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

Methods inherited from interface ContentHandler

declaration

Field Details

tagActions

private final Map<String, TagAction> tagActions

title

private String title

ANCHOR_TEXT_START

static final String ANCHOR_TEXT_START

See Also:

• Constant Field Values

ANCHOR_TEXT_END

static final String ANCHOR_TEXT_END

See Also:

• Constant Field Values

tokenBuffer

StringBuilder tokenBuffer

textBuffer

StringBuilder textBuffer

inBody

int inBody

inAnchor

int inAnchor

inIgnorableElement

int inIgnorableElement

tagLevel

int tagLevel

blockTagLevel

int blockTagLevel

sbLastWasWhitespace

boolean sbLastWasWhitespace

textElementIdx

private int textElementIdx

textBlocks

private final List<TextBlock> textBlocks

lastStartTag

private String lastStartTag

lastEndTag

private String lastEndTag

lastEvent

private BoilerpipeHTMLContentHandler.Event lastEvent

offsetBlocks

private int offsetBlocks

currentContainedTextElements

private BitSet currentContainedTextElements

flush

private boolean flush

inAnchorText

boolean inAnchorText

labelStacks

LinkedList<LinkedList<LabelAction>> labelStacks

fontSizeStack

LinkedList<Integer> fontSizeStack

PAT_VALID_WORD_CHARACTER

private static final Pattern PAT_VALID_WORD_CHARACTER

Constructor Details

BoilerpipeHTMLContentHandler

public BoilerpipeHTMLContentHandler()

Constructs a BoilerpipeHTMLContentHandler using the DefaultTagActionMap.

BoilerpipeHTMLContentHandler

public BoilerpipeHTMLContentHandler(TagActionMap tagActions)

Constructs a BoilerpipeHTMLContentHandler using the given TagActionMap.

Parameters:

tagActions - The TagActionMap to use, e.g. DefaultTagActionMap.

Method Details

recycle

public void recycle()

Recycles this instance.

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Throws:

SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Specified by:

endPrefixMapping in interface ContentHandler

Throws:

SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
 int start,
 int length)
                         throws SAXException

Specified by:

ignorableWhitespace in interface ContentHandler

Throws:

SAXException

processingInstruction

public void processingInstruction(String target,
 String data)
                           throws SAXException

Specified by:

processingInstruction in interface ContentHandler

Throws:

SAXException

setDocumentLocator

public void setDocumentLocator(Locator locator)

Specified by:

setDocumentLocator in interface ContentHandler

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

Specified by:

skippedEntity in interface ContentHandler

Throws:

SAXException

startDocument

public void startDocument()
                   throws SAXException

Specified by:

startDocument in interface ContentHandler

Throws:

SAXException

startPrefixMapping

public void startPrefixMapping(String prefix,
 String uri)
                        throws SAXException

Specified by:

startPrefixMapping in interface ContentHandler

Throws:

SAXException

startElement

public void startElement(String uri,
 String localName,
 String qName,
 Attributes atts)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Throws:

SAXException

endElement

public void endElement(String uri,
 String localName,
 String qName)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Throws:

SAXException

characters

public void characters(char[] ch,
 int start,
 int length)
                throws SAXException

Specified by:

characters in interface ContentHandler

Throws:

SAXException

getTextBlocks

List<TextBlock> getTextBlocks()

flushBlock

public void flushBlock()

addTextBlock

protected void addTextBlock(TextBlock tb)

isWord

private static boolean isWord(String token)

getTitle

public String getTitle()

setTitle

public void setTitle(String s)

toTextDocument

public TextDocument toTextDocument()

Returns a TextDocument containing the extracted TextBlock s. NOTE: Only call this after parsing.

Returns:

The TextDocument

addWhitespaceIfNecessary

public void addWhitespaceIfNecessary()

addLabelAction

public void addLabelAction(LabelAction la)
                    throws IllegalStateException

Throws:

IllegalStateException