com.univocity.api.entity.html

Interface HtmlParsingContext

All Superinterfaces:

com.univocity.parsers.common.Context

public interface HtmlParsingContext
extends com.univocity.parsers.common.Context

A class that returns information about HtmlParser’s parsing process.

Author:

uniVocity Software Pty Ltd - dev@univocity.com

See Also:

HtmlParser, Context, HtmlElement

Method Summary

Modifier and Type	Method and Description
Set<String>	binaryFields() Returns the names of the fields set to download content, i.e.
HtmlElement	currentElement() Returns the element that the parser is currently visiting.
int	currentNodeDepth() Returns the current node depth of the parser.
Object	documentSource() Returns the source of the current document being parsed.
String	entityName() Returns the name of the HTML entity that the HtmlParser is using to parse the HTML document.
File	getFile(String binaryFieldName) Returns the file that was last downloaded for a given binary field.
Map<String,HtmlElement[]>	getMatchedElements() Returns a Map of fields associated with the current sequence of HtmlElements that have been matched by the parser, i.e.
Map<String,String>	matchedData() Returns a Map of matched data where the value is the field name and the value is the data that was matched.
HtmlElement	pageRoot() Returns the root element of the HTML tree being processed by the parser.
com.univocity.parsers.common.ResultRecordMetaData	recordMetaData() Returns the metadata information associated with records produced by the current parsing process.
com.univocity.api.net.HttpResponse	response() If the HtmlParser is reading from a web page, returns the HttpResponse that it is using to process the input HTML.
HtmlRecord	toRecord(String[] row) Converts the given parsed row to a HtmlRecord

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

columnsReordered, currentColumn, currentRecord, errorContentLength, extractedFieldIndexes, headers, indexOf, indexOf, isStopped, selectedHeaders, stop

Method Detail

response

com.univocity.api.net.HttpResponse response()

If the HtmlParser is reading from a web page, returns the HttpResponse that it is using to process the input HTML. Otherwise it will return null.

Returns:

the HttpResponse that the parser is using, or null if parsing local file.

matchedData

Map<String,String> matchedData()

Returns a Map of matched data where the value is the field name and the value is the data that was matched. Values are matched when the HtmlParser encounters a value defined by a path set by an HtmlEntitySettings’ added field.

Returns:

a Map of data that was matched for the current record of the current HTML entity while parsing

getMatchedElements

Map<String,HtmlElement[]> getMatchedElements()

Returns a Map of fields associated with the current sequence of HtmlElements that have been matched by the parser, i.e. the parser collected a value for each field in this map.

Will only return a map with field names and their matched element sequence from inside an HtmlParserListener.elementMatched(HtmlElement, HtmlParsingContext) callback, otherwise an empty map will be returned.

Returns:

a Map of fields whose paths have been matched by a given HtmlElement.

entityName

String entityName()

Returns the name of the HTML entity that the HtmlParser is using to parse the HTML document.

Returns:

the name that identifies the HTML entity being used by the HtmlParser

currentNodeDepth

int currentNodeDepth()

Returns the current node depth of the parser. Node depth is how many layers deep the currently visited HTML element is. For example given a simple HTML document like: <div><span><span><div>. When the parser visits the span element, the current node depth would be 1 (the node depth of div would be 0).

Returns:

the depth of the currently visited HTML element

currentElement

HtmlElement currentElement()

Returns the element that the parser is currently visiting.

Returns:

the element that is currently being visited by the parser

pageRoot

HtmlElement pageRoot()

Returns the root element of the HTML tree being processed by the parser. Typically this is the <html> element.

Returns:

the root node of the document being processed

getFile

File getFile(String binaryFieldName)

Returns the file that was last downloaded for a given binary field. Binary fields are defined using FieldContentTransform.download().

Parameters:

binaryFieldName - name that identifies a field configured to download binary content.

Returns:

the last downloaded file for the given field

binaryFields

Set<String> binaryFields()

Returns the names of the fields set to download content, i.e. names of fields defined using FieldContentTransform.download()

Returns:

names of fields associated with downloaded content

toRecord

HtmlRecord toRecord(String[] row)

Converts the given parsed row to a HtmlRecord

Specified by:

toRecord in interface com.univocity.parsers.common.Context

Returns:

a HtmlRecord representing the given row.

recordMetaData

com.univocity.parsers.common.ResultRecordMetaData recordMetaData()

Returns the metadata information associated with records produced by the current parsing process.

Specified by:

recordMetaData in interface com.univocity.parsers.common.Context

Returns:

the record metadata.

documentSource

Object documentSource()

Returns the source of the current document being parsed. If running locally, will return the File whose contents are being read, if remote the UrlReaderProvider will be returned. Otherwise will return the given input back i.e. a Reader implementation, or the HtmlElement if the parser is running over a HTML tree.

Returns:

the source of the document being parsed.