com.screenscraper.util.form

Class Form

java.lang.Object

com.screenscraper.util.form.Form

All Implemented Interfaces:

java.io.Serializable

public class Form
extends java.lang.Object
implements java.io.Serializable

Represents a form in the html tags. Can be output or simply queried.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Form(ScrapingSession session, ScrapeableFile scrapeableFile, java.lang.String formText) Constructs a Form from text, parsing it into it's parts

Method Summary

Modifier and Type	Method and Description
void	addInput(Input input) Adds a new input value to this form
java.lang.String	getAction() Gets the action this form will perform.
java.lang.String	getEncodeType() Returns the EncodeType for the object
java.util.List<Input>	getFormInputs() Returns the inputs parsed for this form.
Input	getInputByName(java.lang.String name) Gets the first input with the given name.
java.lang.String	getMethod() Gets the method, GET or POST, of the form
java.lang.String	getName() Gets the name of the current form
boolean	removeInput(Input input) Removes an input from the form
boolean	removeInput(java.lang.String name) Removes an input from the form.
void	setAction(java.lang.String action) Sets the action for the form
void	setEncodeType(java.lang.String encodeType) Sets the EncodeType for the object
void	setMethod(java.lang.String method) Sets the method.
void	setName(java.lang.String name) Sets the name of the form
void	setScrapeableFileParameters(ScrapeableFile scrapeableFile) Sets the parameters on a scrapeable file to the input values as determined by the current form settings
void	setValue(java.lang.String name, java.lang.Object value) Sets the value for a given name, overwriting the value it contained before.
void	setValueChecked(java.lang.String name, java.lang.Object value) Sets the value for a given name, overwriting the value it contained before.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Form

public Form(@NotNull
            ScrapingSession session,
            @Nullable
            ScrapeableFile scrapeableFile,
            @NotNull
            java.lang.String formText)

Constructs a Form from text, parsing it into it's parts

Parameters:

session - The scraping session associated with the form

scrapeableFile - The scrapeable file used to resolve URLS

formText - HTML containing the form input elements, and possibly (useful) the form tag itself

Method Detail

setValue

public void setValue(@NotNull
                     java.lang.String name,
                     @NotNull
                     java.lang.Object value)

Sets the value for a given name, overwriting the value it contained before. If it wasn't there it is added

Parameters:

name - The key

value - The value

setValueChecked

public void setValueChecked(@NotNull
                            java.lang.String name,
                            @NotNull
                            java.lang.Object value)

Sets the value for a given name, overwriting the value it contained before. If it wasn't there an exception is thrown

Parameters:

name - The key

value - The value

Throws:

java.lang.IllegalArgumentException - If the value was invalid for the type or the name wasn't found on the form

getName

@Nullable
public java.lang.String getName()

Gets the name of the current form

Returns:

The name of the Form

setName

public void setName(@Nullable
                    java.lang.String name)

Sets the name of the form

Parameters:

name - The new name for the form

getMethod

@Nullable
public java.lang.String getMethod()

Gets the method, GET or POST, of the form

Returns:

The method of the form, usually GET or POST (case isn't guaranteed)

setMethod

public void setMethod(@Nullable
                      java.lang.String method)

Sets the method. This should be GET or POST

Parameters:

method - The new method used by the form

getAction

@Nullable
public java.lang.String getAction()

Gets the action this form will perform.

Returns:

The action URL for the form

setAction

public void setAction(@Nullable
                      java.lang.String action)

Sets the action for the form

Parameters:

action - The new action URL for the form

setScrapeableFileParameters

public void setScrapeableFileParameters(@Nullable
                                        ScrapeableFile scrapeableFile)

Sets the parameters on a scrapeable file to the input values as determined by the current form settings

Parameters:

scrapeableFile - The scrapeable file on which to set the parameters

getFormInputs

public java.util.List<Input> getFormInputs()

Returns the inputs parsed for this form. Modifying this list WILL change the form's internal list

Returns:

The inputs in this form

addInput

public void addInput(@Nullable
                     Input input)

Adds a new input value to this form

Parameters:

input - The input to be added

getEncodeType

@Nullable
public java.lang.String getEncodeType()

Returns the EncodeType for the object

Returns:

The EncodeType for the object

Since:

7.0.4a

setEncodeType

public void setEncodeType(@Nullable
                          java.lang.String encodeType)

Sets the EncodeType for the object

Parameters:

encodeType - The new value for EncodeType

Since:

7.0.5a

getInputByName

@Nullable
public Input getInputByName(@Nullable
                                       java.lang.String name)

Gets the first input with the given name.

Parameters:

name - The name of the input

Returns:

The input, or null if it wasn't found

removeInput

public boolean removeInput(@NotNull
                           Input input)

Removes an input from the form

Parameters:

input - The input to remove from the Form

Returns:

True if the input was in the inputs, false otherwise

removeInput

public boolean removeInput(@NotNull
                           java.lang.String name)

Removes an input from the form. If there are multiple inputs with the same name, the first one found will be removed

Parameters:

name - The name of the input to remove from the Form

Returns:

True if the input was in the inputs, false otherwise

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object