com.univocity.api.entity.html

Class FetchOutput

java.lang.Object

com.univocity.api.entity.html.FetchOutput

public class FetchOutput
extends Object

The output produced by the HtmlElement.fetchResources(com.univocity.api.io.FileProvider, com.univocity.api.entity.html.FetchOptions) methods.

Author:

uniVocity Software Pty Ltd - dev@univocity.com

Constructor Summary

Constructors

Constructor and Description
FetchOutput(HtmlElement treeRoot, File treeHtmlFile, Map<File,URL> resourceMap) Creates a new FetchOutput with the results obtained from a call to HtmlElement.fetchResources(com.univocity.api.io.FileProvider, com.univocity.api.entity.html.FetchOptions)

Method Summary

Modifier and Type	Method and Description
Map<File,URL>	getResourceMap() Returns the mapping of each local File that has been downloaded to its original remote URL
File	getTreeHtmlFile() Returns File pointing to where the new HTML has been saved.
HtmlElement	getTreeRoot() Returns the root HtmlElement of the new HTML structure.

Methods inherited from class java.lang.Object

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

Constructor Detail

FetchOutput

public FetchOutput(HtmlElement treeRoot,
                   File treeHtmlFile,
                   Map<File,URL> resourceMap)

Creates a new FetchOutput with the results obtained from a call to HtmlElement.fetchResources(com.univocity.api.io.FileProvider, com.univocity.api.entity.html.FetchOptions)

Parameters:

treeRoot - the root of the HTML structure that had its resources fetched

treeHtmlFile - a File with the saved HTML content, with all resources pointing to local files.

resourceMap - the mapping of each local File that has been downloaded to its original remote URL

Method Detail

getTreeRoot

public HtmlElement getTreeRoot()

Returns the root HtmlElement of the new HTML structure.

For each remote resource downloaded the remote url has been replaced with the relative local file location.

Returns:

the root node of the HTML tree that has been fetched

getTreeHtmlFile

public File getTreeHtmlFile()

Returns File pointing to where the new HTML has been saved.

Returns:

file where the new HTML has been saved.

getResourceMap

public Map<File,URL> getResourceMap()

Returns the mapping of each local File that has been downloaded to its original remote URL

Returns:

a map of each local File that has been downloaded to its original remote URL