1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.jetspeed.rewriter.rules;
18
19 import java.util.Collection;
20
21 /***
22 * Ruleset
23 *
24 * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
25 * @version $Id: Ruleset.java 516448 2007-03-09 16:25:47Z ate $
26 */
27 public interface Ruleset extends Identified
28 {
29 /***
30 * Get the remove comments flag for removing comments from the markup source.
31 *
32 * @return true True if comments should be removed.
33 */
34 public boolean getRemoveComments();
35
36 /***
37 * Set the remove comments flag for removing comments from the markup source.
38 *
39 * @param flag True if comments should be removed.
40 */
41 public void setRemoveComments(boolean flag);
42
43 /***
44 * Given a tag identifier, lookup and return a tag object.
45 *
46 * @param tagId the unique tag identifier
47 * @return the tag object for the given identifier
48 */
49 Tag getTag(String tagId);
50
51 /***
52 * Given a rule identifier, lookup and return a rule object.
53 *
54 * @param ruleId the unique rule identifier
55 * @return the rule object for the given identifier
56 */
57 Rule getRule(String ruleId);
58
59
60 /***
61 * Get a collection of rules for this rule set.
62 *
63 * @return A collection of rules.
64 */
65 Collection getRules();
66
67 /***
68 * Get a collection of markup tags for this rule set.
69 *
70 * @return A collection of markup tags.
71 */
72 public Collection getTags();
73
74 /***
75 * Synchronize the Ruleset
76 *
77 */
78 void sync();
79
80 }