com.crawljax.forms

Class FormInputValueHelper

java.lang.Object

com.crawljax.forms.FormInputValueHelper

public final class FormInputValueHelper
extends Object

Singleton helper class for FormHandler.

Method Summary

Modifier and Type	Method and Description
void	addTrainingInput(Identification identification, FormInput input) Add the training data to the form input map.
static List<FormInput>	deserializeFormInputs(File dir) Serializes form inputs and writes the data to the output directory to be used by future non-training crawls.
Node	getBelongingNode(FormInput input, Document dom)
List<CandidateElement>	getCandidateElementsForInputs(EmbeddedBrowser browser, Element sourceElement, EventableCondition eventableCondition)
FormInput	getFormInput(Identification identification) Get the form input for the DOM element.
FormInput	getFormInputWithIndexValue(EmbeddedBrowser browser, Node element, int indexValue)
static FormInputValueHelper	getInstance(InputSpecification inputSpecification, CrawlRules.FormFillMode formFillMode) Creates or returns the instance of the helper class.
static void	reset() Removes the instance so another must be built.
static void	serializeFormInputs(File dir) Serializes form inputs and writes the data to the output directory to be used by future non-training crawls.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static FormInputValueHelper getInstance(InputSpecification inputSpecification,
                                               CrawlRules.FormFillMode formFillMode)

Creates or returns the instance of the helper class.

Parameters:

inputSpecification - the input specification.

formFillMode - if random data should be used on the input fields.

Returns:

The singleton instance.

reset

public static void reset()

Removes the instance so another must be built. Used only to reset the state in between JUnit tests.

getCandidateElementsForInputs

public List<CandidateElement> getCandidateElementsForInputs(EmbeddedBrowser browser,
                                                            Element sourceElement,
                                                            EventableCondition eventableCondition)

Parameters:

browser - the browser instance

sourceElement - the form elements

eventableCondition - the belonging eventable condition for sourceElement

Returns:

a list with Candidate elements for the inputs

getBelongingNode

public Node getBelongingNode(FormInput input,
                             Document dom)
                      throws XPathExpressionException

Parameters:

input - the form input

dom - the document

Returns:

returns the belonging node to input in dom

Throws:

XPathExpressionException - if a failure is occurred.

addTrainingInput

public void addTrainingInput(Identification identification,
                             FormInput input)

Add the training data to the form input map.

Parameters:

identification - The identifier.

input - The form input.

getFormInput

public FormInput getFormInput(Identification identification)

Get the form input for the DOM element.

Parameters:

identification - specifies a DOM element

Returns:

the form input for the DOM element.

getFormInputWithIndexValue

public FormInput getFormInputWithIndexValue(EmbeddedBrowser browser,
                                            Node element,
                                            int indexValue)

Parameters:

browser - the current browser instance

element - the element in the DOM

indexValue - the i-th specified value. if i>#values, first value is used

Returns:

the specified value with index indexValue for the belonging elements

serializeFormInputs

public static void serializeFormInputs(File dir)

Serializes form inputs and writes the data to the output directory to be used by future non-training crawls.

Parameters:

dir - The output directory for the form input data.

deserializeFormInputs

public static List<FormInput> deserializeFormInputs(File dir)

Serializes form inputs and writes the data to the output directory to be used by future non-training crawls.

Parameters:

dir - The output directory for the form input data.

Returns:

The list of inputs