Package com.crawljax.forms

Class FormInputValueHelper

java.lang.Object

com.crawljax.forms.FormInputValueHelper

public final class FormInputValueHelper
extends Object

Singleton helper class for FormHandler.

Field Summary

Fields

Modifier and Type	Field	Description
private static int	EMPTY
private CrawlRules.FormFillMode	formFillMode
private Map<Identification,FormInput>	formInputs
private static String	FORMS_JSON_FILE
private static FormInputValueHelper	instance
private static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FormInputValueHelper(InputSpecification inputSpecification, CrawlRules.FormFillMode formFillMode)

Method Summary

Modifier and Type	Method	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.
private FormInput	formInputMatchingNode(Node element)	return the list of FormInputs that match this element
Node	getBelongingNode(FormInput input, Document dom)
List<CandidateElement>	getCandidateElementsForInputs(EmbeddedBrowser browser, Element sourceElement, EventableCondition eventableCondition)
private String	getElementType(Node node)
private FormInput	getFormInput(EmbeddedBrowser browser, Node element, int indexValue)
FormInput	getFormInput(Identification identification)	Get the form input for the DOM element.
private FormInput.InputType	getFormInputType(Node node)
FormInput	getFormInputWithIndexValue(EmbeddedBrowser browser, Node element, int indexValue)
private Identification	getIdentification(Node element)
static FormInputValueHelper	getInstance(InputSpecification inputSpecification, CrawlRules.FormFillMode formFillMode)	Creates or returns the instance of the helper class.
private int	getMaxNumberOfValues(List<FormInput> fieldNames)
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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

FORMS_JSON_FILE

private static final String FORMS_JSON_FILE

See Also:

Constant Field Values

EMPTY

private static final int EMPTY

See Also:

Constant Field Values

instance

private static FormInputValueHelper instance

formInputs

private final Map<Identification,FormInput> formInputs

formFillMode

private final CrawlRules.FormFillMode formFillMode

Constructor Detail

FormInputValueHelper

private FormInputValueHelper(InputSpecification inputSpecification,
                             CrawlRules.FormFillMode formFillMode)

Parameters:

inputSpecification - the input specification.

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

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.

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

getMaxNumberOfValues

private int getMaxNumberOfValues(List<FormInput> fieldNames)

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.

getIdentification

private Identification getIdentification(Node element)

Parameters:

element -

Returns:

returns the id of the element if set, else the name. If none found, returns xpath

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

getFormInput

private FormInput getFormInput(EmbeddedBrowser browser,
                               Node element,
                               int indexValue)

formInputMatchingNode

private FormInput formInputMatchingNode(Node element)

return the list of FormInputs that match this element

Parameters:

element -

Returns:

getFormInputType

private FormInput.InputType getFormInputType(Node node)

getElementType

private String getElementType(Node node)