org.apache.jetspeed.rewriter.rules
Interface Ruleset

All Superinterfaces:

Identified

All Known Implementing Classes:

RulesetImpl

public interface Ruleset
extends Identified

Ruleset

Version:

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

Author:

David Sean Taylor

Method Summary

boolean	getRemoveComments() Get the remove comments flag for removing comments from the markup source.
Rule	getRule(String ruleId) Given a rule identifier, lookup and return a rule object.
Collection	getRules() Get a collection of rules for this rule set.
Tag	getTag(String tagId) Given a tag identifier, lookup and return a tag object.
Collection	getTags() Get a collection of markup tags for this rule set.
void	setRemoveComments(boolean flag) Set the remove comments flag for removing comments from the markup source.
void	sync() Synchronize the Ruleset

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

getId, setId

Method Detail

getRemoveComments

boolean getRemoveComments()

Get the remove comments flag for removing comments from the markup source.

Returns:

true True if comments should be removed.

setRemoveComments

void setRemoveComments(boolean flag)

Set the remove comments flag for removing comments from the markup source.

Parameters:

flag - True if comments should be removed.

getTag

Tag getTag(String tagId)

Given a tag identifier, lookup and return a tag object.

Parameters:

tagId - the unique tag identifier

Returns:

the tag object for the given identifier

getRule

Rule getRule(String ruleId)

Given a rule identifier, lookup and return a rule object.

Parameters:

ruleId - the unique rule identifier

Returns:

the rule object for the given identifier

getRules

Collection getRules()

Get a collection of rules for this rule set.

Returns:

A collection of rules.

getTags

Collection getTags()

Get a collection of markup tags for this rule set.

Returns:

A collection of markup tags.

sync

void sync()

Synchronize the Ruleset