com.univocity.api.entity.html

Interface HtmlParserInterface

All Superinterfaces:

com.univocity.parsers.common.EntityParserInterface<HtmlRecord,HtmlParsingContext,HtmlParserResult>, com.univocity.parsers.remote.RemoteEntityParserInterface<HtmlRecord,HtmlParsingContext,HtmlParserResult>

All Known Implementing Classes:

HtmlParser

public interface HtmlParserInterface
extends com.univocity.parsers.remote.RemoteEntityParserInterface<HtmlRecord,HtmlParsingContext,HtmlParserResult>

An extension of the EntityParserInterface to include all operations specific to the HtmlParser

Author:

uniVocity Software Pty Ltd - dev@univocity.com

Method Summary

Modifier and Type	Method and Description
HtmlPaginationContext	getPaginationContext() Returns the HtmlPaginationContext object with information collected for the configured HtmlPaginator, if any.
com.univocity.parsers.common.Results<HtmlParserResult>	parse(HtmlElement htmlTree) Given a HtmlElement, parses all records of all entities defined in the EntityList of this parser, and returns them in a map.

Methods inherited from interface com.univocity.parsers.common.EntityParserInterface

parse, parse, parse, parse, parse, parse, parse, parse, parse

Method Detail

parse

com.univocity.parsers.common.Results<HtmlParserResult> parse(HtmlElement htmlTree)

Given a HtmlElement, parses all records of all entities defined in the EntityList of this parser, and returns them in a map. Keys are the entity names and values are lists of Record produced for that entity.

Parameters:

htmlTree - the HTML tree with content to be parsed

Returns:

a map of entity names and the corresponding records extracted from the given HTML tree.

getPaginationContext

HtmlPaginationContext getPaginationContext()

Returns the HtmlPaginationContext object with information collected for the configured HtmlPaginator, if any. The information returned comes from the last input processed, and might have been modified by a NextInputHandler if it has been associated with the HtmlPaginator using Paginator.setPaginationHandler(NextInputHandler).

Specified by:

getPaginationContext in interface com.univocity.parsers.remote.RemoteEntityParserInterface<HtmlRecord,HtmlParsingContext,HtmlParserResult>

Returns:

the current PaginationContext with pagination information captured after parsing a given input.