com.univocity.api.entity.html

Class HtmlParserListener

java.lang.Object

com.univocity.api.entity.html.HtmlParserListener

public abstract class HtmlParserListener
extends Object

An abstract class that is used by the HtmlParser to provide information about events that occur during the parsing process.

Important:This listener is used in a concurrent environment. If you are assigning the same instance to multiple entities make sure your implementation is thread-safe, or limit the number of threads to be used when parsing to 1 with HtmlParserSettings.setParserThreadCount(int)

Author:

uniVocity Software Pty Ltd - dev@univocity.com

See Also:

HtmlParser, HtmlParsingContext, HtmlElement

Constructor Summary

Constructors

Constructor and Description
HtmlParserListener()

Method Summary

Modifier and Type	Method and Description
void	elementMatched(HtmlElement element, HtmlParsingContext context) A method that runs when a HTML element is matched based on the path set in the creation a field in the corresponding HtmlEntitySettings
void	elementVisited(HtmlElement element, HtmlParsingContext context) A method that runs every time the HtmlParser visits a HTML element on a HTML document.
void	parsingEnded(HtmlParsingContext context) A method that runs when the parsing process has ended.
void	parsingStarted(HtmlParsingContext context) A method that runs when the HtmlParser begins parsing a web page.

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlParserListener

public HtmlParserListener()

Method Detail

parsingStarted

public void parsingStarted(HtmlParsingContext context)

A method that runs when the HtmlParser begins parsing a web page. Note that if the current entity is associated with a HtmlLinkFollower this method will be called every time a new web page is opened by it.

Parameters:

context - the HtmlParsingContext used by the HtmlParser during the parsing process of a single web page.

elementVisited

public void elementVisited(HtmlElement element,
                           HtmlParsingContext context)

A method that runs every time the HtmlParser visits a HTML element on a HTML document.

Parameters:

element - the element that was visited. Note that only elements with tags are visited. Text nodes will not trigger the invocation of this method. Will be destroyed after parsingEnded(HtmlParsingContext) is called.

context - the HtmlParsingContext used by the HtmlParser during the parsing process

elementMatched

public void elementMatched(HtmlElement element,
                           HtmlParsingContext context)

A method that runs when a HTML element is matched based on the path set in the creation a field in the corresponding HtmlEntitySettings

Parameters:

element - the element that was matched. Will be destroyed after parsingEnded(HtmlParsingContext) is called.

context - the HtmlParsingContext used by the HtmlParser during the parsing process

parsingEnded

public void parsingEnded(HtmlParsingContext context)

A method that runs when the parsing process has ended. Note that if the current entity is associated with a HtmlLinkFollower this method will be called every time the processing over each linked web page stops. Any HtmlElement you may have collected from the other methods will be destroyed after this method executes.

Parameters:

context - the HtmlParsingContext used by the HtmlParser during the parsing process