com.sun.slamd.scripting.http
Class HTMLDocumentVariable

java.lang.Object
  com.sun.slamd.scripting.engine.Variable
      com.sun.slamd.scripting.http.HTMLDocumentVariable

All Implemented Interfaces:

Argument

public class HTMLDocumentVariable

extends Variable

This class defines a variable that can be used to encapsulate an HTML document retrieved as part of processing a request. An HTML document variable offers the following methods:

• assign(string documentURL, string htmlData) -- Initializes this HTML document with the provided URL and HTML data. This method returns a boolean value that indicates whether the assignment was successful.
• getAssociatedFiles() -- Returns a string array containing a list of URLs of files associated with this HTML document.
• getDocumentFrames() -- Returns a string array containing a list of URLs of frames contained in this HTML document.
• getDocumentImages() -- Returns a string array containing a list of URLs of images associated with this HTML document.
• getDocumentLinks() -- Returns a string array containing a list of URLs of hyperlinks associated with this HTML document.
• getHTMLData() -- Returns a string containing the raw HTML that makes up this HTML document.
• getTextData() -- Returns a string containing the data that makes up this HTML document with all tags removed.
• isNull() -- Returns a boolean value that indicates whether this is a null document.

Field Summary

static java.lang.String	ASSIGN_METHOD_NAME The name of the method used to initialize an HTML document.
static int	ASSIGN_METHOD_NUMBER The method number for the "assign" method.
static java.lang.String	GET_ASSOCIATED_FILES_METHOD_NAME The name of the method used to retrieve a list of the files associated with this HTML document.
static int	GET_ASSOCIATED_FILES_METHOD_NUMBER The method number for the "getAssociatedFiles" method.
static java.lang.String	GET_DOCUMENT_FRAMES_METHOD_NAME The name of the method used to retrieve a list of the frames contained in this HTML document.
static int	GET_DOCUMENT_FRAMES_METHOD_NUMBER The method number for the "getDocumentImages" method.
static java.lang.String	GET_DOCUMENT_IMAGES_METHOD_NAME The name of the method used to retrieve a list of the images referenced by this HTML document.
static int	GET_DOCUMENT_IMAGES_METHOD_NUMBER The method number for the "getDocumentImages" method.
static java.lang.String	GET_DOCUMENT_LINKS_METHOD_NAME The name of the method used to retrieve a list of the hyperlinks contained in this HTML document.
static int	GET_DOCUMENT_LINKS_METHOD_NUMBER The method number for the "getDocumentLinks" method.
static java.lang.String	GET_HTML_DATA_METHOD_NAME The name of the method used to retrieve the raw HTML associated with this HTML document.
static int	GET_HTML_DATA_METHOD_NUMBER The method number for the "getHTMLData" method.
static java.lang.String	GET_TEXT_DATA_METHOD_NAME The name of the method used to retrieve the text (with HTML tags removed) associated with this HTML document.
static int	GET_TEXT_DATA_METHOD_NUMBER The method number for the "getTextData" method.
static Method[]	HTML_DOCUMENT_VARIABLE_METHODS The set of methods associated with HTML document variables.
static java.lang.String	HTML_DOCUMENT_VARIABLE_TYPE The name that will be used for the data type of HTML document variables.
static java.lang.String	IS_NULL_METHOD_NAME The name of the method used to determine whether this represents a null HTML document.
static int	IS_NULL_METHOD_NUMBER The method number for the "isNull" method.

Constructor Summary

HTMLDocumentVariable()
Creates a new variable with no name, to be used only when creating a variable with Class.newInstance(), and only when setName() is called after that to set the name.

HTMLDocumentVariable(HTMLDocument htmlDocument)
Creates a new HTML document variable based on the provided document.

Method Summary

void	assign(Argument argument) Assigns the value of the provided argument to this variable.
Variable	executeMethod(int lineNumber, int methodNumber, Argument[] arguments) Executes the specified method, using the provided variables as arguments to the method, and makes the return value available to the caller.
int	getMethodNumber(java.lang.String methodName, java.lang.String[] argumentTypes) Retrieves the method number for the method that has the specified name and argument types, or -1 if there is no such method.
Method[]	getMethods() Retrieves a list of all methods defined for this variable.
java.lang.String	getReturnTypeForMethod(java.lang.String methodName, java.lang.String[] argumentTypes) Retrieves the return type for the method with the specified name and argument types.
java.lang.String	getValueAsString() Retrieves a string representation of the value of this argument.
java.lang.String	getVariableTypeName() Retrieves the name of the variable type for this variable.
boolean	hasMethod(java.lang.String methodName) Indicates whether this variable type has a method with the specified name.

Methods inherited from class com.sun.slamd.scripting.engine.Variable

getArgumentAsString, getArgumentType, getArgumentValue, getName, getStatTrackers, isValidIdentifier, setName, startStatTrackers, stopStatTrackers

Methods inherited from class java.lang.Object

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

Field Detail

HTML_DOCUMENT_VARIABLE_TYPE

public static final java.lang.String HTML_DOCUMENT_VARIABLE_TYPE

The name that will be used for the data type of HTML document variables.

See Also:

Constant Field Values

ASSIGN_METHOD_NAME

public static final java.lang.String ASSIGN_METHOD_NAME

The name of the method used to initialize an HTML document.

See Also:

Constant Field Values

ASSIGN_METHOD_NUMBER

public static final int ASSIGN_METHOD_NUMBER

The method number for the "assign" method.

See Also:

Constant Field Values

GET_ASSOCIATED_FILES_METHOD_NAME

public static final java.lang.String GET_ASSOCIATED_FILES_METHOD_NAME

The name of the method used to retrieve a list of the files associated with this HTML document.

See Also:

Constant Field Values

GET_ASSOCIATED_FILES_METHOD_NUMBER

public static final int GET_ASSOCIATED_FILES_METHOD_NUMBER

The method number for the "getAssociatedFiles" method.

See Also:

Constant Field Values

GET_DOCUMENT_FRAMES_METHOD_NAME

public static final java.lang.String GET_DOCUMENT_FRAMES_METHOD_NAME

The name of the method used to retrieve a list of the frames contained in this HTML document.

See Also:

Constant Field Values

GET_DOCUMENT_FRAMES_METHOD_NUMBER

public static final int GET_DOCUMENT_FRAMES_METHOD_NUMBER

The method number for the "getDocumentImages" method.

See Also:

Constant Field Values

GET_DOCUMENT_IMAGES_METHOD_NAME

public static final java.lang.String GET_DOCUMENT_IMAGES_METHOD_NAME

The name of the method used to retrieve a list of the images referenced by this HTML document.

See Also:

Constant Field Values

GET_DOCUMENT_IMAGES_METHOD_NUMBER

public static final int GET_DOCUMENT_IMAGES_METHOD_NUMBER

The method number for the "getDocumentImages" method.

See Also:

Constant Field Values

GET_DOCUMENT_LINKS_METHOD_NAME

public static final java.lang.String GET_DOCUMENT_LINKS_METHOD_NAME

The name of the method used to retrieve a list of the hyperlinks contained in this HTML document.

See Also:

Constant Field Values

GET_DOCUMENT_LINKS_METHOD_NUMBER

public static final int GET_DOCUMENT_LINKS_METHOD_NUMBER

The method number for the "getDocumentLinks" method.

See Also:

Constant Field Values

GET_HTML_DATA_METHOD_NAME

public static final java.lang.String GET_HTML_DATA_METHOD_NAME

The name of the method used to retrieve the raw HTML associated with this HTML document.

See Also:

Constant Field Values

GET_HTML_DATA_METHOD_NUMBER

public static final int GET_HTML_DATA_METHOD_NUMBER

The method number for the "getHTMLData" method.

See Also:

Constant Field Values

GET_TEXT_DATA_METHOD_NAME

public static final java.lang.String GET_TEXT_DATA_METHOD_NAME

The name of the method used to retrieve the text (with HTML tags removed) associated with this HTML document.

See Also:

Constant Field Values

GET_TEXT_DATA_METHOD_NUMBER

public static final int GET_TEXT_DATA_METHOD_NUMBER

The method number for the "getTextData" method.

See Also:

Constant Field Values

IS_NULL_METHOD_NAME

public static final java.lang.String IS_NULL_METHOD_NAME

The name of the method used to determine whether this represents a null HTML document.

See Also:

Constant Field Values

IS_NULL_METHOD_NUMBER

public static final int IS_NULL_METHOD_NUMBER

The method number for the "isNull" method.

See Also:

Constant Field Values

HTML_DOCUMENT_VARIABLE_METHODS

public static final Method[] HTML_DOCUMENT_VARIABLE_METHODS

The set of methods associated with HTML document variables.

Constructor Detail

HTMLDocumentVariable

public HTMLDocumentVariable()
                     throws ScriptException

Creates a new variable with no name, to be used only when creating a variable with Class.newInstance(), and only when setName() is called after that to set the name.

Throws:

ScriptException - If a problem occurs while initializing the new variable.

HTMLDocumentVariable

public HTMLDocumentVariable(HTMLDocument htmlDocument)

Creates a new HTML document variable based on the provided document.

Parameters:

htmlDocument - The HTML document to use to initialize this variable.

Method Detail

getVariableTypeName

public java.lang.String getVariableTypeName()

Retrieves the name of the variable type for this variable.

Specified by:

getVariableTypeName in class Variable

Returns:

The name of the variable type for this variable.

getMethods

public Method[] getMethods()

Retrieves a list of all methods defined for this variable.

Specified by:

getMethods in class Variable

Returns:

A list of all methods defined for this variable.

hasMethod

public boolean hasMethod(java.lang.String methodName)

Indicates whether this variable type has a method with the specified name.

Specified by:

hasMethod in class Variable

Parameters:

methodName - The name of the method.

Returns:

true if this variable has a method with the specified name, or false if it does not.

getMethodNumber

public int getMethodNumber(java.lang.String methodName,
                           java.lang.String[] argumentTypes)

Retrieves the method number for the method that has the specified name and argument types, or -1 if there is no such method.

Specified by:

getMethodNumber in class Variable

Parameters:

methodName - The name of the method.

argumentTypes - The list of argument types for the method.

Returns:

The method number for the method that has the specified name and argument types.

getReturnTypeForMethod

public java.lang.String getReturnTypeForMethod(java.lang.String methodName,
                                               java.lang.String[] argumentTypes)

Retrieves the return type for the method with the specified name and argument types.

Specified by:

getReturnTypeForMethod in class Variable

Parameters:

methodName - The name of the method.

argumentTypes - The set of argument types for the method.

Returns:

The return type for the method, or null if there is no such method defined.

executeMethod

public Variable executeMethod(int lineNumber,
                              int methodNumber,
                              Argument[] arguments)
                       throws ScriptException

Executes the specified method, using the provided variables as arguments to the method, and makes the return value available to the caller.

Specified by:

executeMethod in class Variable

Parameters:

lineNumber - The line number of the script in which the method call occurs.

methodNumber - The method number of the method to execute.

arguments - The set of arguments to use for the method.

Returns:

The value returned from the method, or null if it does not return a value.

Throws:

ScriptException - If the specified method does not exist, or if a problem occurs while attempting to execute it.

assign

public void assign(Argument argument)
            throws ScriptException

Assigns the value of the provided argument to this variable. The value of the provided argument must be of the same type as this variable.

Specified by:

assign in class Variable

Parameters:

argument - The argument whose value should be assigned to this variable.

Throws:

ScriptException - If a problem occurs while performing the assignment.

getValueAsString

public java.lang.String getValueAsString()

Retrieves a string representation of the value of this argument.

Returns:

A string representation of the value of this argument.