org.htmlparser
Interface Tag

All Superinterfaces:

java.lang.Cloneable, Node

All Known Implementing Classes:

TagNode

public interface Tag

extends Node

This interface represents a tag (<xxx yyy="zzz">) in the HTML document. Adds capabilities to a Node that are specific to a tag.

Method Summary

boolean	breaksFlow() Determines if the given tag breaks the flow of text.
java.lang.String	getAttribute(java.lang.String name) Returns the value of an attribute.
Attribute	getAttributeEx(java.lang.String name) Returns the attribute with the given name.
java.util.Hashtable	getAttributes() Deprecated. Use getAttributesEx() instead.
java.util.Vector	getAttributesEx() Gets the attributes in the tag.
java.lang.String[]	getEnders() Return the set of tag names that cause this tag to finish.
int	getEndingLineNumber() Get the line number where this tag ends.
Tag	getEndTag() Get the end tag for this (composite) tag.
java.lang.String[]	getEndTagEnders() Return the set of end tag names that cause this tag to finish.
java.lang.String[]	getIds() Return the set of names handled by this tag.
java.lang.String	getRawTagName() Return the name of this tag.
int	getStartingLineNumber() Get the line number where this tag starts.
java.lang.String	getTagName() Return the name of this tag.
Scanner	getThisScanner() Return the scanner associated with this tag.
boolean	isEmptyXmlTag() Is this an empty xml tag of the form <tag/>.
boolean	isEndTag() Predicate to determine if this tag is an end tag (i.e.
void	removeAttribute(java.lang.String key) Remove the attribute with the given key, if it exists.
void	setAttribute(java.lang.String key, java.lang.String value) Set attribute with given key, value pair.
void	setAttribute(java.lang.String key, java.lang.String value, char quote) Set attribute with given key/value pair, the value is quoted by quote.
void	setAttributeEx(Attribute attribute) Set an attribute.
void	setAttributes(java.util.Hashtable attributes) Deprecated. Use setAttributesEx() instead.
void	setAttributesEx(java.util.Vector attribs) Sets the attributes.
void	setEmptyXmlTag(boolean emptyXmlTag) Set this tag to be an empty xml node, or not.
void	setEndTag(Tag tag) Set the end tag for this (composite) tag.
void	setTagName(java.lang.String name) Set the name of this tag.
void	setThisScanner(Scanner scanner) Set the scanner associated with this tag.

Methods inherited from interface org.htmlparser.Node

accept, clone, collectInto, doSemanticAction, getChildren, getEndPosition, getFirstChild, getLastChild, getNextSibling, getPage, getParent, getPreviousSibling, getStartPosition, getText, setChildren, setEndPosition, setPage, setParent, setStartPosition, setText, toHtml, toPlainTextString, toString

Method Detail

getAttribute

public java.lang.String getAttribute(java.lang.String name)

Returns the value of an attribute.

Parameters:

name - Name of attribute, case insensitive.

Returns:

The value associated with the attribute or null if it does not exist, or is a stand-alone.

See Also:

setAttribute(java.lang.String, java.lang.String)

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.String value)

Set attribute with given key, value pair. Figures out a quote character to use if necessary.

Parameters:

key - The name of the attribute.

value - The value of the attribute.

See Also:

getAttribute(java.lang.String), setAttribute(String,String,char)

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.String value,
                         char quote)

Set attribute with given key/value pair, the value is quoted by quote.

Parameters:

key - The name of the attribute.

value - The value of the attribute.

quote - The quote character to be used around value. If zero, it is an unquoted value.

See Also:

getAttribute(java.lang.String)

removeAttribute

public void removeAttribute(java.lang.String key)

Remove the attribute with the given key, if it exists.

Parameters:

key - The name of the attribute.

getAttributeEx

public Attribute getAttributeEx(java.lang.String name)

Returns the attribute with the given name.

Parameters:

name - Name of attribute, case insensitive.

Returns:

The attribute or null if it does not exist.

See Also:

setAttributeEx(org.htmlparser.Attribute)

setAttributeEx

public void setAttributeEx(Attribute attribute)

Set an attribute. This replaces an attribute of the same name. To set the zeroth attribute (the tag name), use setTagName().

Parameters:

attribute - The attribute to set.

See Also:

getAttributeEx(java.lang.String)

getAttributesEx

public java.util.Vector getAttributesEx()

Gets the attributes in the tag.

Returns:

Returns the list of Attributes in the tag.

See Also:

setAttributesEx(java.util.Vector)

setAttributesEx

public void setAttributesEx(java.util.Vector attribs)

Sets the attributes. NOTE: Values of the extended hashtable are two element arrays of String, with the first element being the original name (not uppercased), and the second element being the value.

Parameters:

attribs - The attribute collection to set.

See Also:

getAttributesEx()

getAttributes

public java.util.Hashtable getAttributes()

Deprecated. Use getAttributesEx() instead.

Gets the attributes in the tag. This is not the preferred method to get attributes, see getAttributesEx which returns a list of Attribute objects, which offer more information than the simple String objects available from this Hashtable.

Returns:

Returns a list of name/value pairs representing the attributes. These are not in order, the keys (names) are converted to uppercase and the values are not quoted, even if they need to be. The table will return null if there was no value for an attribute (either no equals sign or nothing to the right of the equals sign). A special entry with a key of SpecialHashtable.TAGNAME ("$<TAGNAME>$") holds the tag name. The conversion to uppercase is performed with an ENGLISH locale.

See Also:

setAttributes(java.util.Hashtable)

setAttributes

public void setAttributes(java.util.Hashtable attributes)

Deprecated. Use setAttributesEx() instead.

Sets the attributes. A special entry with a key of SpecialHashtable.TAGNAME ("$<TAGNAME>$") sets the tag name.

Parameters:

attributes - The attribute collection to set.

See Also:

getAttributes()

getTagName

public java.lang.String getTagName()

Return the name of this tag.

Note: This value is converted to uppercase and does not begin with "/" if it is an end tag. Nor does it end with a slash in the case of an XML type tag. The conversion to uppercase is performed with an ENGLISH locale.

Returns:

The tag name.

See Also:

setTagName(java.lang.String)

setTagName

public void setTagName(java.lang.String name)

Set the name of this tag. This creates or replaces the first attribute of the tag (the zeroth element of the attribute vector).

Parameters:

name - The tag name.

See Also:

getTagName()

getRawTagName

public java.lang.String getRawTagName()

Return the name of this tag.

Returns:

The tag name or null if this tag contains nothing or only whitespace.

breaksFlow

public boolean breaksFlow()

Determines if the given tag breaks the flow of text.

Returns:

true if following text would start on a new line, false otherwise.

isEndTag

public boolean isEndTag()

Predicate to determine if this tag is an end tag (i.e. </HTML>).

Returns:

true if this tag is an end tag.

isEmptyXmlTag

public boolean isEmptyXmlTag()

Is this an empty xml tag of the form <tag/>.

Returns:

true if the last character of the last attribute is a '/'.

setEmptyXmlTag

public void setEmptyXmlTag(boolean emptyXmlTag)

Set this tag to be an empty xml node, or not. Adds or removes an ending slash on the tag.

Parameters:

emptyXmlTag - If true, ensures there is an ending slash in the node, i.e. <tag/>, otherwise removes it.

getIds

public java.lang.String[] getIds()

Return the set of names handled by this tag. Since this a a generic tag, it has no ids.

Returns:

The names to be matched that create tags of this type.

getEnders

public java.lang.String[] getEnders()

Return the set of tag names that cause this tag to finish. These are the normal (non end tags) that if encountered while scanning (a composite tag) will cause the generation of a virtual tag. Since this a a non-composite tag, the default is no enders.

Returns:

The names of following tags that stop further scanning.

getEndTagEnders

public java.lang.String[] getEndTagEnders()

Return the set of end tag names that cause this tag to finish. These are the end tags that if encountered while scanning (a composite tag) will cause the generation of a virtual tag. Since this a a non-composite tag, it has no end tag enders.

Returns:

The names of following end tags that stop further scanning.

getEndTag

public Tag getEndTag()

Get the end tag for this (composite) tag. For a non-composite tag this always returns null.

Returns:

The tag that terminates this composite tag, i.e. </HTML>.

See Also:

setEndTag(org.htmlparser.Tag)

setEndTag

public void setEndTag(Tag tag)

Set the end tag for this (composite) tag. For a non-composite tag this is a no-op.

Parameters:

tag - The tag that closes this composite tag, i.e. </HTML>.

See Also:

getEndTag()

getThisScanner

public Scanner getThisScanner()

Return the scanner associated with this tag.

Returns:

The scanner associated with this tag.

See Also:

setThisScanner(org.htmlparser.scanners.Scanner)

setThisScanner

public void setThisScanner(Scanner scanner)

Set the scanner associated with this tag.

Parameters:

scanner - The scanner for this tag.

See Also:

getThisScanner()

getStartingLineNumber

public int getStartingLineNumber()

Get the line number where this tag starts.

Returns:

The (zero based) line number in the page where this tag starts.

getEndingLineNumber

public int getEndingLineNumber()

Get the line number where this tag ends.

Returns:

The (zero based) line number in the page where this tag ends.