|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.digester3.Rule
public abstract class Rule
Concrete implementations of this class implement actions to be taken when a corresponding nested pattern of XML elements has been matched.
Writing a custom Rule is considered perfectly normal when using Digester, and is encouraged whenever the default set of Rule classes don't meet your requirements; the digester framework can help process xml even when the built-in rules aren't quite what is needed. Creating a custom Rule is just as easy as subclassing javax.servlet.http.HttpServlet for webapps, or javax.swing.Action for GUI applications.
If a rule wishes to manipulate a digester stack (the default object stack, a named stack, or the parameter stack) then it should only ever push objects in the rule's begin method and always pop exactly the same number of objects off the stack during the rule's end method. Of course peeking at the objects on the stacks can be done from anywhere.
Rule objects should be stateless, ie they should not update any instance member during the parsing process. A rule instance that changes state will encounter problems if invoked in a "nested" manner; this can happen if the same instance is added to digester multiple times or if a wildcard pattern is used which can match both an element and a child of the same element. The digester object stack and named stacks should be used to store any state that a rule requires, making the rule class safe under all possible uses.
Constructor Summary | |
---|---|
Rule()
|
Method Summary | |
---|---|
void |
begin(String namespace,
String name,
Attributes attributes)
This method is called when the beginning of a matching XML element is encountered. |
void |
body(String namespace,
String name,
String text)
This method is called when the body of a matching XML element is encountered. |
void |
end(String namespace,
String name)
This method is called when the end of a matching XML element is encountered. |
void |
finish()
This method is called after all parsing methods have been called, to allow Rules to remove temporary data. |
Digester |
getDigester()
Return the Digester with which this Rule is associated. |
String |
getNamespaceURI()
Return the namespace URI for which this Rule is relevant, if any. |
void |
setDigester(Digester digester)
Set the Digester with which this Rule is associated. |
void |
setNamespaceURI(String namespaceURI)
Set the namespace URI for which this Rule is relevant, if any. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Rule()
Method Detail |
---|
public Digester getDigester()
public void setDigester(Digester digester)
Digester
with which this Rule
is associated.
digester
- the Digester
with which this Rule
is associatedpublic String getNamespaceURI()
public void setNamespaceURI(String namespaceURI)
namespaceURI
- Namespace URI for which this Rule is relevant, or null
to match independent of
namespace.public void begin(String namespace, String name, Attributes attributes) throws Exception
namespace
- the namespace URI of the matching element, or an empty string if the parser is not namespace
aware or the element has no namespacename
- the local name if the parser is namespace aware, or just the element name otherwiseattributes
- The attribute list of this element
Exception
- if any error occurspublic void body(String namespace, String name, String text) throws Exception
namespace
- the namespace URI of the matching element, or an empty string if the parser is not namespace
aware or the element has no namespacename
- the local name if the parser is namespace aware, or just the element name otherwisetext
- The text of the body of this element
Exception
- if any error occurspublic void end(String namespace, String name) throws Exception
namespace
- the namespace URI of the matching element, or an empty string if the parser is not namespace
aware or the element has no namespacename
- the local name if the parser is namespace aware, or just the element name otherwise
Exception
- if any error occurspublic void finish() throws Exception
Exception
- if any error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |