org.apache.jetspeed.rewriter
Class RulesetRewriterImpl

java.lang.Object
  org.apache.jetspeed.rewriter.AbstractRewriter
      org.apache.jetspeed.rewriter.BasicRewriter
          org.apache.jetspeed.rewriter.RulesetRewriterImpl

All Implemented Interfaces:

Rewriter, RulesetRewriter

Direct Known Subclasses:

WebContentRewriter

public class RulesetRewriterImpl
extends BasicRewriter
implements RulesetRewriter

RuleBasedRewriter

Version:

$Id: RulesetRewriterImpl.java 517121 2007-03-12 07:45:49Z ate $

Author:

David Sean Taylor

Field Summary

protected static org.apache.commons.logging.Log

log

Constructor Summary

RulesetRewriterImpl()

Method Summary

void	enterConvertTagEvent(java.lang.String tagid, MutableAttributes attributes) Rewriter event called back just before tag conversion (rewriter callbacks) begins by the ParserAdaptor.
Ruleset	getRuleset() Get the Ruleset configuration for this rewriter.
java.lang.String	rewriteUrl(java.lang.String url, java.lang.String tag, java.lang.String attribute, MutableAttributes otherAttributes) rewriteURL
void	setRuleset(Ruleset ruleset) Set the Ruleset configuration for this rewriter.
boolean	shouldRemoveComments() Returns true if all comments should be removed.
boolean	shouldRemoveTag(java.lang.String tagid) Returns true if the tag should be removed, otherwise false.
boolean	shouldStripTag(java.lang.String tagid) Returns true if the tag should be stripped, otherwise false.

Methods inherited from class org.apache.jetspeed.rewriter.BasicRewriter

rewriteUrl

Methods inherited from class org.apache.jetspeed.rewriter.AbstractRewriter

enterEndTagEvent, enterSimpleTagEvent, enterStartTagEvent, enterText, exitEndTagEvent, exitSimpleTagEvent, exitStartTagEvent, getBaseRelativeUrl, getBaseUrl, getUseProxy, parse, rewrite, setBaseUrl, setUseProxy

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jetspeed.rewriter.Rewriter

enterEndTagEvent, enterSimpleTagEvent, enterStartTagEvent, enterText, exitEndTagEvent, exitSimpleTagEvent, exitStartTagEvent, getBaseRelativeUrl, getBaseUrl, getUseProxy, parse, rewrite, rewriteUrl, setBaseUrl, setUseProxy

Field Detail

log

protected static final org.apache.commons.logging.Log log

Constructor Detail

RulesetRewriterImpl

public RulesetRewriterImpl()

Method Detail

shouldStripTag

public boolean shouldStripTag(java.lang.String tagid)

Description copied from interface: Rewriter

Returns true if the tag should be stripped, otherwise false. Stripping tags removes the start and end tag, plus all tags and content in between the start and end tag.

Specified by:

shouldStripTag in interface Rewriter

Overrides:

shouldStripTag in class BasicRewriter

Returns:

true if the tag should be stripped.

shouldRemoveTag

public boolean shouldRemoveTag(java.lang.String tagid)

Description copied from interface: Rewriter

Returns true if the tag should be removed, otherwise false. Removing a tag only removes the tag but not the contents in between the start and end tag.

Specified by:

shouldRemoveTag in interface Rewriter

Overrides:

shouldRemoveTag in class BasicRewriter

Returns:

true if the tag should be removed.

setRuleset

public void setRuleset(Ruleset ruleset)

Description copied from interface: RulesetRewriter

Set the Ruleset configuration for this rewriter.

Specified by:

setRuleset in interface RulesetRewriter

Parameters:

ruleset - The Ruleset configuration.

getRuleset

public Ruleset getRuleset()

Description copied from interface: RulesetRewriter

Get the Ruleset configuration for this rewriter.

Specified by:

getRuleset in interface RulesetRewriter

Returns:

The Ruleset configuration.

shouldRemoveComments

public boolean shouldRemoveComments()

Description copied from interface: Rewriter

Returns true if all comments should be removed.

Specified by:

shouldRemoveComments in interface Rewriter

Overrides:

shouldRemoveComments in class BasicRewriter

Returns:

true If all comments should be removed.

enterConvertTagEvent

public void enterConvertTagEvent(java.lang.String tagid,
                                 MutableAttributes attributes)

Description copied from interface: Rewriter

Rewriter event called back just before tag conversion (rewriter callbacks) begins by the ParserAdaptor.

Specified by:

enterConvertTagEvent in interface Rewriter

Overrides:

enterConvertTagEvent in class AbstractRewriter

Parameters:

tagid - The name of the tag being processed.

attributes - The attribute list for the tag.

rewriteUrl

public java.lang.String rewriteUrl(java.lang.String url,
                                   java.lang.String tag,
                                   java.lang.String attribute,
                                   MutableAttributes otherAttributes)

rewriteURL

Parameters:

url -

tag -

attribute -

otherAttributes -

Returns:

the modified url which is a portlet action Rewrites all urls HREFS with a portlet action