SimpleHtmlParse (CleanCode Java Libraries API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.cleancode.net
Class SimpleHtmlParse

java.lang.Object
  com.cleancode.net.SimpleHtmlParse

public class SimpleHtmlParse
extends Object
extends Object

Extracts selected constructs from the structure of an HTML document. Each piece is returned as a name/value pair through a SimpleHtmlParse.Callback object. The caller may then do whatever is needed to the element.

These items are extracted from the document header:

document title (title elements)
document type definition
meta elements
included files (link elements)

These items are extracted from the document body:

hyperlinks (a elements)

These input elements fall into three categories, which determine the resulting output. The general form is (category:name, value). The name may sometimes be blank, in which case the preceding colon is omitted.

Case 1: Just a value
Example: <TITLE>value</TITLE> returned as (Title, value)
Example: <!DOCTYPE HTML PUBLIC value "http://www.w3.org/TR/REC-html40/loose.dtd"> returned as (DTD, value)
Case 2: name and value
Example: <META name=name content=value> returned as (Meta:name, value)
Example: <LINK rel=name href=value> returned as (Include:name, value)
Case 3: value with element text
Example: <A href=value>text</A> returned as (Link:text, value)
Case 4: value with element image
Example: <A href=value><img src="filename"></A> returned as (Link:[#filename#], value)

Sample Usage:

  SimpleHtmlParse parse = new SimpleHtmlParse(
    new SimpleHtmlParse.Callback() {
      public void addHtmlElement(String paramName, String paramValue) {
        System.out.println("NAME: "+paramName+", VALUE: "+paramValue);
      }
    });
  parse.collectElements(content);

Since:: CleanCode 0.9
Version:: $Revision: 9 $
Author:: Michael Sorens

Nested Class Summary
`static interface`	`SimpleHtmlParse.Callback` This interface provides a callback for the user to handle each parsed element.
`static class`	`SimpleHtmlParse.Test` A standalone test class.

Field Summary
`static String`	`VERSION` Current version of this class.

Constructor Summary
`SimpleHtmlParse(SimpleHtmlParse.Callback cb)` Constructs a SimpleHtmlParse object with a Callback object.

Method Summary
`void`	`collectElements(String content)` Evaluates the HTML document, passing each match to the Callback object for disposition.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

VERSION

public static final String VERSION

Current version of this class.

Constructor Detail