com.univocity.api.entity.html.builders

Interface PaginationGroup

All Superinterfaces:

BasicElementFilter<PaginationGroup>, ElementFilter<PaginationGroup>, ElementFilterStart<PaginationGroup>, PaginationParams, UpDown<PaginationGroup>

public interface PaginationGroup
extends ElementFilter<PaginationGroup>, ElementFilterStart<PaginationGroup>, PaginationParams

A special purpose Group-like structure, used only for HtmlPaginators. Defines an area in the HTML where the paginator will look for elements to be used for pagination handling. Elements outside the area will be ignored.

Author:

uniVocity Software Pty Ltd - dev@univocity.com

See Also:

PaginationContext, Paginator

Method Summary

Modifier and Type	Method and Description
PathStart	addField(String fieldName) Creates a new field on this PaginationGroup and returns a PathStart that allows the user to define a path to the field.
T	copyPath() Copies the current path allowing new matching to be added to a common path without changing the original one.
void	setRequestParameter(String parameterName, String parameterValue) Associates a constant value to a request parameter.

Methods inherited from interface com.univocity.api.entity.html.builders.BasicElementFilter

attribute, attribute, childOf, classes, containedBy, containedBy, containing, containing, containing, filter, followedBy, followedBy, followedByText, followedImmediatelyBy, id, matchNext, not, parentOf, precededBy, precededBy, precededByText, precededImmediatelyBy, under, underHeader, withExactText, withExactTextMatchCase, withText, withTextMatchCase

Methods inherited from interface com.univocity.api.entity.html.builders.UpDown

downTo, downToFooter, upTo, upToHeader

Methods inherited from interface com.univocity.api.entity.html.builders.ElementFilterStart

match, match, match, matchCurrent, matchFirst, matchLast, select

Methods inherited from interface com.univocity.api.entity.html.builders.PaginationParams

addRequestParameter, setCurrentPage, setCurrentPageNumber, setNextPage, setNextPageNumber

Method Detail

setRequestParameter

void setRequestParameter(String parameterName,
                         String parameterValue)

Associates a constant value to a request parameter. Parameter values are submitted in POST requests to load the next page.

Parameters:

parameterName - the name that will be associated with the parameter, which will be sent in the request for the next page.

parameterValue - the value of the corresponding parameter

addField

PathStart addField(String fieldName)

Creates a new field on this PaginationGroup and returns a PathStart that allows the user to define a path to the field. Any fields added to the paginator and their values can be read from a NextInputHandler through its PaginationContext.

Parameters:

fieldName - name of the new field

Returns:

a PathStart to be used to define the path of the value for the given field

copyPath

T copyPath()

Copies the current path allowing new matching to be added to a common path without changing the original one. Useful for when the path to multiple elements share a common structure. An example can be shown with this HTML: ```html

first

lorem

second

ispum

first

article

``` A technique to get the text of the `p` element of the first and second `article`s of the first `div` is: ```java HtmlEntityList entities = new HtmlEntityList(); HtmlEntitySettings entity = entities.configureEntity("test"); //creates a new path with a common matching sequence. PartialPath path = entity.newPath() .match("article").containing("h1"); //the copied path ends with 'h1', we further specify it should start with text 'first'. path.copyPath().withText("first") .addField("one").match("p").getText(); //the original path is unchanged. We can copy it again and match 'h1' elements now starting with text 'second' path.copyPath().withText("second") .addField("two").match("p").getText(); ``` In this example, the first path that is created is used as a basis. This path is then copied to specify the the text to be matched from a `h1` element. Fields can be added to paths and in the example above each copy matches any `p` element starting from the path. This will make the parser capture the values: ``` [lorem, ispum] ```

Returns:

a PartialPath that allows the specification of a path and does not affect the path that it is built upon.