org.sitemesh.content.tagrules.html

Class TitleExtractingRule

java.lang.Object

org.sitemesh.tagprocessor.BasicRule

org.sitemesh.tagprocessor.BasicBlockRule

org.sitemesh.content.tagrules.html.TitleExtractingRule

All Implemented Interfaces:

TagRule

public class TitleExtractingRule
extends BasicBlockRule

Extracts the contents of the <title> element from the page and exports it as the title property.

Author:

Joe Walnes

Field Summary

Fields inherited from class org.sitemesh.tagprocessor.BasicRule

tagProcessorContext

Constructor Summary

Constructors

Constructor and Description
TitleExtractingRule(ContentProperty propertyToExport)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	processEnd(Tag tag, Object data) Called when a block is ended (i.e.
protected Object	processStart(Tag tag) Called when a block is started (i.e.

Methods inherited from class org.sitemesh.tagprocessor.BasicBlockRule

process

Methods inherited from class org.sitemesh.tagprocessor.BasicRule

setTagProcessorContext

Methods inherited from class java.lang.Object

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

Constructor Detail

TitleExtractingRule

public TitleExtractingRule(ContentProperty propertyToExport)

Method Detail

processStart

protected Object processStart(Tag tag)
                       throws IOException

Description copied from class: BasicBlockRule

Called when a block is started (i.e. <opening> tag is encountered).

Specified by:

processStart in class BasicBlockRule

Parameters:

tag - Opening tag.

Returns:

Any data that needs to be passed to BasicBlockRule.processEnd(Tag, Object). May be null.

Throws:

IOException

processEnd

protected void processEnd(Tag tag,
              Object data)
                   throws IOException

Description copied from class: BasicBlockRule

Called when a block is ended (i.e. </closing> tag is encountered).

Specified by:

processEnd in class BasicBlockRule

Parameters:

tag - Closing tag. This will not have any attributes available (as they are associated with an opening tag. To get access to the attributes, the BasicBlockRule.processStart(Tag) method should access them and return them as data.

data - Data returned from BasicBlockRule.processStart(Tag). May be null.

Throws:

IOException