org.apache.portals.applications.webcontent2.portlet.rewriter

Class BasicRewriter

java.lang.Object

org.apache.portals.applications.webcontent2.portlet.rewriter.AbstractRewriter

org.apache.portals.applications.webcontent2.portlet.rewriter.BasicRewriter

All Implemented Interfaces:

Rewriter

Direct Known Subclasses:

RulesetRewriterImpl, TicketParamRewriter

public class BasicRewriter
extends AbstractRewriter
implements Rewriter

BasicRewriter

Version:

$Id: BasicRewriter.java 891414 2009-12-16 20:19:02Z rwatler $

Author:

David Sean Taylor

Field Summary

Fields inherited from class org.apache.portals.applications.webcontent2.portlet.rewriter.AbstractRewriter

log

Constructor Summary

Constructors

Constructor and Description
BasicRewriter()

Method Summary

Methods

Modifier and Type	Method and Description
String	rewriteText(String tag, String text) This event is the inteface between the Rewriter and ParserAdaptor for rewriting text.
String	rewriteUrl(String url, String tag, String attribute) This event is the inteface between the Rewriter and ParserAdaptor for rewriting URLs.
boolean	shouldRemoveComments() Returns true if all comments should be removed.
boolean	shouldRemoveTag(String tag) Returns true if the tag should be removed, otherwise false.
boolean	shouldStripTag(String tag) Returns true if the tag should be stripped, otherwise false.

Methods inherited from class org.apache.portals.applications.webcontent2.portlet.rewriter.AbstractRewriter

enterConvertTagEvent, enterConvertTextEvent, 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.portals.applications.webcontent2.portlet.rewriter.Rewriter

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

Constructor Detail

BasicRewriter

public BasicRewriter()

Method Detail

rewriteUrl

public String rewriteUrl(String url,
                String tag,
                String attribute)

Description copied from interface: Rewriter

This event is the inteface between the Rewriter and ParserAdaptor for rewriting URLs. The ParserAdaptor calls back the Rewriter when it finds a URL that is a candidate to be rewritten. The Rewriter rewrites the URL and returns it as the result of this function.

Specified by:

rewriteUrl in interface Rewriter

Specified by:

rewriteUrl in class AbstractRewriter

Parameters:

url - the URL to be rewritten

tag - The tag being processed

attribute - The current attribute being processsed

rewriteText

public String rewriteText(String tag,
                 String text)

Description copied from interface: Rewriter

This event is the inteface between the Rewriter and ParserAdaptor for rewriting text. The ParserAdaptor calls back the Rewriter when it finds text that is a candidate to be rewritten. The Rewriter rewrites the text and returns it as the result of this function.

Specified by:

rewriteText in interface Rewriter

Parameters:

tag - The tag being processed

text - The current text being processsed

shouldRemoveTag

public boolean shouldRemoveTag(String tag)

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

Returns:

true if the tag should be removed.

shouldStripTag

public boolean shouldStripTag(String tag)

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

Returns:

true if the tag should be stripped.

shouldRemoveComments

public boolean shouldRemoveComments()

Description copied from interface: Rewriter

Returns true if all comments should be removed.

Specified by:

shouldRemoveComments in interface Rewriter

Returns:

true If all comments should be removed.