wicket-examples/src/test/java/com/meterware/httpunit/ParsedHTML.java

package com.meterware.httpunit;

import java.io.IOException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import com.meterware.httpunit.scripting.ScriptableDelegate;

/**
 * @author <a href="mailto:russgold@httpunit.org">Russell Gold</a>
 * @author <a href="mailto:bx@bigfoot.com">Benoit Xhenseval</a>
 */
class ParsedHTML
{

	final static private HTMLElement[] NO_ELEMENTS = new HTMLElement[0];

	final static private String[] TEXT_ELEMENTS = { "p", "h1", "h2", "h3", "h4", "h5", "h6" };

	private Node _rootNode;

	private URL _baseURL;

	private FrameSelector _frame;

	private String _baseTarget;

	private String _characterSet;

	private WebResponse _response;

	private boolean _updateElements = true;

	private boolean _enableNoScriptNodes;

	/** map of element IDs to elements. * */
	private final HashMap<String,HTMLElement> _elementsByID = new HashMap<String,HTMLElement>();

	/** map of element names to lists of elements. * */
	private final HashMap<String,List<HTMLElement>> _elementsByName = new HashMap<String,List<HTMLElement>>();

	/** map of DOM elements to HTML elements * */
	private final HashMap<Node, HTMLElement> _elements = new HashMap<Node, HTMLElement>();

	private final ArrayList<HTMLElement> _formsList = new ArrayList<HTMLElement>();
	private WebForm[] _forms;
	private WebForm _activeForm;

	private final ArrayList<HTMLElement> _imagesList = new ArrayList<HTMLElement>();
	private WebImage[] _images;

	private final ArrayList<HTMLElement> _linkList = new ArrayList<HTMLElement>();
	private WebLink[] _links;

	private final ArrayList<HTMLElement> _blocksList = new ArrayList<HTMLElement>();
	private TextBlock[] _blocks;

	private final ArrayList<HTMLElement> _appletList = new ArrayList<HTMLElement>();
	private WebApplet[] _applets;

	private final ArrayList<HTMLElement> _tableList = new ArrayList<HTMLElement>();
	private WebTable[] _tables;

	private final ArrayList<HTMLElement> _frameList = new ArrayList<HTMLElement>();
	private WebFrame[] _frames;


	ParsedHTML(final WebResponse response, final FrameSelector frame, final URL baseURL, final String baseTarget,
			final Node rootNode, final String characterSet)
	{
		_response = response;
		_frame = frame;
		_baseURL = baseURL;
		_baseTarget = baseTarget;
		_rootNode = rootNode;
		_characterSet = characterSet;
	}


	/**
	 * Returns the forms found in the page in the order in which they appear.
	 * 
	 * @return Forms
	 */
	public WebForm[] getForms()
	{
		if (_forms == null)
		{
			loadElements();
			_forms = _formsList.toArray(new WebForm[_formsList.size()]);
		}
		return _forms;
	}


	/**
	 * Returns the links found in the page in the order in which they appear.
	 * 
	 * @return Links
	 */
	public WebLink[] getLinks()
	{
		if (_links == null)
		{
			loadElements();
			_links = _linkList.toArray(new WebLink[_linkList.size()]);
		}
		return _links;
	}


	/**
	 * Returns a proxy for each applet found embedded in this page.
	 * 
	 * @return Applets
	 */
	public WebApplet[] getApplets()
	{
		if (_applets == null)
		{
			loadElements();
			_applets = _appletList.toArray(new WebApplet[_appletList.size()]);
		}
		return _applets;
	}


	/**
	 * Returns the images found in the page in the order in which they appear.
	 * 
	 * @return Images
	 */
	public WebImage[] getImages()
	{
		if (_images == null)
		{
			loadElements();
			_images = _imagesList.toArray(new WebImage[_imagesList.size()]);
		}
		return _images;
	}


	/**
	 * Returns the top-level block elements found in the page in the order in
	 * which they appear.
	 * 
	 * @return Text blocks
	 */
	public TextBlock[] getTextBlocks()
	{
		if (_blocks == null)
		{
			loadElements();
			_blocks = _blocksList.toArray(new TextBlock[_blocksList.size()]);
		}
		return _blocks;
	}


	/**
	 * Returns the first text block found in the page which matches the
	 * specified predicate and value.
	 * 
	 * @param predicate
	 * @param criteria
	 * @return Text block
	 */
	public TextBlock getFirstMatchingTextBlock(final HTMLElementPredicate predicate, final Object criteria)
	{
		TextBlock[] blocks = getTextBlocks();
		for (int i = 0; i < blocks.length; i++)
		{
			if (predicate.matchesCriteria(blocks[i], criteria))
			{
				return blocks[i];
			}
		}
		return null;
	}


	/**
	 * @param block
	 * @return Text block
	 */
	public TextBlock getNextTextBlock(final TextBlock block)
	{
		int index = _blocksList.indexOf(block);
		if (index < 0 || index == _blocksList.size() - 1)
		{
			return null;
		}
		return (TextBlock)_blocksList.get(index + 1);
	}


	/**
	 * Returns the top-level tables found in the page in the order in which they
	 * appear.
	 * 
	 * @return Tables
	 */
	public WebTable[] getTables()
	{
		if (_tables == null)
		{
			loadElements();
			_tables = _tableList.toArray(new WebTable[_tableList.size()]);
		}
		return _tables;
	}


	/**
	 * Returns the HTMLElement with the specified ID.
	 * 
	 * @param id
	 * @return Element
	 */
	public HTMLElement getElementWithID(final String id)
	{
		return (HTMLElement)getElementWithID(id, HTMLElement.class);
	}


	/**
	 * Returns the HTML elements with the specified name.
	 * 
	 * @param name
	 * @return Element
	 */
	public HTMLElement[] getElementsWithName(final String name)
	{
		loadElements();
		ArrayList<HTMLElement> elements = (ArrayList<HTMLElement>)_elementsByName.get(name);
		return elements == null ? NO_ELEMENTS : (HTMLElement[])elements
				.toArray(new HTMLElement[elements.size()]);
	}


	/**
	 * Returns the HTML elements with an attribute with the specified name and
	 * value.
	 * 
	 * @param name
	 * @param value
	 * @return Elements
	 */
	public HTMLElement[] getElementsWithAttribute(final String name, final String value)
	{
		loadElements();
		ArrayList<HTMLElement> elements = new ArrayList<HTMLElement>();
		for (Iterator i = _elements.values().iterator(); i.hasNext();)
		{
			HTMLElement element = (HTMLElement)i.next();
			if (value.equals(element.getAttribute(name)))
			{
				elements.add(element);
			}
		}
		return elements.toArray(new HTMLElement[elements.size()]);
	}


	/**
	 * Returns a list of HTML element names contained in this HTML section.
	 * 
	 * @return Names
	 */
	public String[] getElementNames()
	{
		loadElements();
		return _elementsByName.keySet().toArray(new String[_elementsByName.size()]);
	}


	HTMLElement[] getElementsByTagName(final Node dom, final String name)
	{
		loadElements();
		if (dom instanceof Element)
		{
			return getElementsFromList(((Element)dom).getElementsByTagName(name));
		}
		else
		{
			return getElementsFromList(((Document)dom).getElementsByTagName(name));
		}
	}


	private HTMLElement[] getElementsFromList(final NodeList nl)
	{
		HTMLElement[] elements = new HTMLElement[nl.getLength()];
		for (int i = 0; i < elements.length; i++)
		{
			Node node = nl.item(i);
			elements[i] = _elements.get(node);
			if (elements[i] == null)
			{
				elements[i] = toDefaultElement((Element)node);
				_elements.put(node, elements[i]);
			}
		}
		return elements;
	}


	/**
	 * Returns the form found in the page with the specified ID.
	 * 
	 * @param id
	 * @return Form
	 */
	public WebForm getFormWithID(final String id)
	{
		return (WebForm)getElementWithID(id, WebForm.class);
	}


	/**
	 * Returns the link found in the page with the specified ID.
	 * 
	 * @param id
	 * @return Link
	 */
	public WebLink getLinkWithID(final String id)
	{
		return (WebLink)getElementWithID(id, WebLink.class);

	}


	private Object getElementWithID(final String id, final Class klass)
	{
		loadElements();
		return whenCast(_elementsByID.get(id), klass);
	}


	private Object whenCast(final Object o, final Class klass)
	{
		return klass.isInstance(o) ? o : null;
	}


	/**
	 * Returns the first link found in the page matching the specified criteria.
	 * 
	 * @param predicate
	 * @param criteria
	 * @return Form
	 */
	public WebForm getFirstMatchingForm(final HTMLElementPredicate predicate, final Object criteria)
	{
		WebForm[] forms = getForms();
		for (int i = 0; i < forms.length; i++)
		{
			if (predicate.matchesCriteria(forms[i], criteria))
			{
				return forms[i];
			}
		}
		return null;
	}


	/**
	 * Returns all links found in the page matching the specified criteria.
	 * 
	 * @param predicate
	 * @param criteria
	 * @return Forms
	 */
	public WebForm[] getMatchingForms(final HTMLElementPredicate predicate, final Object criteria)
	{
		ArrayList<WebForm> matches = new ArrayList<WebForm>();
		WebForm[] forms = getForms();
		for (int i = 0; i < forms.length; i++)
		{
			if (predicate.matchesCriteria(forms[i], criteria))
			{
				matches.add(forms[i]);
			}
		}
		return matches.toArray(new WebForm[matches.size()]);
	}


	/**
	 * Returns the form found in the page with the specified name.
	 * 
	 * @param name
	 * @return Form
	 */
	public WebForm getFormWithName(final String name)
	{
		return getFirstMatchingForm(WebForm.MATCH_NAME, name);
	}


	private void interpretScriptElement(final Element element)
	{
		String script = getScript(element);
		if (script != null)
		{
			try
			{
				_updateElements = false;
				String language = NodeUtils.getNodeAttribute(element, "language", null);
				if (!getResponse().getScriptableObject().supportsScript(language))
				{
					_enableNoScriptNodes = true;
				}
				getResponse().getScriptableObject().runScript(language, script);
			}
			finally
			{
				setRootNode(_rootNode);
			}
		}
	}


	private String getScript(final Node scriptNode)
	{
		String scriptLocation = NodeUtils.getNodeAttribute(scriptNode, "src", null);
		if (scriptLocation == null)
		{
			return NodeUtils.asText(scriptNode.getChildNodes());
		}
		else
		{
			try
			{
				return getIncludedScript(scriptLocation);
			}
			catch (IOException e)
			{
				throw new RuntimeException("Error loading included script: " + e);
			}
		}
	}


	/**
	 * Returns the contents of an included script, given its src attribute.
	 * 
	 * @param srcAttribute
	 * @return the contents of the script.
	 * @throws java.io.IOException
	 *             if there is a problem retrieving the script
	 */
	String getIncludedScript(final String srcAttribute) throws IOException
	{
		WebRequest req = new GetMethodWebRequest(getBaseURL(), srcAttribute);
		WebWindow window = getResponse().getWindow();
		if (window == null)
		{
			throw new IllegalStateException(
					"Unable to retrieve script included by this response, since it was loaded by getResource(). Use getResponse() instead.");
		}
		return window.getResource(req).getText();
	}


	/**
	 * If noscript node content is enabled, returns null - otherwise returns a
	 * concealing element.
	 */
	private HTMLElement toNoscriptElement(final Element element)
	{
		return _enableNoScriptNodes ? null : new NoScriptElement(element);
	}


	static class HtmlElementRecorder
	{

		protected void recordHtmlElement(final NodeUtils.PreOrderTraversal pot, final Node node,
				final HTMLElement htmlElement)
		{
			if (htmlElement != null)
			{
				addToMaps(pot, node, htmlElement);
				addToLists(pot, htmlElement);
			}
		}

		protected void addToLists(final NodeUtils.PreOrderTraversal pot, final HTMLElement htmlElement)
		{
			for (Iterator i = pot.getContexts(); i.hasNext();)
			{
				Object o = i.next();
				if (o instanceof ParsedHTML)
				{
					((ParsedHTML)o).addToList(htmlElement);
				}
			}
		}

		protected void addToMaps(final NodeUtils.PreOrderTraversal pot, final Node node, final HTMLElement htmlElement)
		{
			for (Iterator i = pot.getContexts(); i.hasNext();)
			{
				Object o = i.next();
				if (o instanceof ParsedHTML)
				{
					((ParsedHTML)o).addToMaps(node, htmlElement);
				}
			}
		}

	}


	abstract static class HTMLElementFactory extends HtmlElementRecorder
	{
		abstract HTMLElement toHTMLElement(NodeUtils.PreOrderTraversal pot, ParsedHTML parsedHTML,
				Element element);

		void recordElement(final NodeUtils.PreOrderTraversal pot, final Element element, final ParsedHTML parsedHTML)
		{
			HTMLElement htmlElement = toHTMLElement(pot, parsedHTML, element);
			recordHtmlElement(pot, element, htmlElement);
		}

		protected boolean isRecognized(final ClientProperties properties)
		{
			return true;
		}

		protected boolean addToContext()
		{
			return false;
		}

		final protected ParsedHTML getParsedHTML(final NodeUtils.PreOrderTraversal pot)
		{
			return (ParsedHTML)getClosestContext(pot, ParsedHTML.class);
		}

		final protected Object getClosestContext(final NodeUtils.PreOrderTraversal pot, final Class aClass)
		{
			return pot.getClosestContext(aClass);
		}

		protected ParsedHTML getRootContext(final NodeUtils.PreOrderTraversal pot)
		{
			return (ParsedHTML)pot.getRootContext();
		}
	}


	static class DefaultElementFactory extends HTMLElementFactory
	{

		@Override 
		HTMLElement toHTMLElement(final NodeUtils.PreOrderTraversal pot, final ParsedHTML parsedHTML,
				final Element element)
		{
			if (element.getAttribute("id").equals(""))
			{
				return null;
			}
			return parsedHTML.toDefaultElement(element);
		}

		@Override
		protected void addToLists(final NodeUtils.PreOrderTraversal pot, final HTMLElement htmlElement)
		{
		}
	}


	private HTMLElement toDefaultElement(final Element element)
	{
		return new HTMLElementBase(element)
		{
			@Override
			protected ScriptableDelegate newScriptable()
			{
				return new HTMLElementScriptable(this);
			}

			@Override
			protected ScriptableDelegate getParentDelegate()
			{
				return getResponse().getScriptableObject().getDocument();
			}
		};
	}


	static class WebFormFactory extends HTMLElementFactory
	{
		@Override 
		HTMLElement toHTMLElement(final NodeUtils.PreOrderTraversal pot, final ParsedHTML parsedHTML,
				final Element element)
		{
			return parsedHTML.toWebForm(element);
		}


		@Override
		protected void addToLists(final NodeUtils.PreOrderTraversal pot, final HTMLElement htmlElement)
		{
			super.addToLists(pot, htmlElement);
			getRootContext(pot)._activeForm = (WebForm)htmlElement;
		}
	}


	static class WebLinkFactory extends HTMLElementFactory
	{
		@Override 
		HTMLElement toHTMLElement(final NodeUtils.PreOrderTraversal pot, final ParsedHTML parsedHTML,
				final Element element)
		{
			return parsedHTML.toLinkAnchor(element);
		}
	}


	static class TextBlockFactory extends HTMLElementFactory
	{
		@Override 
		HTMLElement toHTMLElement(final NodeUtils.PreOrderTraversal pot, final ParsedHTML parsedHTML,
				final Element element)
		{
			return parsedHTML.toTextBlock(element);
		}


		@Override
		protected boolean addToContext()
		{
			return true;
		}


		@Override
		protected void addToLists(final NodeUtils.PreOrderTraversal pot, final HTMLElement htmlElement)
		{
			for (Iterator i = pot.getContexts(); i.hasNext();)
			{
				Object o = i.next();
				if (!(o instanceof ParsedHTML))
				{
					continue;
				}
				((ParsedHTML)o).addToList(htmlElement);
				break;
			}
		}

	}


	static class ScriptFactory extends HTMLElementFactory
	{

		@Override 
		HTMLElement toHTMLElement(final NodeUtils.PreOrderTraversal pot, final ParsedHTML parsedHTML,
				final Element element)
		{
			return null;
		}

		@Override 
		void recordElement(final NodeUtils.PreOrderTraversal pot, final Element element, final ParsedHTML parsedHTML)
		{
			parsedHTML.interpretScriptElement(element);
		}
	}


	static class NoScriptFactory extends HTMLElementFactory
	{

		@Override 
		HTMLElement toHTMLElement(final NodeUtils.PreOrderTraversal pot, final ParsedHTML parsedHTML,
				final Element element)
		{
			return parsedHTML.toNoscriptElement(element);
		}

		@Override
		protected boolean addToContext()
		{
			return true;
		}
	}


	static class WebFrameFactory extends HTMLElementFactory
	{
		@Override
		HTMLElement toHTMLElement(final NodeUtils.PreOrderTraversal pot, final ParsedHTML parsedHTML,
				final Element element)
		{
			return parsedHTML.toWebFrame(element);
		}
	}


	static class WebIFrameFactory extends HTMLElementFactory
	{
		@Override
		HTMLElement toHTMLElement(final NodeUtils.PreOrderTraversal pot, final ParsedHTML parsedHTML,
				final Element element)
		{
			return parsedHTML.toWebIFrame(element);
		}


		@Override
		protected boolean isRecognized(final ClientProperties properties)
		{
			return properties.isIframeSupported();
		}


		@Override
		protected boolean addToContext()
		{
			return true;
		}
	}


	static class WebImageFactory extends HTMLElementFactory
	{
		@Override 
		HTMLElement toHTMLElement(final NodeUtils.PreOrderTraversal pot, final ParsedHTML parsedHTML,
				final Element element)
		{
			return parsedHTML.toWebImage(element);
		}
	}


	static class WebAppletFactory extends HTMLElementFactory
	{
		@Override HTMLElement toHTMLElement(final NodeUtils.PreOrderTraversal pot, final ParsedHTML parsedHTML,
				final Element element)
		{
			return parsedHTML.toWebApplet(element);
		}

		@Override
		protected boolean addToContext()
		{
			return true;
		}
	}


	static class WebTableFactory extends HTMLElementFactory
	{
		@Override 
		HTMLElement toHTMLElement(final NodeUtils.PreOrderTraversal pot, final ParsedHTML parsedHTML,
				final Element element)
		{
			return parsedHTML.toWebTable(element);
		}

		@Override
		protected boolean addToContext()
		{
			return true;
		}

		@Override
		protected void addToLists(final NodeUtils.PreOrderTraversal pot, final HTMLElement htmlElement)
		{
			getParsedHTML(pot).addToList(htmlElement);
		}
	}


	static class TableRowFactory extends HTMLElementFactory
	{
		@Override 
		HTMLElement toHTMLElement(final NodeUtils.PreOrderTraversal pot, final ParsedHTML parsedHTML,
				final Element element)
		{
			WebTable wt = getWebTable(pot);
			if (wt == null)
			{
				return null;
			}
			return wt.newTableRow(element);
		}

		private WebTable getWebTable(final NodeUtils.PreOrderTraversal pot)
		{
			return (WebTable)getClosestContext(pot, WebTable.class);
		}

		@Override
		protected boolean addToContext()
		{
			return true;
		}

		@Override
		protected void addToLists(final NodeUtils.PreOrderTraversal pot, final HTMLElement htmlElement)
		{
			getWebTable(pot).addRow((WebTable.TableRow)htmlElement);
		}
	}


	static class TableCellFactory extends HTMLElementFactory
	{
		@Override 
		HTMLElement toHTMLElement(final NodeUtils.PreOrderTraversal pot, final ParsedHTML parsedHTML,
				final Element element)
		{
			WebTable.TableRow tr = getTableRow(pot);
			if (tr == null)
			{
				return null;
			}
			return tr.newTableCell(element);
		}

		private WebTable.TableRow getTableRow(final NodeUtils.PreOrderTraversal pot)
		{
			return (WebTable.TableRow)getClosestContext(pot, WebTable.TableRow.class);
		}

		@Override
		protected boolean addToContext()
		{
			return true;
		}

		@Override
		protected void addToLists(final NodeUtils.PreOrderTraversal pot, final HTMLElement htmlElement)
		{
			getTableRow(pot).addTableCell((TableCell)htmlElement);
		}
	}

	static class FormControlFactory extends HTMLElementFactory
	{

		@Override HTMLElement toHTMLElement(final NodeUtils.PreOrderTraversal pot, final ParsedHTML parsedHTML,
				final Element element)
		{
			final WebForm form = getForm(pot);
			return form == null ? newControlWithoutForm(parsedHTML, element) : form
					.newFormControl(element);
		}

		private HTMLElement newControlWithoutForm(final ParsedHTML parsedHTML, final Element element)
		{
			if (element.getNodeName().equalsIgnoreCase("button")
					&& isValidNonFormButtonType(NodeUtils.getNodeAttribute(element, "type")))
			{
				return parsedHTML.toButtonWithoutForm(element);
			}
			else
			{
				return null;
			}
		}


		private boolean isValidNonFormButtonType(final String buttonType)
		{
			return buttonType.equals("") || buttonType.equalsIgnoreCase("button");
		}


		private WebForm getForm(final NodeUtils.PreOrderTraversal pot)
		{
			return getRootContext(pot)._activeForm;
		}

		@Override
		protected void addToLists(final NodeUtils.PreOrderTraversal pot, final HTMLElement htmlElement)
		{
			WebForm form = getForm(pot);
			if (form != null)
			{
				form.addFormControl((FormControl)htmlElement);
			}
		}
	}


	static class WebListFactory extends HTMLElementFactory
	{
		@Override HTMLElement toHTMLElement(final NodeUtils.PreOrderTraversal pot, final ParsedHTML parsedHTML,
				final Element element)
		{
			return parsedHTML.toOrderedList(element);
		}

		@Override
		protected boolean addToContext()
		{
			return true;
		}

		@Override
		protected void addToLists(final NodeUtils.PreOrderTraversal pot, final HTMLElement htmlElement)
		{
			TextBlock textBlock = getTextBlock(pot);
			if (textBlock != null)
			{
				textBlock.addList((WebList)htmlElement);
			}
		}

		private TextBlock getTextBlock(final NodeUtils.PreOrderTraversal pot)
		{
			return (TextBlock)getClosestContext(pot, TextBlock.class);
		}
	}


	static class ListItemFactory extends HTMLElementFactory
	{
		@Override HTMLElement toHTMLElement(final NodeUtils.PreOrderTraversal pot, final ParsedHTML parsedHTML,
				final Element element)
		{
			WebList webList = getWebList(pot);
			if (webList == null)
			{
				return null;
			}
			return webList.addNewItem(element);
		}

		private WebList getWebList(final NodeUtils.PreOrderTraversal pot)
		{
			return (WebList)getClosestContext(pot, WebList.class);
		}

		@Override
		protected boolean addToContext()
		{
			return true;
		}

		@Override
		protected void addToLists(final NodeUtils.PreOrderTraversal pot, final HTMLElement htmlElement)
		{
		}
	}


	private static final HashMap<String, HTMLElementFactory> _htmlFactoryClasses = new HashMap<String, HTMLElementFactory>();
	private static final HTMLElementFactory _defaultFactory = new DefaultElementFactory();

	static
	{
		_htmlFactoryClasses.put("a", new WebLinkFactory());
		_htmlFactoryClasses.put("area", new WebLinkFactory());
		_htmlFactoryClasses.put("form", new WebFormFactory());
		_htmlFactoryClasses.put("img", new WebImageFactory());
		_htmlFactoryClasses.put("applet", new WebAppletFactory());
		_htmlFactoryClasses.put("table", new WebTableFactory());
		_htmlFactoryClasses.put("tr", new TableRowFactory());
		_htmlFactoryClasses.put("td", new TableCellFactory());
		_htmlFactoryClasses.put("th", new TableCellFactory());
		_htmlFactoryClasses.put("frame", new WebFrameFactory());
		_htmlFactoryClasses.put("iframe", new WebIFrameFactory());
		_htmlFactoryClasses.put("script", new ScriptFactory());
		_htmlFactoryClasses.put("noscript", new NoScriptFactory());
		_htmlFactoryClasses.put("ol", new WebListFactory());
		_htmlFactoryClasses.put("ul", new WebListFactory());
		_htmlFactoryClasses.put("li", new ListItemFactory());

		for (int i = 0; i < TEXT_ELEMENTS.length; i++)
		{
			_htmlFactoryClasses.put(TEXT_ELEMENTS[i], new TextBlockFactory());
		}

		for (Iterator i = Arrays.asList(FormControl.getControlElementTags()).iterator(); i
				.hasNext();)
		{
			_htmlFactoryClasses.put((String)i.next(), new FormControlFactory());
		}
	}

	private static HTMLElementFactory getHTMLElementFactory(final String tagName)
	{
		final HTMLElementFactory factory = _htmlFactoryClasses.get(tagName);
		return factory != null ? factory : _defaultFactory;
	}


	private void loadElements()
	{
		if (!_updateElements)
		{
			return;
		}

		NodeUtils.NodeAction action = new NodeUtils.NodeAction()
		{
			public boolean processElement(NodeUtils.PreOrderTraversal pot, Element element)
			{
				HTMLElementFactory factory = getHTMLElementFactory(element.getNodeName()
						.toLowerCase());
				if (factory == null || !factory.isRecognized(getClientProperties()))
				{
					return true;
				}
				if (pot.getClosestContext(ContentConcealer.class) != null)
				{
					return true;
				}

				if (!_elements.containsKey(element))
				{
					factory.recordElement(pot, element, ParsedHTML.this);
				}
				if (factory.addToContext())
				{
					pot.pushContext(_elements.get(element));
				}

				return true;
			}

			public void processTextNode(NodeUtils.PreOrderTraversal pot, Node textNode)
			{
				if (textNode.getNodeValue().trim().length() == 0)
				{
					return;
				}

				Node parent = textNode.getParentNode();
				if (!parent.getNodeName().equalsIgnoreCase("body"))
				{
					return;
				}
				if (pot.getClosestContext(ContentConcealer.class) != null)
				{
					return;
				}
				new HtmlElementRecorder().recordHtmlElement(pot, textNode, newTextBlock(textNode));
			}
		};
		NodeUtils.PreOrderTraversal nt = new NodeUtils.PreOrderTraversal(getRootNode());
		nt.pushBaseContext(this);
		nt.perform(action);

		_updateElements = false;
	}


	private ClientProperties getClientProperties()
	{
		WebWindow window = _response.getWindow();
		return window == null ? ClientProperties.getDefaultProperties() : window.getClient()
				.getClientProperties();
	}


	private Button toButtonWithoutForm(final Element element)
	{
		return new Button(_response, element);
	}


	private WebForm toWebForm(final Element element)
	{
		return new WebForm(_response, _baseURL, element, _frame, _baseTarget, _characterSet);
	}


	private WebFrame toWebFrame(final Element element)
	{
		return new WebFrame(_response, _baseURL, element, _frame);
	}


	private WebFrame toWebIFrame(final Element element)
	{
		return new WebIFrame(_baseURL, element, _frame);
	}


	private WebLink toLinkAnchor(final Element child)
	{
		return (!isWebLink(child)) ? null : new WebLink(_response, _baseURL, child, _frame,
				_baseTarget, _characterSet);
	}


	private boolean isWebLink(final Node node)
	{
		return (node.getAttributes().getNamedItem("href") != null);
	}


	private WebImage toWebImage(final Element child)
	{
		return new WebImage(_response, this, _baseURL, child, _frame, _baseTarget, _characterSet);
	}


	private WebApplet toWebApplet(final Element element)
	{
		return new WebApplet(_response, element, _baseTarget);
	}


	private WebTable toWebTable(final Element element)
	{
		return new WebTable(_response, _frame, element, _baseURL, _baseTarget, _characterSet);
	}


	private TextBlock toTextBlock(final Element element)
	{
		return new TextBlock(_response, _frame, _baseURL, _baseTarget, element, _characterSet);
	}


	private TextBlock newTextBlock(final Node textNode)
	{
		return new TextBlock(_response, _frame, _baseURL, _baseTarget, textNode, _characterSet);
	}


	private WebList toOrderedList(final Element element)
	{
		return new WebList(_response, _frame, _baseURL, _baseTarget, element, _characterSet);
	}


	private void addToMaps(final Node node, final HTMLElement htmlElement)
	{
		_elements.put(node, htmlElement);
		if (htmlElement.getID() != null)
		{
			_elementsByID.put(htmlElement.getID(), htmlElement);
		}
		if (htmlElement.getName() != null)
		{
			addNamedElement(htmlElement.getName(), htmlElement);
		}
	}


	private void addNamedElement(final String name, final HTMLElement htmlElement)
	{
		List<HTMLElement> list = _elementsByName.get(name);
		if (list == null)
		{
			_elementsByName.put(name, list = new ArrayList<HTMLElement>());
		}
		list.add(htmlElement);
	}


	private void addToList(final HTMLElement htmlElement)
	{
		ArrayList<HTMLElement> list = getListForElement(htmlElement);
		if (list != null)
		{
			list.add(htmlElement);
		}
	}


	private ArrayList<HTMLElement> getListForElement(final HTMLElement element)
	{
		if (element instanceof WebLink)
		{
			return _linkList;
		}
		if (element instanceof WebForm)
		{
			return _formsList;
		}
		if (element instanceof WebImage)
		{
			return _imagesList;
		}
		if (element instanceof WebApplet)
		{
			return _appletList;
		}
		if (element instanceof WebTable)
		{
			return _tableList;
		}
		if (element instanceof WebFrame)
		{
			return _frameList;
		}
		if (element instanceof BlockElement)
		{
			return _blocksList;
		}
		return null;
	}


	/**
	 * Returns the first link which contains the specified text.
	 * 
	 * @param text
	 * @return Link
	 */
	public WebLink getLinkWith(final String text)
	{
		return getFirstMatchingLink(WebLink.MATCH_CONTAINED_TEXT, text);
	}


	/**
	 * Returns the link which contains the first image with the specified text
	 * as its 'alt' attribute.
	 * 
	 * @param text
	 * @return Link
	 */
	public WebLink getLinkWithImageText(final String text)
	{
		WebImage image = getImageWithAltText(text);
		return image == null ? null : image.getLink();
	}


	/**
	 * Returns the link found in the page with the specified name.
	 * 
	 * @param name
	 * @return Link
	 */
	public WebLink getLinkWithName(final String name)
	{
		return getFirstMatchingLink(WebLink.MATCH_NAME, name);
	}


	/**
	 * Returns the first link found in the page matching the specified criteria.
	 * 
	 * @param predicate
	 * @param criteria
	 * @return Link
	 */
	public WebLink getFirstMatchingLink(final HTMLElementPredicate predicate, final Object criteria)
	{
		WebLink[] links = getLinks();
		for (int i = 0; i < links.length; i++)
		{
			if (predicate.matchesCriteria(links[i], criteria))
			{
				return links[i];
			}
		}
		return null;
	}


	/**
	 * Returns all links found in the page matching the specified criteria.
	 * 
	 * @param predicate
	 * @param criteria
	 * @return Links
	 */
	public WebLink[] getMatchingLinks(final HTMLElementPredicate predicate, final Object criteria)
	{
		ArrayList<WebLink> matches = new ArrayList<WebLink>();
		WebLink[] links = getLinks();
		for (int i = 0; i < links.length; i++)
		{
			if (predicate.matchesCriteria(links[i], criteria))
			{
				matches.add(links[i]);
			}
		}
		return matches.toArray(new WebLink[matches.size()]);
	}


	/**
	 * Returns the image found in the page with the specified name.
	 * 
	 * @param name
	 * @return Image
	 */
	public WebImage getImageWithName(final String name)
	{
		WebImage[] images = getImages();
		for (int i = 0; i < images.length; i++)
		{
			if (HttpUnitUtils.matches(name, images[i].getName()))
			{
				return images[i];
			}
		}
		return null;
	}


	/**
	 * Returns the first image found in the page with the specified src
	 * attribute.
	 * 
	 * @param source
	 * @return Image
	 */
	public WebImage getImageWithSource(final String source)
	{
		WebImage[] images = getImages();
		for (int i = 0; i < images.length; i++)
		{
			if (HttpUnitUtils.matches(source, images[i].getSource()))
			{
				return images[i];
			}
		}
		return null;
	}


	/**
	 * Returns the first image found in the page with the specified alt
	 * attribute.
	 * 
	 * @param altText
	 * @return Image
	 */
	public WebImage getImageWithAltText(final String altText)
	{
		WebImage[] images = getImages();
		for (int i = 0; i < images.length; i++)
		{
			if (HttpUnitUtils.matches(altText, images[i].getAltText()))
			{
				return images[i];
			}
		}
		return null;
	}


	/**
	 * Returns the first table in the response which matches the specified
	 * predicate and value. Will recurse into any nested tables, as needed.
	 * 
	 * @param predicate
	 * @param criteria
	 * @return the selected table, or null if none is found
	 */
	public WebTable getFirstMatchingTable(final HTMLElementPredicate predicate, final Object criteria)
	{
		return getTableSatisfyingPredicate(getTables(), predicate, criteria);
	}

	/**
	 * Returns the tables in the response which match the specified predicate
	 * and value. Will recurse into any nested tables, as needed.
	 * 
	 * @param predicate
	 * @param criteria
	 * @return the selected tables, or null if none are found
	 */
	public WebTable[] getMatchingTables(final HTMLElementPredicate predicate, final Object criteria)
	{
		return getTablesSatisfyingPredicate(getTables(), predicate, criteria);
	}


	/**
	 * Returns the first table in the response which has the specified text as
	 * the full text of its first non-blank row and non-blank column. Will
	 * recurse into any nested tables, as needed.
	 * 
	 * @param text
	 * @return the selected table, or null if none is found
	 */
	public WebTable getTableStartingWith(final String text)
	{
		return getFirstMatchingTable(WebTable.MATCH_FIRST_NONBLANK_CELL, text);
	}


	/**
	 * Returns the first table in the response which has the specified text as a
	 * prefix of the text in its first non-blank row and non-blank column. Will
	 * recurse into any nested tables, as needed.
	 * 
	 * @param text
	 * @return the selected table, or null if none is found
	 */
	public WebTable getTableStartingWithPrefix(final String text)
	{
		return getFirstMatchingTable(WebTable.MATCH_FIRST_NONBLANK_CELL_PREFIX, text);
	}


	/**
	 * Returns the first table in the response which has the specified text as
	 * its summary attribute. Will recurse into any nested tables, as needed.
	 * 
	 * @param summary
	 * @return the selected table, or null if none is found
	 */
	public WebTable getTableWithSummary(final String summary)
	{
		return getFirstMatchingTable(WebTable.MATCH_SUMMARY, summary);
	}


	/**
	 * Returns the first table in the response which has the specified text as
	 * its ID attribute. Will recurse into any nested tables, as needed.
	 * 
	 * @param ID
	 * @return the selected table, or null if none is found
	 */
	public WebTable getTableWithID(final String ID)
	{
		return getFirstMatchingTable(WebTable.MATCH_ID, ID);
	}


	/**
	 * Returns a copy of the domain object model associated with this page.
	 * 
	 * @return Node
	 */
	public Node getDOM()
	{
		// JDo: see README
		// Better would be some read-only attribute
		// return getRootNode().cloneNode( /* deep */ true );
		return getRootNode();
	}

	// ---------------------------------- Object methods
	// --------------------------------

	/**
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString()
	{
		return _baseURL.toExternalForm() + System.getProperty("line.separator") + _rootNode;
	}


	// ---------------------------------- package members
	// --------------------------------


	/**
	 * Specifies the root node for this HTML fragment.
	 */
	void setRootNode(final Node rootNode)
	{
		if (_rootNode != null && rootNode != _rootNode)
		{
			throw new IllegalStateException("The root node has already been defined as "
					+ _rootNode + " and cannot be redefined as " + rootNode);
		}
		_rootNode = rootNode;
		_links = null;
		_forms = null;
		_images = null;
		_applets = null;
		_tables = null;
		_frames = null;
		_blocks = null;
		_updateElements = true;
	}


	/**
	 * Returns the base URL for this HTML segment.
	 */
	URL getBaseURL()
	{
		return _baseURL;
	}


	WebResponse getResponse()
	{
		return _response;
	}


	/**
	 * Returns the domain object model associated with this page, to be used
	 * internally.
	 */
	Node getOriginalDOM()
	{
		return getRootNode();
	}


	/**
	 * Returns the frames found in the page in the order in which they appear.
	 * 
	 * @return Frames
	 */
	public WebFrame[] getFrames()
	{
		if (_frames == null)
		{
			loadElements();
			_frames = _frameList.toArray(new WebFrame[_frameList.size()]);
		}
		return _frames;
	}


	// ---------------------------------- private members
	// --------------------------------


	Node getRootNode()
	{
		if (_rootNode == null)
		{
			throw new IllegalStateException("The root node has not been specified");
		}
		return _rootNode;
	}


	/**
	 * Returns the table with the specified text in its summary attribute.
	 */
	private WebTable getTableSatisfyingPredicate(final WebTable[] tables, final HTMLElementPredicate predicate,
			final Object value)
	{
		for (int i = 0; i < tables.length; i++)
		{
			if (predicate.matchesCriteria(tables[i], value))
			{
				return tables[i];
			}
			else
			{
				for (int j = 0; j < tables[i].getRowCount(); j++)
				{
					for (int k = 0; k < tables[i].getColumnCount(); k++)
					{
						TableCell cell = tables[i].getTableCell(j, k);
						if (cell != null)
						{
							WebTable[] innerTables = cell.getTables();
							if (innerTables.length != 0)
							{
								WebTable result = getTableSatisfyingPredicate(innerTables,
										predicate, value);
								if (result != null)
								{
									return result;
								}
							}
						}
					}
				}
			}
		}
		return null;
	}


	/**
	 * Returns the tables which match the specified criteria.
	 */
	private WebTable[] getTablesSatisfyingPredicate(final WebTable[] tables,
			final HTMLElementPredicate predicate, final Object value)
	{
		ArrayList<WebTable> matches = new ArrayList<WebTable>();
		for (int i = 0; i < tables.length; i++)
		{
			if (predicate.matchesCriteria(tables[i], value))
			{
				matches.add(tables[i]);
			}
			for (int j = 0; j < tables[i].getRowCount(); j++)
			{
				for (int k = 0; k < tables[i].getColumnCount(); k++)
				{
					TableCell cell = tables[i].getTableCell(j, k);
					if (cell != null)
					{
						WebTable[] innerTables = cell.getTables();
						if (innerTables.length != 0)
						{
							WebTable[] result = getTablesSatisfyingPredicate(innerTables,
									predicate, value);
							if (result != null && result.length > 0)
							{
								for (int l = 0; l < result.length; l++)
								{
									matches.add(result[l]);
								}
							}
						}
					}
				}
			}
		}
		if (matches.size() > 0)
		{
			return matches.toArray(new WebTable[matches.size()]);
		}
		else
		{
			return null;
		}
	}


	class WebIFrame extends WebFrame implements ContentConcealer
	{

		/**
		 * Constructor
		 * 
		 * @param baseURL
		 * @param frameNode
		 * @param parentFrame
		 */
		public WebIFrame(final URL baseURL, final Node frameNode, final FrameSelector parentFrame)
		{
			super(_response, baseURL, frameNode, parentFrame);
		}
	}


	class NoScriptElement extends HTMLElementBase implements ContentConcealer
	{

		/**
		 * Constructor
		 * 
		 * @param node
		 */
		public NoScriptElement(final Node node)
		{
			super(node);
		}


		@Override
		protected ScriptableDelegate newScriptable()
		{
			return null;
		}


		@Override
		protected ScriptableDelegate getParentDelegate()
		{
			return null;
		}
	}

}