org.htmlparser

Class StringNodeFactory

java.lang.Object

org.htmlparser.PrototypicalNodeFactory

org.htmlparser.StringNodeFactory

All Implemented Interfaces:

java.io.Serializable, NodeFactory

Deprecated.

Use PrototypicalNodeFactory#setTextPrototype(Text)

A more efficient implementation of affecting all string nodes, is to replace the Text node prototype in the PrototypicalNodeFactory with a custom TextNode that performs the required operation.

For example, if you were using:

 StringNodeFactory factory = new StringNodeFactory();
 factory.setDecode(true);
 

to decode all text issued from Text.toPlainTextString(), you would instead create a subclass of TextNode and set it as the prototype for text node generation:

 PrototypicalNodeFactory factory = new PrototypicalNodeFactory ();
 factory.setTextPrototype (new TextNode () {
     public String toPlainTextString()
     {
         return (org.htmlparser.util.Translate.decode (super.toPlainTextString ()));
     }
 });
 

Similar constructs apply to removing escapes and converting non-breaking spaces, which were the examples previously provided.

Using a subclass avoids the wrapping and delegation inherent in the decorator pattern, with subsequent improvements in processing speed and memory usage.

public class StringNodeFactory
extends PrototypicalNodeFactory
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	mConvertNonBreakingSpaces Deprecated. Flag to tell the parser to convert non breaking space (from ? to a space " ").
protected boolean	mDecode Deprecated. Flag to tell the parser to decode strings returned by StringNode's toPlainTextString.
protected boolean	mRemoveEscapes Deprecated. Flag to tell the parser to remove escape characters, like \n and \t, returned by StringNode's toPlainTextString.

Fields inherited from class org.htmlparser.PrototypicalNodeFactory

mBlastocyst, mRemark, mTag, mText

Constructor Summary

Constructors

Constructor and Description
StringNodeFactory() Deprecated.

Method Summary

Modifier and Type	Method and Description
Text	createStringNode(Page page, int start, int end) Deprecated. Create a new string node.
boolean	getConvertNonBreakingSpaces() Deprecated. Get the non-breaking space replacing state.
boolean	getDecode() Deprecated. Get the decoding state.
boolean	getRemoveEscapes() Deprecated. Get the escape removing state.
void	setConvertNonBreakingSpaces(boolean convert) Deprecated. Set the non-breaking space replacing state.
void	setDecode(boolean decode) Deprecated. Set the decoding state.
void	setRemoveEscapes(boolean remove) Deprecated. Set the escape removing state.

Methods inherited from class org.htmlparser.PrototypicalNodeFactory

clear, createRemarkNode, createTagNode, get, getRemarkPrototype, getTagNames, getTagPrototype, getTextPrototype, put, registerTag, registerTags, remove, setRemarkPrototype, setTagPrototype, setTextPrototype, unregisterTag

Methods inherited from class java.lang.Object

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

Field Detail

mDecode

protected boolean mDecode

Deprecated.

Flag to tell the parser to decode strings returned by StringNode's toPlainTextString. Decoding occurs via the method, org.htmlparser.util.Translate.decode()

mRemoveEscapes

protected boolean mRemoveEscapes

Deprecated.

Flag to tell the parser to remove escape characters, like \n and \t, returned by StringNode's toPlainTextString. Escape character removal occurs via the method, org.htmlparser.util.ParserUtils.removeEscapeCharacters()

mConvertNonBreakingSpaces

protected boolean mConvertNonBreakingSpaces

Deprecated.

Flag to tell the parser to convert non breaking space (from ? to a space " "). If true, this will happen inside StringNode's toPlainTextString.

Constructor Detail

StringNodeFactory

public StringNodeFactory()

Deprecated.

Method Detail

createStringNode

public Text createStringNode(Page page,
                             int start,
                             int end)

Deprecated.

Create a new string node.

Specified by:

createStringNode in interface NodeFactory

Overrides:

createStringNode in class PrototypicalNodeFactory

Parameters:

page - The page the node is on.

start - The beginning position of the string.

end - The ending positiong of the string.

Returns:

A text node comprising the indicated characters from the page.

setDecode

public void setDecode(boolean decode)

Deprecated.

Set the decoding state.

Parameters:

decode - If true, string nodes decode text using Translate.decode(java.lang.String).

getDecode

public boolean getDecode()

Deprecated.

Get the decoding state.

Returns:

true if string nodes decode text.

setRemoveEscapes

public void setRemoveEscapes(boolean remove)

Deprecated.

Set the escape removing state.

Parameters:

remove - If true, string nodes remove escape characters.

getRemoveEscapes

public boolean getRemoveEscapes()

Deprecated.

Get the escape removing state.

Returns:

The removing state.

setConvertNonBreakingSpaces

public void setConvertNonBreakingSpaces(boolean convert)

Deprecated.

Set the non-breaking space replacing state.

Parameters:

convert - If true, string nodes replace ;nbsp; characters with spaces.

getConvertNonBreakingSpaces

public boolean getConvertNonBreakingSpaces()

Deprecated.

Get the non-breaking space replacing state.

Returns:

The replacing state.