org.apache.jetspeed.rewriter.rules
Interface Rule

All Superinterfaces:

Identified

All Known Implementing Classes:

RuleImpl

public interface Rule
extends Identified

Rule

Version:

$Id: Rule.java 516448 2007-03-09 16:25:47Z ate $

Author:

David Sean Taylor

Method Summary

boolean	getPopup() Flag indicating whether to rewrite links as popups.
String	getSuffix() Suffix string to append to the rewritten URL.
boolean	getUseBase() Flag indicating whether to use the Base URL for this rewriter.
void	setPopup(boolean flag) Flag indicating whether to rewrite links as popups.
void	setSuffix(String suffix) Suffix string to append to the rewritten URL.
void	setUseBase(boolean flag) Flag indicating whether to use the Base URL for this rewriter.
boolean	shouldRewrite(String url) Checks to see if a URL should be rewritten or not.

Methods inherited from interface org.apache.jetspeed.rewriter.rules.Identified

getId, setId

Method Detail

getUseBase

boolean getUseBase()

Flag indicating whether to use the Base URL for this rewriter. The default setting is true, use the rewriter's Base URL.

Returns:

true if this rule uses the Base URL

setUseBase

void setUseBase(boolean flag)

Flag indicating whether to use the Base URL for this rewriter. The default setting is true, use the rewriter's Base URL.

Parameters:

true - if this rule uses the Base URL

getSuffix

String getSuffix()

Suffix string to append to the rewritten URL.

Returns:

the value of the suffix string.

setSuffix

void setSuffix(String suffix)

Suffix string to append to the rewritten URL.

Parameters:

the - value of the suffix string.

getPopup

boolean getPopup()

Flag indicating whether to rewrite links as popups. The default setting is false, do not rewrite as a popup.

Returns:

true if this rule rewrites links as popups

setPopup

void setPopup(boolean flag)

Flag indicating whether to rewrite links as popups. The default setting is false, do not rewrite as a popup.

Parameters:

true - if this rule rewrites links as popups

shouldRewrite

boolean shouldRewrite(String url)

Checks to see if a URL should be rewritten or not.

Parameters:

url -