Skip navigation links
A B C D E F G H I L M N O P Q R S T U V W 

A

AbstractRowProcessor - Class in com.univocity.api.entity.html.processor
A RowProcessor implementation that just implements all methods defined by the interface.
AbstractRowProcessor() - Constructor for class com.univocity.api.entity.html.processor.AbstractRowProcessor
 
addField(String) - Method in interface com.univocity.api.entity.html.builders.FieldDefinition
Associates a regular field with an entity.
addField(String, String) - Method in interface com.univocity.api.entity.html.builders.FieldDefinition
Creates a field that with a specified value.
addField(String) - Method in interface com.univocity.api.entity.html.builders.PaginationGroup
Creates a new field on this PaginationGroup and returns a PathStart that allows the user to define a path to the field.
addField(String) - Method in class com.univocity.api.entity.html.HtmlEntitySettings
 
addField(String, String) - Method in class com.univocity.api.entity.html.HtmlEntitySettings
 
addField(String, String) - Method in class com.univocity.api.entity.html.HtmlLinkFollower
 
addField(String) - Method in class com.univocity.api.entity.html.HtmlLinkFollower
 
addField(String) - Method in class com.univocity.api.entity.html.HtmlPaginator
Creates a new field on this HtmlPaginator and returns a PathStart that allows the user to define a path to the field.
addPersistentField(String) - Method in interface com.univocity.api.entity.html.builders.FieldDefinition
Associates a persistent field with an entity.
addPersistentField(String) - Method in class com.univocity.api.entity.html.HtmlEntitySettings
 
addPersistentField(String) - Method in class com.univocity.api.entity.html.HtmlLinkFollower
 
addRecordTrigger() - Method in class com.univocity.api.entity.html.HtmlEntitySettings
Returns a RecordTriggerStart that is used to specify a path that defines when rows should be created.
addRequestParameter(String) - Method in interface com.univocity.api.entity.html.builders.PaginationParams
Creates a request parameter with the given name and returns a PathStart that is used to collect the value for this parameter from the current page.
addRequestParameter(String) - Method in class com.univocity.api.entity.html.HtmlPaginator
Creates a new request parameter and returns a PathStart that allows the user to define path to the parameter.
addSilentField(String) - Method in interface com.univocity.api.entity.html.builders.FieldDefinition
Associates a “silent” field with an entity.
addSilentField(String) - Method in class com.univocity.api.entity.html.HtmlEntitySettings
 
addSilentField(String) - Method in class com.univocity.api.entity.html.HtmlLinkFollower
 
assigning(String, Object) - Method in class com.univocity.api.entity.html.HtmlLinkFollower
 
assigning(String, ValueGetter<?>) - Method in class com.univocity.api.entity.html.HtmlLinkFollower
 
attribute(String, String) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should contain the given attribute name and value.
attribute(String) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should contain the given boolean attribute.
attribute(String) - Method in interface com.univocity.api.entity.html.HtmlElement
Returns an attribute value by its name as a String.
attributeNames() - Method in interface com.univocity.api.entity.html.HtmlElement
Returns all the attribute names contained within this element as a set of String.

B

baseUri() - Method in interface com.univocity.api.entity.html.DownloadContext
The current base URI associated with the document whose resources are being fetched.
BasicElementFilter<T extends BasicElementFilter<T>> - Interface in com.univocity.api.entity.html.builders
A BasicElementFilter establishes rules to select only those HTML elements that fit a certain criteria.
BatchedColumnProcessor - Class in com.univocity.api.entity.html.processor
A RowProcessor implementation that stores values of columns in batches.
BatchedColumnProcessor(int) - Constructor for class com.univocity.api.entity.html.processor.BatchedColumnProcessor
Constructs a batched column processor configured to invoke the AbstractBatchedColumnProcessor.batchesProcessed method after a given number of rows has been processed.
BatchedObjectColumnProcessor - Class in com.univocity.api.entity.html.processor
A RowProcessor implementation for converting batches of rows extracted from any implementation of HtmlParser into columns of objects.
BatchedObjectColumnProcessor(int) - Constructor for class com.univocity.api.entity.html.processor.BatchedObjectColumnProcessor
Constructs a batched column processor configured to invoke the AbstractBatchedObjectColumnProcessor.batchesProcessed method after a given number of rows has been processed.
BeanListProcessor<T> - Class in com.univocity.api.entity.html.processor
A convenience BeanProcessor implementation for storing all java objects generated form the parsed input into a list.
BeanListProcessor(Class<T>) - Constructor for class com.univocity.api.entity.html.processor.BeanListProcessor
Creates a processor that stores java beans of a given type into a list
BeanProcessor<T> - Class in com.univocity.api.entity.html.processor
A RowProcessor implementation for converting rows extracted from any implementation of HtmlParser into java objects.
BeanProcessor(Class<T>) - Constructor for class com.univocity.api.entity.html.processor.BeanProcessor
Creates a processor for java beans of a given type.
binaryFields() - Method in interface com.univocity.api.entity.html.HtmlParsingContext
Returns the names of the fields set to download content, i.e.

C

childOf(String) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should be a child of a given element.
children() - Method in interface com.univocity.api.entity.html.HtmlElement
Returns a copy of all children of this element in an array.
classes(String, String...) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should contain the given CSS class names.
classes() - Method in interface com.univocity.api.entity.html.HtmlElement
Returns the set of CSS classes of this element, or an empty set if has element has no class attribute defined.
clone() - Method in class com.univocity.api.entity.html.FetchOptions
 
clone() - Method in class com.univocity.api.entity.html.HtmlEntitySettings
 
clone() - Method in class com.univocity.api.entity.html.HtmlParserSettings
 
ColumnProcessor - Class in com.univocity.api.entity.html.processor
A simple RowProcessor implementation that stores values of columns.
ColumnProcessor() - Constructor for class com.univocity.api.entity.html.processor.ColumnProcessor
Constructs a column processor, pre-allocating room for 1000 rows.
ColumnProcessor(int) - Constructor for class com.univocity.api.entity.html.processor.ColumnProcessor
Constructs a column processor pre-allocating room for the expected number of rows to be processed
com.univocity.api.entity.html - package com.univocity.api.entity.html
 
com.univocity.api.entity.html.builders - package com.univocity.api.entity.html.builders
 
com.univocity.api.entity.html.builders.annotations - package com.univocity.api.entity.html.builders.annotations
 
com.univocity.api.entity.html.processor - package com.univocity.api.entity.html.processor
 
containedBy(String) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should be in the hierarchy of a given element.
containedBy(String, int) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should be in the hierarchy of a given element, up to a given limit of parent nodes to visit.
containing(String, String...) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should contain of one or more given elements in its hierarchy.
containing(String) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should contain a given element in its hierarchy.
containing(String, int) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should contain a given element in its hierarchy, provided it occurs within a given search depth.
containsElementInHierarchy(HtmlElement) - Method in interface com.univocity.api.entity.html.HtmlElement
Returns true if the specified element is a descendant of the current element.
ContentReader<T extends com.univocity.api.entity.html.builders.ContentHandler> - Interface in com.univocity.api.entity.html.builders
A ContentReader defines what content will be read from the last element matched in a FieldPath by the HtmlParser.
createGlobalSettings() - Method in class com.univocity.api.entity.html.HtmlParserSettings
 
currentElement() - Method in interface com.univocity.api.entity.html.HtmlParsingContext
Returns the element that the parser is currently visiting.
currentNodeDepth() - Method in interface com.univocity.api.entity.html.HtmlParsingContext
Returns the current node depth of the parser.

D

data() - Method in interface com.univocity.api.entity.html.HtmlElement
Get the data content of this element and all its children.
documentSource() - Method in interface com.univocity.api.entity.html.HtmlParsingContext
Returns the source of the current document being parsed.
download() - Method in interface com.univocity.api.entity.html.builders.FieldContentTransform
Specifies that the parser will download content from the URL in the HTML element defined by the path.
download(UrlReaderProvider) - Method in interface com.univocity.api.entity.html.builders.FieldContentTransform
Specifies that the parser will download content from the URL in the HTML element defined by the path.
DownloadContext - Interface in com.univocity.api.entity.html
Provides all information available during a “fetch resources” operation to a DownloadHandler callback, and allows the user to skip the download of certain file types.
DownloadHandler - Interface in com.univocity.api.entity.html
A callback interface for downloads handled by a “fetch resources” operation, which downloads all resources referenced by a given HTML input.
downloadSkipped() - Method in interface com.univocity.api.entity.html.DownloadContext
Returns a flag indicating that this download has been skipped .
downloadsStopped() - Method in interface com.univocity.api.entity.html.DownloadContext
Returns a flag indicating that all downloads have been stopped
downloadUrl() - Method in interface com.univocity.api.entity.html.DownloadContext
Returns the fully assembled URL pointing to a remote resource, which will be used to perform the download into the DownloadContext.targetFile().
downTo(String) - Method in interface com.univocity.api.entity.html.builders.UpDown
Establishes that the parser should look ‘down’ the page for the given element.
downToFooter(String) - Method in interface com.univocity.api.entity.html.builders.UpDown
Establishes that the parser should look ‘down’ the page for the given element that is in the same table column as the previously matched element.

E

ElementContentHandler - Interface in com.univocity.api.entity.html.builders
An ElementContentHandler allows values defined for capture by a ContentReader’s methods to be returned as actual values instead of needing to define an EntitySettings and retrieving them as a Result with rows.
ElementContentReader - Interface in com.univocity.api.entity.html.builders
An ElementContentReader allows the HtmlElements that match rules defined in the FieldPath to be acquired directly instead of capturing certain parts of them.
ElementFilter<T extends ElementFilter<T>> - Interface in com.univocity.api.entity.html.builders
An ElementFilter establishes rules to select only those HTML elements that fit a certain criteria, while also allowing the matching of elements under or above the current element matched by the parser.
ElementFilterStart<T extends ElementFilter<T>> - Interface in com.univocity.api.entity.html.builders
Provides the first step of an ElementFilter.
elementMatched(HtmlElement, HtmlParsingContext) - Method in class com.univocity.api.entity.html.HtmlParserListener
A method that runs when a HTML element is matched based on the path set in the creation a field in the corresponding HtmlEntitySettings
ElementPath - Interface in com.univocity.api.entity.html.builders
An ElementPath establishes rules to select only those HTML elements that fit a certain criteria, while also allowing the matching of elements under or above the current element matched by the parser.
ElementPathStart - Interface in com.univocity.api.entity.html.builders
The starting point of an ElementPath to match elements when HtmlElement.query() is called.
elementVisited(HtmlElement, HtmlParsingContext) - Method in class com.univocity.api.entity.html.HtmlParserListener
A method that runs every time the HtmlParser visits a HTML element on a HTML document.
endAt(String) - Method in interface com.univocity.api.entity.html.builders.PartialGroup
Defines the HTML element where a Group will end.
endAt(String) - Method in interface com.univocity.api.entity.html.builders.PartialPaginationGroup
Defines the HTML element where a PaginationGroup will end.
endAtClosing(String) - Method in interface com.univocity.api.entity.html.builders.PartialGroup
Defines the closing HTML element (such as </table>, </div>, etc) where the Group will end and includes this closing element into the group.
endAtClosing(String) - Method in interface com.univocity.api.entity.html.builders.PartialPaginationGroup
Defines the HTML element where a PaginationGroup will end and includes this closing element into the group.
entityName() - Method in interface com.univocity.api.entity.html.HtmlParsingContext
Returns the name of the HTML entity that the HtmlParser is using to parse the HTML document.

F

FetchOptions - Class in com.univocity.api.entity.html
Configuration class for use in the HtmlElement.fetchResources(com.univocity.api.io.FileProvider, com.univocity.api.entity.html.FetchOptions) methods Setters return this instance to enable method chaining during initialization.
FetchOptions() - Constructor for class com.univocity.api.entity.html.FetchOptions
Default constructor for FetchOptions Defaults to not flattening directory and accepting any String
FetchOutput - Class in com.univocity.api.entity.html
FetchOutput(HtmlElement, File, Map<File, URL>) - Constructor for class com.univocity.api.entity.html.FetchOutput
fetchResources(FileProvider, FetchOptions) - Method in interface com.univocity.api.entity.html.HtmlElement
Saves the element to a local file using the FileProvider, searching all child nodes for external resources (e.g.
fetchResources(File, FetchOptions) - Method in interface com.univocity.api.entity.html.HtmlElement
Save the element to a local file using the File, searching all child nodes for external resources (e.g.
fetchResources(File, String, FetchOptions) - Method in interface com.univocity.api.entity.html.HtmlElement
Save the element to a local file using the File, searching all child nodes for external resources (e.g.
fetchResources(File, Charset, FetchOptions) - Method in interface com.univocity.api.entity.html.HtmlElement
Save the element to a local file using the File, searching all child nodes for external resources (e.g.
fetchResources(String, FetchOptions) - Method in interface com.univocity.api.entity.html.HtmlElement
Save the element to a local file at the path pathToFile, searching all child nodes for external resources (e.g.
fetchResources(String, String, FetchOptions) - Method in interface com.univocity.api.entity.html.HtmlElement
Save the element a local file at the path pathToFile, searching all child nodes for external resources (e.g.
fetchResources(String, Charset, FetchOptions) - Method in interface com.univocity.api.entity.html.HtmlElement
Save the element to a local file at the path pathToFile, searching all child nodes for external resources (e.g.
fetchResourcesBeforeParsing(FetchOptions) - Method in class com.univocity.api.entity.html.HtmlParserSettings
 
fetchResourcesBeforeParsingEnabled() - Method in class com.univocity.api.entity.html.HtmlParserSettings
 
FieldContentTransform - Interface in com.univocity.api.entity.html.builders
Allows the content captured for a given field, by a ContentReader, to be transformed by a StringTransformation to clean up or transform values or to obtain very specific textual content from the original value.
FieldDefinition - Interface in com.univocity.api.entity.html.builders
Provides the options available for adding fields into a HTML entity, which are defined with the help of HtmlEntitySettings, a Group or a PartialPath associated with the given entity.
FieldPath - Interface in com.univocity.api.entity.html.builders
A path to a field of an entity.
filter(HtmlElementMatcher) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should pass the supplied filter method using a HtmlElementMatcher.match(HtmlElement, HtmlElement).
flattenDirectories(boolean) - Method in class com.univocity.api.entity.html.FetchOptions
Option to flatten the path section of a fetched resource into the new filename.
flattenDirectoryStructure() - Method in class com.univocity.api.entity.html.FetchOptions
Whether or not the resource filenames should be ‘flattened’.
followedBy(String) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should have a given element placed after it, at any distance.
followedBy(String, int) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should have a given element at a given distance after it.
followedByText(String) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element must have a given text placed in an element before it.
followedImmediatelyBy(String) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should have a given element placed directly after it.
followLink() - Method in interface com.univocity.api.entity.html.builders.FieldContentTransform
Creates a HtmlLinkFollower that will parse linked pages, each linked page URL is defined by the values retrieved by this field.
followLink(UrlReaderProvider) - Method in interface com.univocity.api.entity.html.builders.FieldContentTransform
Creates a HtmlLinkFollower that will parse linked pages, each linked page URL is defined by inserting the value retrieved by this field into the supplied UrlReaderProvider as a parameter.
followLink(String, UrlReaderProvider) - Method in class com.univocity.api.entity.html.HtmlEntitySettings
Creates a HtmlLinkFollower a field with the name provided.

G

getAttribute(String) - Method in interface com.univocity.api.entity.html.builders.ContentReader
Captures the value of an attribute of the HTML elements matched by the path.
getBaseUri() - Method in class com.univocity.api.entity.html.FetchOptions
The current base URI associated with the document whose resources are being fetched.
getCurrentPageRoot() - Method in interface com.univocity.api.entity.html.HtmlPaginationContext
Returns the root element of the HTML tree being processed by the parser.
getDefaultFileExtension() - Method in class com.univocity.api.entity.html.HtmlParserSettings
 
getDownloadHandler() - Method in class com.univocity.api.entity.html.FetchOptions
Returns the DownloadHandler callback to be used by the fetch resources operation.
getElement(HtmlElementTransformation) - Method in interface com.univocity.api.entity.html.builders.ContentReader
Gets the HtmlElement described by the path and passes it to a custom Transformation.transform(Object).
getElement() - Method in interface com.univocity.api.entity.html.builders.ElementContentReader
Gets the first matching HtmlElement when applying the previously defined matching rules.
getElements() - Method in interface com.univocity.api.entity.html.builders.ElementContentReader
Gets all matching HtmlElements when applying the previously defined matching rules.
getFetchOptions() - Method in class com.univocity.api.entity.html.HtmlParserSettings
 
getFieldNames() - Method in class com.univocity.api.entity.html.HtmlEntitySettings
 
getFile(String) - Method in interface com.univocity.api.entity.html.HtmlParsingContext
Returns the file that was last downloaded for a given binary field.
getFollowingText() - Method in interface com.univocity.api.entity.html.builders.ContentReader
Gets the text from the HTML element that is placed directly after the HTML elements matched by the path.
getFollowingText(int) - Method in interface com.univocity.api.entity.html.builders.ContentReader
Gets the text from the specified number of HTMl elements following the HTML element matched by the path.
getHeadingText() - Method in interface com.univocity.api.entity.html.builders.ContentReader
Used to get the text of a table header above a matched element.
getHeadingText(int) - Method in interface com.univocity.api.entity.html.builders.ContentReader
Captures the text in the same column of the matched element, but in another row of the same table.
getInternalSettings() - Method in class com.univocity.api.entity.html.HtmlEntitySettings
 
getLinkedEntityData(int) - Method in interface com.univocity.api.entity.html.HtmlParserResult
 
getLinkedEntityData() - Method in interface com.univocity.api.entity.html.HtmlRecord
 
getLinkedFieldData(int) - Method in interface com.univocity.api.entity.html.HtmlParserResult
 
getLinkedFieldData() - Method in interface com.univocity.api.entity.html.HtmlRecord
 
getListener() - Method in class com.univocity.api.entity.html.HtmlEntitySettings
Returns the HtmlParserListener associated with this HTML entity.
getMatchedElements() - Method in interface com.univocity.api.entity.html.HtmlParsingContext
Returns a Map of fields associated with the current sequence of HtmlElements that have been matched by the parser, i.e.
getOwnText() - Method in interface com.univocity.api.entity.html.builders.ContentReader
Specifies that the parser will return the text from HTML element specified by the path without including the text of its child nodes.
getPaginationContext() - Method in class com.univocity.api.entity.html.HtmlParser
Returns the HtmlPaginationContext object with information collected for the configured HtmlPaginator, if any.
getPaginationContext() - Method in interface com.univocity.api.entity.html.HtmlParserInterface
Returns the HtmlPaginationContext object with information collected for the configured HtmlPaginator, if any.
getPaginator() - Method in class com.univocity.api.entity.html.HtmlEntityList
Returns the HtmlPaginator associated with the HtmlParserSettings of this HtmlEntityList
getPaginator() - Method in class com.univocity.api.entity.html.HtmlLinkFollower
Returns the HtmlPaginator associated with the HtmlParserSettings of this HtmlEntityList
getPaginator() - Method in class com.univocity.api.entity.html.HtmlParserSettings
Returns the HtmlPaginator associated with this HtmlParserSettings
getParserSettings() - Method in class com.univocity.api.entity.html.HtmlEntityList
 
getParserThreadCount() - Method in class com.univocity.api.entity.html.HtmlParserSettings
Returns the maximum number of threads used by the parser when processing data of multiple entities from the same HTML input.
getPrecedingText() - Method in interface com.univocity.api.entity.html.builders.ContentReader
Specifies that the parser will return the text from the node that appears before the HTML element specified by the path.
getPrecedingText(int) - Method in interface com.univocity.api.entity.html.builders.ContentReader
Collects the text from the specified number of HTML elements placed before the element that is matched by the path.
getRemoteInterval() - Method in class com.univocity.api.entity.html.FetchOptions
Returns the minimum interval of time to wait between each download request.
getResourceMap() - Method in class com.univocity.api.entity.html.FetchOutput
Returns the mapping of each local File that has been downloaded to its original remote URL
getSharedResourceDir() - Method in class com.univocity.api.entity.html.FetchOptions
Returns the shared resource directory used to store files referenced by one or more HTML pages and CSS files.
getText() - Method in interface com.univocity.api.entity.html.builders.ContentReader
Specifies that the parser will return the text contained within the HTML element defined by the path.
getText(int) - Method in interface com.univocity.api.entity.html.builders.ContentReader
Specifies that the parser will return the text contained within the HTML elements matched by the path in addition to the text in the specified amount of following siblings.
getTextAbove() - Method in interface com.univocity.api.entity.html.builders.ContentReader
Captures the text contained in the row and column above the HTML element matched by the path.
getTextAbove(int) - Method in interface com.univocity.api.entity.html.builders.ContentReader
Specifies that the parser will return the text contained in the HTML element at a given distance above a matched element.
getTextAbove(String, String...) - Method in interface com.univocity.api.entity.html.builders.ContentReader
Specifies that the parser will return the content of a row, given it contains some expected text, above a matched element.
getTreeHtmlFile() - Method in class com.univocity.api.entity.html.FetchOutput
Returns File pointing to where the new HTML has been saved.
getTreeRoot() - Method in class com.univocity.api.entity.html.FetchOutput
Returns the root HtmlElement of the new HTML structure.
getValue() - Method in interface com.univocity.api.entity.html.builders.ElementContentHandler
Get the first value from the first node matched using a specific ElementPath.
getValues() - Method in interface com.univocity.api.entity.html.builders.ElementContentHandler
Get all values from the nodes matched using a specific ElementPath.
Group - Interface in com.univocity.api.entity.html.builders
A group defines the boundaries where a given set of fields should be processed.
GroupStart - Interface in com.univocity.api.entity.html.builders
Defines the first step in the creation of a Group.

H

HTML_PARSER - Static variable in class com.univocity.api.entity.html.Loggers
Logger for operations involving the parsing of HTML
HtmlElement - Interface in com.univocity.api.entity.html
A HtmlElement contains information about HTML elements collected by the parser
HtmlElementMatcher - Interface in com.univocity.api.entity.html
A custom matcher to be triggered each time the parser visits a HtmlElement.
HtmlElementTransformation - Interface in com.univocity.api.entity.html
A transformation operation over a HtmlElement, that results in a String
HtmlEntityList - Class in com.univocity.api.entity.html
Manages a list of HTML entities and their HtmlEntitySettings.
HtmlEntityList() - Constructor for class com.univocity.api.entity.html.HtmlEntityList
Creates a new, empty HtmlEntityList, with a default global HtmlParserSettings configuration, which is used to provide defaults to all entity-specific settings in this list.
HtmlEntityList(HtmlParserSettings) - Constructor for class com.univocity.api.entity.html.HtmlEntityList
Creates a new, empty HtmlEntityList, applying the global HtmlParserSettings configuration, which is used to provide defaults to all entity-specific settings in this list.
HtmlEntitySettings - Class in com.univocity.api.entity.html
A HtmlEntitySettings object manages the configuration of a HTML entity.
HtmlLinkFollower - Class in com.univocity.api.entity.html
A class that allows the addition of fields which are used by the HtmlParser to parse and return information from a linked page.
HtmlLinkFollower(HtmlEntitySettings) - Constructor for class com.univocity.api.entity.html.HtmlLinkFollower
Creates a HtmlLinkFollower using parentEntitySettings as a basis for the settings
HtmlPaginationContext - Interface in com.univocity.api.entity.html
Contains information about the pagination process managed by a HtmlPaginator and made available to the user through the NextInputHandler callback.
HtmlPaginator - Class in com.univocity.api.entity.html
Used by the HtmlParser to collect multiple pages of results in a website and to handle the files that have been downloaded for each page.
HtmlPaginator(HtmlParserSettings) - Constructor for class com.univocity.api.entity.html.HtmlPaginator
Creates a new HtmlPaginator and sets the currentPageNumber to 0
HtmlParser - Class in com.univocity.api.entity.html
A very fast HTML parser.
HtmlParser(HtmlEntityList) - Constructor for class com.univocity.api.entity.html.HtmlParser
Creates a new HtmlParser with the entity configuration provided by a HtmlEntityList.
HtmlParserInterface - Interface in com.univocity.api.entity.html
An extension of the EntityParserInterface to include all operations specific to the HtmlParser
HtmlParserListener - Class in com.univocity.api.entity.html
An abstract class that is used by the HtmlParser to provide information about events that occur during the parsing process.
HtmlParserListener() - Constructor for class com.univocity.api.entity.html.HtmlParserListener
 
HtmlParserResult - Interface in com.univocity.api.entity.html
Stores the results of parsing some input with the HtmlParser parser.
HtmlParserSettings - Class in com.univocity.api.entity.html
Configuration class for the HtmlParser.
HtmlParserSettings() - Constructor for class com.univocity.api.entity.html.HtmlParserSettings
Creates a new HtmlParserSettings, which will process an input to produce records for entities defined by a HtmlEntityList.
HtmlParsingContext - Interface in com.univocity.api.entity.html
A class that returns information about HtmlParser’s parsing process.
HtmlRecord - Interface in com.univocity.api.entity.html
A HtmlRecord is a record that can be linked with one more more HtmlRecords.
HtmlTreeParser - Interface in com.univocity.api.entity.html
A parser that generates a tree of HtmlElements.

I

id(String) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should contain an id attribute with a given value.
id() - Method in interface com.univocity.api.entity.html.HtmlElement
Returns the id of this element or an empty String if the element does not have an id attribute.
inputValues() - Method in interface com.univocity.api.entity.html.HtmlElement
Runs through the hierarchy of this element and collects the values of any input elements, including select lists, radio buttons and checkboxes.
inputValuesById() - Method in interface com.univocity.api.entity.html.HtmlElement
Runs through the hierarchy of this element and collects the values of any input elements, including select lists, radio buttons and checkboxes.
InputValueSwitch - Class in com.univocity.api.entity.html.processor
A concrete implementation of RowProcessorSwitch that allows switching among different implementations of RowProcessor based on values found on the rows parsed from the input.
InputValueSwitch() - Constructor for class com.univocity.api.entity.html.processor.InputValueSwitch
Creates a switch that will analyze the first column of rows found in the input to determine which RowProcessor to use for each parsed row
InputValueSwitch(int) - Constructor for class com.univocity.api.entity.html.processor.InputValueSwitch
Creates a switch that will analyze a column of rows parsed from the input to determine which RowProcessor to use.
InputValueSwitch(String) - Constructor for class com.univocity.api.entity.html.processor.InputValueSwitch
Creates a switch that will analyze a column in rows parsed from the input to determine which RowProcessor to use.
isComment() - Method in interface com.univocity.api.entity.html.HtmlElement
Returns true if this HtmlElement consists of comments, i.e.
isData() - Method in interface com.univocity.api.entity.html.HtmlElement
Returns true if this HtmlElement consists of data, i.e.
isDownloadBlacklistingEnabled() - Method in class com.univocity.api.entity.html.FetchOptions
Indicates whether URLs of resources that resulted in a download failure (such as a 404) should be blacklisted while the parser is running, so no further attempts to access the same URL will be made.
isOverwriteSharedResources() - Method in class com.univocity.api.entity.html.FetchOptions
Returns a flag indicating whether resources that have been downloaded and are shared among multiple pages should be overwritten during a new fetch resources operation.
isText() - Method in interface com.univocity.api.entity.html.HtmlElement
Returns true if this HtmlElement consists solely of text and false otherwise.

L

Loggers - Class in com.univocity.api.entity.html
Loggers used by the HTML parser
Loggers() - Constructor for class com.univocity.api.entity.html.Loggers
 

M

MasterDetailListProcessor - Class in com.univocity.api.entity.html.processor
A convenience MasterDetailProcessor implementation for storing all MasterDetailRecord generated form the parsed input into a list.
MasterDetailListProcessor(RowPlacement, AbstractObjectListProcessor) - Constructor for class com.univocity.api.entity.html.processor.MasterDetailListProcessor
Creates a MasterDetailListProcessor
MasterDetailListProcessor(AbstractObjectListProcessor) - Constructor for class com.univocity.api.entity.html.processor.MasterDetailListProcessor
Creates a MasterDetailListProcessor
MasterDetailProcessor - Class in com.univocity.api.entity.html.processor
A RowProcessor implementation for associating rows extracted from any implementation of HtmlParser into MasterDetailRecord instances.
MasterDetailProcessor(RowPlacement, ObjectRowListProcessor) - Constructor for class com.univocity.api.entity.html.processor.MasterDetailProcessor
Creates a MasterDetailProcessor
MasterDetailProcessor(ObjectRowListProcessor) - Constructor for class com.univocity.api.entity.html.processor.MasterDetailProcessor
Creates a MasterDetailProcessor.
match(String) - Method in interface com.univocity.api.entity.html.builders.ElementFilterStart
Matches a given tag name at any distance from the current element.
match(String, int) - Method in interface com.univocity.api.entity.html.builders.ElementFilterStart
Matches a given tag name and its occurrence index among neighboring nodes within the same parent.
match(HtmlElementMatcher) - Method in interface com.univocity.api.entity.html.builders.ElementFilterStart
Specifies what element the parser must match based on the return value supplied by the given HtmlElementMatcher.
match(HtmlElement, HtmlElement) - Method in interface com.univocity.api.entity.html.HtmlElementMatcher
Used to determine if the currentElement should be matched by the parser.
matchCurrent() - Method in interface com.univocity.api.entity.html.builders.ElementFilterStart
Matches the current node defined in the path.
matchedData() - Method in interface com.univocity.api.entity.html.HtmlParsingContext
Returns a Map of matched data where the value is the field name and the value is the data that was matched.
Matcher - Annotation Type in com.univocity.api.entity.html.builders.annotations
Basic annotation used internally to classify methods of the public API based on their purpose.
Matcher.Type - Enum in com.univocity.api.entity.html.builders.annotations
The general type of matching algorithm associated with the method.
matchFirst(String) - Method in interface com.univocity.api.entity.html.builders.ElementFilterStart
Matches the first occurrence of the given tag name among neighboring nodes within the same parent.
matchLast(String) - Method in interface com.univocity.api.entity.html.builders.ElementFilterStart
Matches the last occurrence of the given tag name among neighboring nodes within the same parent.
matchNext(String) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Matches an element that must immediately follow the previously matched element, i.e.
MultiBeanListProcessor - Class in com.univocity.api.entity.html.processor
A RowProcessor implementation for converting rows extracted from the HtmlParser into java objects, storing them into lists.
MultiBeanListProcessor(Class...) - Constructor for class com.univocity.api.entity.html.processor.MultiBeanListProcessor
Creates a processor for java beans of multiple types
MultiBeanProcessor - Class in com.univocity.api.entity.html.processor
A RowProcessor implementation for converting rows extracted from any implementation of HtmlParser into java objects.
MultiBeanProcessor(Class...) - Constructor for class com.univocity.api.entity.html.processor.MultiBeanProcessor
Creates a processor for java beans of multiple types
MultiBeanRowProcessor - Class in com.univocity.api.entity.html.processor
A RowProcessor implementation for converting rows extracted by the HtmlParser into java objects.
MultiBeanRowProcessor(Class...) - Constructor for class com.univocity.api.entity.html.processor.MultiBeanRowProcessor
Creates a processor for java beans of multiple types

N

newEntity(String, HtmlEntitySettings) - Method in class com.univocity.api.entity.html.HtmlEntityList
Creates a new HtmlEntitySettings for an entity with the supplied name and returns it.
newEntitySettings(RemoteParserSettings) - Method in class com.univocity.api.entity.html.HtmlPaginator
Creates a new HtmlEntitySettings which will be used to create fields specifically for this HtmlPaginator.
newGroup() - Method in class com.univocity.api.entity.html.HtmlEntitySettings
Returns a GroupStart that allows for a Group to be defined.
newGroup() - Method in class com.univocity.api.entity.html.HtmlLinkFollower
Returns a GroupStart that allows for a Group to be defined.
newGroup() - Method in class com.univocity.api.entity.html.HtmlPaginator
Creates a new PaginationGroup group for this paginator.
newInstance() - Method in class com.univocity.api.entity.html.HtmlEntityList
 
newPaginator(RemoteParserSettings) - Method in class com.univocity.api.entity.html.HtmlParserSettings
Creates a new HtmlPaginator and returns it.
newPath() - Method in class com.univocity.api.entity.html.HtmlEntitySettings
Returns a PartialPathStart that is used to define a reusable path of HTML elements.
newPath() - Method in class com.univocity.api.entity.html.HtmlLinkFollower
Returns a PartialPathStart that is used to define a reusable path of HTML elements.
newPath() - Method in class com.univocity.api.entity.html.HtmlPaginator
Returns a PartialPathStart that is used to define a reusable path of HTML elements.
nextDownload(DownloadContext) - Method in interface com.univocity.api.entity.html.DownloadHandler
Informs the user that a resource is ready to be downloaded.
nextSibling() - Method in interface com.univocity.api.entity.html.HtmlElement
Returns the HtmlElement that is located just after this element.
not() - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Negates the very next filter.

O

ObjectColumnProcessor - Class in com.univocity.api.entity.html.processor
A RowProcessor implementation for converting rows extracted by the HtmlParser into columns of objects.
ObjectColumnProcessor() - Constructor for class com.univocity.api.entity.html.processor.ObjectColumnProcessor
Constructs a column processor, pre-allocating room for 1000 rows.
ObjectColumnProcessor(int) - Constructor for class com.univocity.api.entity.html.processor.ObjectColumnProcessor
Constructs a column processor pre-allocating room for the expected number of rows to be processed
ObjectRowListProcessor - Class in com.univocity.api.entity.html.processor
A convenience RowProcessor implementation for storing all rows parsed and converted to Object arrays into a list.
ObjectRowListProcessor() - Constructor for class com.univocity.api.entity.html.processor.ObjectRowListProcessor
 
ObjectRowProcessor - Class in com.univocity.api.entity.html.processor
A RowProcessor implementation for converting rows extracted by the HtmlParser into arrays of objects.
ObjectRowProcessor() - Constructor for class com.univocity.api.entity.html.processor.ObjectRowProcessor
 
originalDownloadLink() - Method in interface com.univocity.api.entity.html.DownloadContext
Returns the original link extracted from the HTML or CSS file.

P

pageRoot() - Method in interface com.univocity.api.entity.html.HtmlParsingContext
Returns the root element of the HTML tree being processed by the parser.
PaginationGroup - Interface in com.univocity.api.entity.html.builders
A special purpose Group-like structure, used only for HtmlPaginators.
PaginationGroupStart - Interface in com.univocity.api.entity.html.builders
This class defines the first step in the creation of a PaginationGroup.
PaginationParams - Interface in com.univocity.api.entity.html.builders
Methods to enable the specification of internal fields of the HtmlPaginator.
PaginationPath - Interface in com.univocity.api.entity.html.builders
A PaginationPath can be created from an entity using HtmlPaginator.newPath() or from a PaginationGroup using PathCopy.copyPath().
PaginationPathStart - Interface in com.univocity.api.entity.html.builders
Provides the start of a PaginationPath.
parent() - Method in interface com.univocity.api.entity.html.HtmlElement
Returns the parent of this Element.
parentCssFile() - Method in interface com.univocity.api.entity.html.DownloadContext
Returns the CSS file that is going to be updated after the fetch resources operation is complete.
parentDir() - Method in interface com.univocity.api.entity.html.DownloadContext
The directory where the DownloadContext.parentHtmlFile() is located.
parentHtmlFile() - Method in interface com.univocity.api.entity.html.DownloadContext
Returns the HTML file that is going to be updated/generated after the fetch resources operation is complete.
parentOf(String) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should be the parent of a given element.
parse(ReaderProvider) - Method in class com.univocity.api.entity.html.HtmlParser
Given an input, made available from a ReaderProvider, parses all records of all entities defined in the HtmlEntityList of the HtmlParserSettings object provided in the constructor of this class, submitting them to the Processor implementation associated with each entity (through EntitySettings.setProcessor(Processor).
parse(FileProvider) - Method in class com.univocity.api.entity.html.HtmlParser
Given an input, made available from a FileProvider, parses all records of all entities defined in the HtmlEntityList of the HtmlParserSettings object provided in the constructor of this class, submitting them to the Processor implementation associated with each entity (through EntitySettings.setProcessor(Processor).
parse(File) - Method in class com.univocity.api.entity.html.HtmlParser
Given a File, parses all records of all entities defined in the HtmlEntityList of the HtmlParserSettings object provided in the constructor of this class, submitting them to the Processor implementation associated with each entity (through EntitySettings.setProcessor(Processor).
parse(File, Charset) - Method in class com.univocity.api.entity.html.HtmlParser
Given a File, parses all records of all entities defined in the HtmlEntityList of the HtmlParserSettings object provided in the constructor of this class, submitting them to the Processor implementation associated with each entity (through EntitySettings.setProcessor(Processor).
parse(File, String) - Method in class com.univocity.api.entity.html.HtmlParser
Given a File, parses all records of all entities defined in the HtmlEntityList of the HtmlParserSettings object provided in the constructor of this class, submitting them to the Processor implementation associated with each entity (through EntitySettings.setProcessor(Processor).
parse(Reader) - Method in class com.univocity.api.entity.html.HtmlParser
Given a Reader, parses all records of all entities defined in the HtmlEntityList of the HtmlParserSettings object provided in the constructor of this class, submitting them to the Processor implementation associated with each entity (through EntitySettings.setProcessor(Processor).
parse(InputStream) - Method in class com.univocity.api.entity.html.HtmlParser
Given an InputStream, parses all records of all entities defined in the HtmlEntityList of the HtmlParserSettings object provided in the constructor of this class, submitting them to the Processor implementation associated with each entity (through EntitySettings.setProcessor(Processor).
parse(InputStream, Charset) - Method in class com.univocity.api.entity.html.HtmlParser
Given an InputStream, parses all records of all entities defined in the HtmlEntityList of the HtmlParserSettings object provided in the constructor of this class, submitting them to the Processor implementation associated with each entity (through EntitySettings.setProcessor(Processor).
parse(InputStream, String) - Method in class com.univocity.api.entity.html.HtmlParser
Given an InputStream, parses all records of all entities defined in the HtmlEntityList of the HtmlParserSettings object provided in the constructor of this class, submitting them to the Processor implementation associated with each entity (through EntitySettings.setProcessor(Processor).
parse(HtmlElement) - Method in class com.univocity.api.entity.html.HtmlParser
Given a HtmlElement, parses all records of all entities defined in the EntityList of this parser, submitting them to the Processor implementation associated with each entity (through EntitySettings.setProcessor(Processor).
parse(HtmlElement) - Method in interface com.univocity.api.entity.html.HtmlParserInterface
Given a HtmlElement, parses all records of all entities defined in the EntityList of this parser, and returns them in a map.
parseTree(ReaderProvider) - Static method in class com.univocity.api.entity.html.HtmlParser
Generates a DOM tree from the input made available by a ReaderProvider.
parseTree(FileProvider) - Static method in class com.univocity.api.entity.html.HtmlParser
Generates a DOM tree from the input made available by a FileProvider.
parseTree(Reader) - Static method in class com.univocity.api.entity.html.HtmlParser
Generates a DOM tree from the input made available by a Reader.
parseTree(InputStream) - Static method in class com.univocity.api.entity.html.HtmlParser
Generates a DOM tree from the input made available by a InputStream.
parseTree(InputStream, Charset) - Static method in class com.univocity.api.entity.html.HtmlParser
Generates a DOM tree from the input made available by a InputStream.
parseTree(InputStream, String) - Static method in class com.univocity.api.entity.html.HtmlParser
Generates a DOM tree from the input made available by a InputStream.
parseTree(File) - Static method in class com.univocity.api.entity.html.HtmlParser
Generates a DOM tree from the input made available by a File.
parseTree(File, Charset) - Static method in class com.univocity.api.entity.html.HtmlParser
Generates a DOM tree from the input made available by a File.
parseTree(File, String) - Static method in class com.univocity.api.entity.html.HtmlParser
Generates a DOM tree from the input made available by a File.
parseTree(ReaderProvider) - Method in interface com.univocity.api.entity.html.HtmlTreeParser
Generates a HTML tree from the input made available by a ReaderProvider.
parseTree(FileProvider) - Method in interface com.univocity.api.entity.html.HtmlTreeParser
Generates a HTML tree from the input made available by a FileProvider.
parseTree(Reader) - Method in interface com.univocity.api.entity.html.HtmlTreeParser
Generates a HTML tree from the input made available by a Reader.
parseTree(InputStream) - Method in interface com.univocity.api.entity.html.HtmlTreeParser
Generates a HTML tree from the input made available by a InputStream.
parseTree(InputStream, Charset) - Method in interface com.univocity.api.entity.html.HtmlTreeParser
Generates a HTML tree from the input made available by a InputStream.
parseTree(InputStream, String) - Method in interface com.univocity.api.entity.html.HtmlTreeParser
Generates a HTML tree from the input made available by a InputStream.
parseTree(File) - Method in interface com.univocity.api.entity.html.HtmlTreeParser
Generates a HTML tree from the input made available by a File.
parseTree(File, Charset) - Method in interface com.univocity.api.entity.html.HtmlTreeParser
Generates a HTML tree from the input made available by a File.
parseTree(File, String) - Method in interface com.univocity.api.entity.html.HtmlTreeParser
Generates a HTML tree from the input made available by a File.
parsingEnded(HtmlParsingContext) - Method in class com.univocity.api.entity.html.HtmlParserListener
A method that runs when the parsing process has ended.
parsingStarted(HtmlParsingContext) - Method in class com.univocity.api.entity.html.HtmlParserListener
A method that runs when the HtmlParser begins parsing a web page.
PartialGroup - Interface in com.univocity.api.entity.html.builders
Allows further specification of exactly which element a Group starts at, as well as where the group will end.
PartialPaginationGroup - Interface in com.univocity.api.entity.html.builders
A class that allows further specification of exactly which element the PartialPaginationGroup starts at, as well as where the group will end.
PartialPath - Interface in com.univocity.api.entity.html.builders
A PartialPath can be created from an entity using HtmlEntitySettings.newPath() or from an entity’s group, using PathCopy.copyPath().
PartialPathStart - Interface in com.univocity.api.entity.html.builders
Provides the start of a PartialPath.
PathStart - Interface in com.univocity.api.entity.html.builders
Provides the start of a FieldPath.
precededBy(String) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should have a given element placed before it, at any distance.
precededBy(String, int) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should have a given element at a given distance before it.
precededByText(String) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element must have a given text placed in an element after it.
precededImmediatelyBy(String) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should have a given element placed directly before it.
previousSibling() - Method in interface com.univocity.api.entity.html.HtmlElement
Returns the HtmlElement that is located just before this element.
processEnded(HtmlParsingContext) - Method in interface com.univocity.api.entity.html.processor.RowProcessor
This method will by invoked by the parser once, after the parsing process stopped and all resources were closed.
processStarted(HtmlParsingContext) - Method in interface com.univocity.api.entity.html.processor.RowProcessor
This method will by invoked by the parser once, when it is ready to start processing the input.

Q

query(String) - Method in interface com.univocity.api.entity.html.HtmlElement
Searches for elements that match a CSS query, with the current HtmlElement as the starting context.
query() - Method in interface com.univocity.api.entity.html.HtmlElement
Starts a matching sequence so chaining selector methods can be used to traverse the HtmlElement

R

rateLimiter() - Method in interface com.univocity.api.entity.html.DownloadContext
Returns the RateLimiter being used during the fetch resources operation to slow down the rate of downloads being performed.
recordMetaData() - Method in interface com.univocity.api.entity.html.HtmlParsingContext
Returns the metadata information associated with records produced by the current parsing process.
RecordTrigger - Interface in com.univocity.api.entity.html.builders
Used in HtmlEntitySettings.addRecordTrigger() to create a path that defines when a new record should be created.
RecordTriggerStart - Interface in com.univocity.api.entity.html.builders
Used in HtmlEntitySettings.addRecordTrigger() to create a path that defines when a new record should be created.
removeField(String) - Method in class com.univocity.api.entity.html.HtmlEntitySettings
 
response() - Method in interface com.univocity.api.entity.html.HtmlParsingContext
If the HtmlParser is reading from a web page, returns the HttpResponse that it is using to process the input HTML.
RowListProcessor - Class in com.univocity.api.entity.html.processor
A convenience RowProcessor implementation for storing all rows parsed into a list.
RowListProcessor() - Constructor for class com.univocity.api.entity.html.processor.RowListProcessor
 
rowProcessed(String[], HtmlParsingContext) - Method in interface com.univocity.api.entity.html.processor.RowProcessor
Invoked by the parser after all values of a valid record have been processed.
RowProcessor - Interface in com.univocity.api.entity.html.processor
The essential callback interface to handle records parsed by any parser that extends AbstractParser.
RowProcessorSwitch - Class in com.univocity.api.entity.html.processor
A special RowProcessor implementation that combines and allows switching among different RowProcessors.
RowProcessorSwitch() - Constructor for class com.univocity.api.entity.html.processor.RowProcessorSwitch
 

S

select(String) - Method in interface com.univocity.api.entity.html.builders.ElementFilterStart
Selects what HTML element the parser must match using a CSS query.
setBaseUri(String) - Method in interface com.univocity.api.entity.html.DownloadContext
Modifies the current base URI associated with the document whose resources are being fetched.
setBaseUri(String) - Method in class com.univocity.api.entity.html.FetchOptions
Modifies the current base URI associated with the document whose resources are being fetched.
setCurrentPage() - Method in interface com.univocity.api.entity.html.builders.PaginationParams
Creates a new field for the current page and returns a PathStart which can be used to define the path to the ‘current page’ element.
setCurrentPage() - Method in class com.univocity.api.entity.html.HtmlPaginator
Creates a new field for the current page and returns a PathStart which can be used to define the path to the ‘current page’ element.
setCurrentPageNumber() - Method in interface com.univocity.api.entity.html.builders.PaginationParams
Creates a new field for the current page and returns a PathStart which can be used to define the path to the ‘current page’ element as a number.
setCurrentPageNumber() - Method in class com.univocity.api.entity.html.HtmlPaginator
Creates a new field for the current page and returns a PathStart which can be used to define the path to the ‘current page’ element as a number.
setDownloadBlacklistingEnabled(boolean) - Method in class com.univocity.api.entity.html.FetchOptions
Configures whether URLs of resources that resulted in a download failure (such as a 404) should be blacklisted while the parser is running, so no further attempts to access the same URL will be made.
setDownloadHandler(DownloadHandler) - Method in class com.univocity.api.entity.html.FetchOptions
Defines a DownloadHandler to manipulate the downloads performed by the fetch resources operation.
setListener(HtmlParserListener) - Method in class com.univocity.api.entity.html.HtmlEntitySettings
Associates a HtmlParserListener with this HTML entity.
setNextPage() - Method in interface com.univocity.api.entity.html.builders.PaginationParams
Creates a new field for the next page and returns a PathStart which can be used to define the path to the next page element.
setNextPage() - Method in class com.univocity.api.entity.html.HtmlPaginator
Creates a new field for the next page and returns a PathStart which can be used to define the path to the next page element.
setNextPageNumber() - Method in interface com.univocity.api.entity.html.builders.PaginationParams
Creates a new field for the next page number and returns a PathStart which can be used to define the path to the next page number element.
setNextPageNumber() - Method in class com.univocity.api.entity.html.HtmlPaginator
Creates a new field for the next page number and returns a PathStart which can be used to define the path to the next page number element.
setOverwriteSharedResources(boolean) - Method in class com.univocity.api.entity.html.FetchOptions
Defines whether resources that have been downloaded and are shared among multiple pages should be overwritten during a new fetch resources operation.
setPaginator(HtmlPaginator) - Method in class com.univocity.api.entity.html.HtmlParserSettings
Configures a HtmlPaginator to handle multiple pages of remote content that needs to parsed.
setParserThreadCount(int) - Method in class com.univocity.api.entity.html.HtmlParserSettings
Explicitly defines a maximum number of threads that should be used by the parser when processing data of multiple entities from the same HTML input.
setRemoteInterval(long) - Method in class com.univocity.api.entity.html.FetchOptions
Defines the minimum interval of time to wait between each download request.
setRequestParameter(String, String) - Method in interface com.univocity.api.entity.html.builders.PaginationGroup
Associates a constant value to a request parameter.
setRequestParameter(String, String) - Method in class com.univocity.api.entity.html.HtmlPaginator
Associates a constant value to a request parameter.
setRequestParameterData(String, Object) - Method in class com.univocity.api.entity.html.HtmlPaginator
Defines a request parameter name and data value to be used when requesting the next page.
setSharedResourceDir(String) - Method in class com.univocity.api.entity.html.FetchOptions
Defines the shared resource directory used to store files referenced by one or more HTML pages and CSS files.
setSharedResourceDir(File) - Method in class com.univocity.api.entity.html.FetchOptions
Defines the shared resource directory used to store files referenced by one or more HTML pages and CSS files.
setTargetFile(File) - Method in interface com.univocity.api.entity.html.DownloadContext
Changes the download destination to a new location.
skipDownload() - Method in interface com.univocity.api.entity.html.DownloadContext
Skips this download and moves on to the next.
sourceElement() - Method in interface com.univocity.api.entity.html.DownloadContext
Returns the specific HtmlElement of the HTML that has a reference to the resource being downloaded.
startAt(String) - Method in interface com.univocity.api.entity.html.builders.GroupStart
Specifies where on the HTML the group will start.
startAt(String) - Method in interface com.univocity.api.entity.html.builders.PaginationGroupStart
Specifies where on the HTML that the group will start.
stopAllDownloads() - Method in interface com.univocity.api.entity.html.DownloadContext
Skips this download and stops any active downloads, finalizing the fetch operation

T

tagName() - Method in interface com.univocity.api.entity.html.HtmlElement
Returns the HTML tag name associated with the element.
targetFile() - Method in interface com.univocity.api.entity.html.DownloadContext
Returns the local target File where the downloaded contents will be saved.
targetFileExtension() - Method in interface com.univocity.api.entity.html.DownloadContext
Returns the extension of the DownloadContext.targetFile().
targetRelativePath() - Method in interface com.univocity.api.entity.html.DownloadContext
Returns the relative path of the file being downloaded.
text() - Method in interface com.univocity.api.entity.html.HtmlElement
Gets the combined text of this element and all its children.
toRecord(String[]) - Method in interface com.univocity.api.entity.html.HtmlParsingContext
Converts the given parsed row to a HtmlRecord
toRequestParameter(String, String) - Method in class com.univocity.api.entity.html.HtmlPaginator
Assigns values captured for two fields declared in this HtmlPaginator to a request parameter.
toW3CDocument() - Method in interface com.univocity.api.entity.html.HtmlElement
Generates a W3C DOM document from the current HTML element.

U

under(String) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should be directly under a given element of a table, at the same column, and where the given element:
underHeader(String) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should be under a given element of a table, at the same column, and where the given element:
UpDown<T extends UpDown<T>> - Interface in com.univocity.api.entity.html.builders
The UpDown interface groups rules that match elements under or above the current element matched by the parser.
upTo(String) - Method in interface com.univocity.api.entity.html.builders.UpDown
Establishes that the parser should look ‘up’ the page for the given element.
upToHeader(String) - Method in interface com.univocity.api.entity.html.builders.UpDown
Establishes that the parser should look ‘up’ the page for the given element that is in the same table column as the previously matched element.

V

valueOf(String) - Static method in enum com.univocity.api.entity.html.builders.annotations.Matcher.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.univocity.api.entity.html.builders.annotations.Matcher.Type
Returns an array containing the constants of this enum type, in the order they are declared.

W

withExactText(String, String...) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should contain exactly a given text.
withExactTextMatchCase(String, String...) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
withText(String, String...) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
Establishes that the matched HTML element should start with a given text.
withTextMatchCase(String, String...) - Method in interface com.univocity.api.entity.html.builders.BasicElementFilter
A B C D E F G H I L M N O P Q R S T U V W 
Skip navigation links

Copyright © 2018 uniVocity Software Pty Ltd. All rights reserved.