Learning and use Jakarta Digesterby Philipp K. Janert, ph.d.10 / 23/2002 Turning An XML Document Into a Corresponding Hierarchy Of Java Bean Objects Is A Fairly Common Task. In A Previous Article, i
Described How To Accomplish this using the standard sax and dom apis.
Although Powerful and Flexible, Both Apis Are, In Effect, TOO LOW-level for the specific Task At Hand. Furthermore, The
UNMARSHALLING Procedure Itself Requires A Fair Amount of Coding: a parse-stack must be maintained by Sax, and the
DOM-Tree Must Be NaviGated When Using DOM.
This is where the apache jakarta commons digester framework comes in.
The Jakarta Digester FrameworkThe Jakarta Digester Framework Grew Out of The Jakarta Struts Web Toolkit. Originally Developed to Process The Central
Struts-config.xml configuration file, it is soon recognized what the framework was more generally useful, and moved to the
Jakarta Commons Project, The Stated Goal of Which Is To Provide A "Repository of Reusable Java Components" The Most Recent
Version, Digester 1.3, Was ReleaseD on August 13, 2002.
The Digester Class Lets The Application Programmer Specify A Set of Actions To Be Performed WHENEVER The Parser Encounters
Certain Simple Patterns in the XML Document. The Digester Framework Comes with 10 prepackaged "Rules," Which Cover Most of
The Required Tasks When Unmarshalling XML (Such As Creating A Bean Or Setting A Bean Property), But Each User is Free To
Define and Implement His Or Her Own Rules, as Necessary.
THE EXAMPLE Document and Beansin this Example, We will unmarshall the Same XML Document That We buy in the prepious article:
Author 1 Title 1 </ title> </ book> <book> <author> author 2 </ author> <title> his one book </ title> </ book ></p>
<p><magazine> <name> MAG TITLE 1 </ Name></p>
<p><Article Page = "5"> <headline> Some headline </ head> </ article></p>
<p><article page = "9"> <headline> another headline </ headline> </ article> </ magazine></p>
<p><book> <author> Author 2 </ author> <title> his Other Book </ Title> </ book></p>
<p><magazine> <name> MAG TITLE 2 </ Name></p>
<p><Article Page = "17"> <headline> second headline </ headline> </ article> </ magazine></p>
<p></ Catalog> The Bean Classes Are Also The Same, Except for One Important Change: in The Previous Article, i Had Declared these Classes To</p>
<p>Have Package Scope - Primarily So That I Could Define All of Them in The Same Source File! Using The Digester Framework,</p>
<p>THIS NO LONGER POSIBLE; The Classes Need To Be Decland AS PUBLIC (As IS Required For Classes Conforming to the Javabeans</p>
<p>Specification:</p>
<p>Import java.util.vector;</p>
<p>Public class catalog {private vector books; private vector magazines;</p>
<p>Public catalog () {books = new vector (); magazines = new vector ();</p>
<p>Public void addbook (book rhs) {books.addelement (rhs);} public void addmagazine (magazine rhs) {magazines.addelement (rhs)</p>
<p>Public string toString () {string newline = system.getProperty ("line.separator"); stringbuffer buf = new stringbuffer (); buf.append ("--- books ---") .append (newline); for INT i = 0; i <books.size (); i ) {buf.append (books.ementatat (i)) .append (newline);}</p>
<p>BUF.Append ("--- magazines ---") .append (newline); for (int i = 0; i <magazines.size (); i ) {buf.Append (Magazines.Elementat (i)). append (newline);</p>
<p>Return buf.tostring ();}}</p>
<p>-------------------------------------------------- ------------------------------</p>
<p>Public class book {private string author; private string title;</p>
<p>Public book () {}</p>
<p>Public void setauthor (string rhs) {author = rhs;} public void settitle (string rhs) {title = rhs;</p>
<p>Public string toString () {return "book: author = '" author "' title = '" title "}}</p>
<p>-------------------------------------------------- ------------------------------</p>
<p>Import java.util.vector;</p>
<p>Public class magazine {private string name; private vector articles;</p>
<p>Public magazine () {articles = new vector ();</p>
<p>Public void setname (string rhs) {name = rhs;}</p>
<p>Public void addAndicle (articles.addelement (a);}</p>
<p>Public string toString () {stringbuffer buf = new stringbuffer ("magazine: name = '" name "" "); for (int i = 0; i <articles.size (); i ) {buf.Append (Articles) .Elementat (i) .tostring ());} return buf.tostring ();}}</p>
<p>-------------------------------------------------- ------------------------------ Public Class Article; Private String Page;</p>
<p>Public articles () {}</p>
<p>Public void setheadline (string rhs) {headline = rhs;} public void setpage (string rings) {page = rhs;</p>
<p>Public string toString () {return "article: headline = '" headline "' on page = '" "";}}</p>
<p>Specthe Digester Class Processes The Input Xml Document Based on Patterns and Rules. The Patterns Match XML Elements, Based</p>
<p>ON Their name and location in the document tree. The syntax used to describe the mathing pattern resembles the xpath match</p>
<p>Patterns, a little: the pattern catalog matches the top-level <catalog> Element, The Pattern Catalog / Book Matches A <book></p>
<p>Element Nested Directly Inside a <catalog> Element, But nowhere else in the document, etc.</p>
<p>All Patterns Are Absolute: The Entire Path from The Root Element on Down Has To Be Specified. The Only Exception Are Patterns</p>
<p>Containing The Wildcard Operator *: The pattern * / name will match a <name> element anywhere in the document. Also Note That</p>
<p>.................. ..</p>
<p>WHENEVER THE Digester Encounters One of The Specified Patterns, IT Performs The Actions That Have Been Associated with It. In</p>
<p>THIS, The Digester Framework Is of Course Related to A Sax Parser (AND in Fact, The Digester Class Implements</p>
<p>Org.xml.sax.contenthandler and maintains the parse stack). All rules to be used with the digester must extend</p>
<p>org.apache.commons.digester.Rule - which in itself exposes methods similar to the SAX ContentHandler callbacks: begin () andend () are called when the opening and closing tags of the matched element are encountered.</p>
<p>,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, Ltd.,</p>
<p>Which is caled overce processing of the closing tag is completion, to provide a hook to do pictible final clean-up chores. MOST</p>
<p>Application Developers Will NOT Have to Concern Themsels with these functions, however, Since the Standard Rules That Ship</p>
<p>With the framework area likely to provide all desired functionality.</p>
<p>To unmarshal a document, tell, create an instance of the org.apache.commons.digester.digester Class, Configure IT IF</p>
<p>Necessary, Specify THE REQUIRED PATTERNS AND RULES, AND FINALL, PASS A Reference To The XML File To The Parse () Method. this</p>
<p>IS Demonstrated In The DigesterDriver Class Below. (The FileName of The Input XML Document Must Be Specified On The Command</p>
<p>Line.)</p>
<p>Import org.apache.commons.digester. *;</p>
<p>Import java.io. *; import java.util. *;</p>
<p>Public class digesterDriver {</p>
<p>Public static void main (String [] args) {</p>
<p>Try {Digester Digester = New Digester (); Digester.SetValidating (false);</p>
<p>Digester.addObjectcreate ("Catalog", Catalog.class;</p>
<p>digester.addObjectCreate ( "catalog / book", Book.class); digester.addBeanPropertySetter ( "catalog / book / author", "author"); digester.addBeanPropertySetter ( "catalog / book / title", "title"); digester .addsetnext ("Catalog / Book", "Addbook");</p>
<p>digester.addObjectCreate ( "catalog / magazine", Magazine.class); digester.addBeanPropertySetter ( "catalog / magazine / name", "name"); digester.addObjectCreate ( "catalog / magazine / article", Article.class); digester .addSetProperties ( "catalog / magazine / article", "page", "page"); digester.addBeanPropertySetter ( "catalog / magazine / article / headline"); digester.addSetNext ( "catalog / magazine / article", "addArticle" );</p>
<p>Digester.AddsetNext ("Catalog / Magazine", "Addmagazine");</p>
<p>File INPUT = New File (Args [0]); Catalog C = (Catalog) Digester.Parse (Input);</p>
<p>System.out.println (c.toString ());</p>
<p>} catch (Exception EXC) {Exce (Exception Exc) {EXC.PrintStackTrace ();}}} After Instantiating The Digester, We Specify That Should Not Validate The XML Document Against A DTD - Because We Did NOT</p>
<p>Define One for Our Simple Catalog Document. Then We Specify THE PATTERNS AND THE Associated Rules: The ObjectCreaterule</p>
<p>Creates An Instance of the Specified Class and Pushes It ONTO The Parse Stack. The SetPropertiesRule Sets a bean property To</p>
<p>THE VALUE OF An Xml Attribute Of The Current Element - The First Argument To The Rule Is The Name of The Attribute, THE</p>
<p>SECOND, The name of the property.</p>
<p>WHEREAS setPropertiesrule Takes the value from an attribute, beanpropertysetterrule Takes the value from the raw character</p>
<p>Data Nested Inside of the Current Element. it is not necessary to specify the name of the matterty to set when using</p>
<p>BeanpropertySetterrule: IT defaults to the name of the capital XML Element. In The Example Above, this Default is being used</p>
<p>. In the rule definition matching the catalog / magazine / article / headline pattern Finally, the SetNextRule pops the object ontop of the parse stack and passes it to the named method on the object below it - it is commonly used to insert a finished</p>
<p>Bean INTO ITS Parent.</p>
<p>Note That It is Possible To Register Several Rules for The Same Pattern. If this Occurs, The Rules Are EXECUTEDION THE</p>
<p>In which they area added to the digester - for instance, to deal with the <article> Element, Found At</p>
<p>Catalog / Magazine / Article, WE First Create The Appropriate Article Bean, Then Set The Page Property, And Finally Pop The</p>
<p>Completed Article Bean and INSERT IT ITO ITS Magazine Parent.</p>
<p>Invoking Arbitrary Functionsit Is Not Only Possible To Set Bean Properties, But To Invoke Arbitrary Methods On Objects in The Stack. This is Accomplished</p>
<p>Using the callmethodrule to specify the method name and iptionally, the number and type of arguments passed to it.</p>
<p>Subsequent Specifications of The Callparamroule Define The Parameter Values To Be Passed To The Invoked Functions. The VALUES</p>
<p>Can Be Taken Either from named attributes of the current xml element, or from the rwage character data contained by the current</p>
<p>Element. for Instance, Rather Than Using The BeanpropertySetterrule in The DigesterDriver IMPLEMENTATION Above, We Could Have</p>
<p>Achieved The Same Effect by Calling The Property Setter Explicitly, and passing the data as parameter:</p>
<p>Digester.addCallmethod ("Catalog / Book / Author", "SetAuthor", 1); Digester.AddcallParam ("Catalog / Book / Author", 0); The First Line Gives The Name of the Method To Call (SETAUTHOR ()) And the expected number of parameters (1). The second line</p>
<p>says to take the value of the function parameter from the character data contained in the <author> element and pass it asfirst element in the array of arguments (i.e., the array element with index 0). Had we also specified an attribute name</p>
<p>(E.G., Digester.Addcallparam ("Catalog / Book / Author", 0, "Author");), The Value Would Have Been Taken from the Respective</p>
<p>Attribute of the current element instead.</p>
<p>One Important Caveat: Confusingly, Digester.addCallMethod ("Pattern", "MethodName", 0); Does Not Specify A Call To a Method</p>
<p>Taking No Arguments - Instead, IT Specifies a call to a method taking one argument, the value of which is taken from the val</p>
<p>Character Data of The Current XML Element! We Therefore have yet another way to import a replacement forment for</p>
<p>BeanpropertySetterrule:</p>
<p>Digester.addCallmethod ("Catalog / Book / Author", "SetAuthor", 0);</p>
<p>To Call a Method That Truly takes no parameters, Use digester.addcallmethod ("pattern", "methodname") ;.</p>
<p>Summary of Standard Rules</p>
<p>Below Are Brief Descriptions of All of The Standard Rules.</p>
<p>CreationAlObjectCreaterule: Creates An Object of The Specified Class Using Its Default Construction; IS; IS; IS</p>
<p>Popped. The class to instantiate can be be given through a class object or the full-qualified class</p>
<p>Name.</p>
<p>FactoryCreaterule: Creates An Object Using a Specified Factory Class and Pushes It Onto The Stack. This Can Be Useful for</p>
<p>Classes That Do Not Provide a Default Constructionor. The Factory Class Must Implement THE</p>
<p>Org.apache.commons.digester.ObjectCreationFactory Interface.</p>
<p>Property SettersSetPropertiesRule: Sets one or several named properties in the top-level bean using the values of named XML elementattributes Attribute names and property names are passed to this rule in String [] arrays (Typically used to handle XML..</p>
<p>Constructs like <article page = "10">.)</p>
<p>BeanpropertySetterrule: sets a named property on the top-level bean to the character data enclosed by the current XML</p>
<p>ELEMENT. (Example: <Page> 10 </ page>.)</p>
<p>SetPropertyRule: Sets a property on the top-level bean. Both The Property Name, As Well As The Value to Which this property</p>
<p>Will Be set, Are Given as attributes to the current xml element. (example: <articles = "page" value = "10" />.)</p>
<p>PARENT / CHILD ManagementSetNextrulect: POPS The Object On Top of the Stack and Passes It to a named method on the object immediately below. Typepically</p>
<p>Used to INSERT A Completed Bean ITO ITS Parent.</p>
<p>Settoprule: Passs the second-to-top object on the stack to the top-level object. This is useful if the child object exposes</p>
<p>A setParent Method, Rather Than The Other Way Around.</p>
<p>SetRootrule: Calls a Method on the Object At the Bottom of The Stack, Passing The Object On Top of the Stack As Argument.</p>
<p>Arbitrary Method Callscallmethodrule: Calls An Arbitrary Named Method on The Top-Level Bean. The Method May Take an Arbitrary Set of Parameters.</p>
<p>.</p>
<p>Callparamrule: Repesents the value of a method parameter. The value of the parameder is each taken from a named XML</p>
<p>Element attribute, or from the raw character data enclosed by the current element. this rule required</p>
<p>The parameter list is specified by an integer index.specifying rules in xml: using the xmlrules package</p>
<p>SO far, we have specified the patterns and rules program, while call time. While Conceptually Simple and SIMPLE and PROTECALLY</p>
<p>StraightForward, this Feels A bit Odd: The Entire Framework is About Recognizing and Handling Structure and Data At Run Time,</p>
<p>But Here We Go Fixing The Behavior At Compile Time! Large Numbers of Fixed Strings in Source Code Typical IND THAT</p>
<p>Something is Being Configured (Rather Than Programmed), Which Could Be (and Probably Should B) Done At Run Time INSTEAD.</p>
<p>The org.apache.commons.digester.xmlRules Package Addresses this issesue. It provides the digesterloader Class, Which Reads The</p>
<p>Pattern / rule-pairs from an XML Document and Returns A Digester Already Configured ACCORDINGLY. The XML Document Configuring</p>
<p>The Digester Must Comply with the digester-rules.dtd, Which is part of the xmlrules package.</p>
<p>BELOW Is The Contents of The Configuration File (named rules.xml) for the example application. I want to point SEveral</p>
<p>Things here.</p>
<p>Patterns Can Be Specified in Two Different Ways: Either As Attributes To Each XML Element Representing a Rule, Or Using To</p>
<p><pattern> Element. The pattern defined by The Latter Is Valid for All Contained Rule Elements. Both Ways Can Be Mixed, And</p>
<p><Pattern> Elements CAN Be Nested - in Either Case, The Pattern Defined by The Child Element Is Appended To The Pattern</p>
<p>Defined in the enclosing <pattern> element.</p>
<p>The <Alias> Element is buy with the <set-proties-rule> to map an XML Attribute to a bean property.</p>
<p>Finally, Using The Current Release of The Digester Package, It Is Not Possible To Specify THE Beanpropertysetterrule in The BeanpropertySetterRule In</p>
<p>Configuration File. INSTEAD, WE Are Using The CallmethodRule To Achieve The Same Effect, as Explained Above. <? XML Version = "1.0"?></p>
<p><digester-rules> <Object-create-rule pattern = "catalog" classname = "catalog" /> <set-proties-rule pattern = "catalog"> <alias attr-name = "=" library "prop-name =" Library "/> </ Set-proteties-rule></p>
<p><pattern value = "catalog / book"> <object-create-rule classname = "book" /> <call-method-rule pattern = "author" methodname = "setauthor" paramcount = "0" /> <call-method -rule pattern = "title" methodname = "settitle" paramcount = "0" /> <set-next-rule methodname = "addbook" /> </ pattern></p>
<p><pattern value = "catalog / magazine"> <object-create-rule classname = "magazine" /></p>
<p><call-method-rule pattern = "name" methodname = "setname" paramcount = "0" /></p>
<p><pattern value = "article"> <object-create-rule classname = "article" /> <set-proteties-rule> <alias attr-name = "page" prop-name = "page" /> </ set- Properties-Rule> <call-method-rule pattern = "headline" methodname = "sethead" paramcount = "0" /> <set-next-rule methodname = "addarticle" /> </ pattern></p>
<p><Set-next-rule methodname = "addMagazine" /> </ pattern> </ digester-rules> Since all the actual work has now been delegated to the Digester and DigesterLoader classes, the driver class itself becomestrivially simple. To run it, Specify the catalog document as the first command line argument, and the rules.xml file as the</p>
<p>Second. (Confusingly, The DigesterLoader Will NOT RULES.XML File from a file or an org.xml.sax.inputsource, but</p>
<p>Requires a Url - The File Reference In The Code Below Is Therefore Transformed Into An Equivalent URL.)</p>
<p>Import org.apache.commons.digester. *; import org.apache.commons.digester.xmlrules. *;</p>
<p>Import java.io. *; import java.util. *;</p>
<p>Public class xmlrulesdriver {public static void main (string [] args) {TRY {</p>
<p>File INPUT = New File (Args [0]); file rules = new file (args [1]);</p>
<p>Digester Digester = DigesterLoader.createdigester (Rules.tourl ());</p>
<p>Catalog catalog = (Catalog) digester.parse (input); System.out.println (catalog.toString ());} catch (Exception exc) {exc.printStackTrace ();}}} ConclusionThis concludes our brief overview of the Jakarta Commons Digester Package. Of Course, There Is More. One Topic Ignored in</p>
<p>THIS Introduction Are XML Names: Digester Allows You to Specify Rules That Only Act On Elements Defined within a Certain</p>
<p>Namespace.</p>
<p>We Mentioned Briefly The Possibility Of Developing Custom Rules, by Extending The Rule Class. The Digester Class Exposes the</p>
<p>Customary push (), peek (), AND pop () Methods, Giving The Individual Developer Freedom to manipulate the Parse Stack Directly.</p>
<p>Lastly, Note That There is An Additional Package Providing A Digester Implementation Which DEALS with RSS (Rich-Site-Summary) -Formatted Newsfeeds. The Javadoc Tells The Full Story.</p>
<p>ReferencesJakarta Commons Digester Homepage "Simple XML Parsing with SAX and DOM" Jakarta Struts Homepage "Java & XML Data Binding" - XML Data Binding addresses the general problem of making XML data available in applications Programming Jakarta Struts -. The upcoming book on Jakarta Struts at O'Reilly. Philipp K. Janert, Ph.d. Is A Software Project Consultant, Server Programmer, And Architect.</p></div><div class="text-center mt-3 text-grey">
转载请注明原文地址:https://www.9cbs.com/read-70149.html</div><div class="plugin d-flex justify-content-center mt-3"></div><hr><div class="row"><div class="col-lg-12 text-muted mt-2"><i class="icon-tags mr-2"></i><span class="badge border border-secondary mr-2"><h2 class="h6 mb-0 small"><a class="text-secondary" href="tag-2.html">9cbs</a></h2></span></div></div></div></div><div class="card card-postlist border-white shadow"><div class="card-body"><div class="card-title"><div class="d-flex justify-content-between"><div><b>New Post</b>(<span class="posts">0</span>)
</div><div></div></div></div><ul class="postlist list-unstyled">
</ul></div></div><div class="d-none threadlist"><input type="checkbox" name="modtid" value="70149" checked /></div></div></div></div></div><footer class="text-muted small bg-dark py-4 mt-3" id="footer"><div class="container"><div class="row"><div class="col">CopyRight © 2020 All Rights Reserved
</div><div class="col text-right">Processed:
<b>0.035</b>, SQL:
<b>9</b></div></div></div></footer><script src="./lang/en-us/lang.js?2.2.0"></script><script src="view/js/jquery.min.js?2.2.0"></script><script src="view/js/popper.min.js?2.2.0"></script><script src="view/js/bootstrap.min.js?2.2.0"></script><script src="view/js/xiuno.js?2.2.0"></script><script src="view/js/bootstrap-plugin.js?2.2.0"></script><script src="view/js/async.min.js?2.2.0"></script><script src="view/js/form.js?2.2.0"></script><script>
var debug = DEBUG = 0;
var url_rewrite_on = 1;
var url_path = './';
var forumarr = {"1":"Tech"};
var fid = 1;
var uid = 0;
var gid = 0;
xn.options.water_image_url = 'view/img/water-small.png';
</script><script src="view/js/wellcms.js?2.2.0"></script><a class="scroll-to-top rounded" href="javascript:void(0);"><i class="icon-angle-up"></i></a><a class="scroll-to-bottom rounded" href="javascript:void(0);" style="display: inline;"><i class="icon-angle-down"></i></a></body></html><script>
var forum_url = 'list-1.html';
var safe_token = 'vJCbdQ21SfbOnPEETerlc8Hq9_2BPsZWFVw_2BBqiqDbJKJNHveEx8YieQBZrdwn5o9u832YkeLLC4S_2FOL52';
var body = $('body');
body.on('submit', '#form', function() {
var jthis = $(this);
var jsubmit = jthis.find('#submit');
jthis.reset();
jsubmit.button('loading');
var postdata = jthis.serializeObject();
$.xpost(jthis.attr('action'), postdata, function(code, message) {
if(code == 0) {
location.reload();
} else {
$.alert(message);
jsubmit.button('reset');
}
});
return false;
});
function resize_image() {
var jmessagelist = $('div.message');
var first_width = jmessagelist.width();
jmessagelist.each(function() {
var jdiv = $(this);
var maxwidth = jdiv.attr('isfirst') ? first_width : jdiv.width();
var jmessage_width = Math.min(jdiv.width(), maxwidth);
jdiv.find('img, embed, iframe, video').each(function() {
var jimg = $(this);
var img_width = this.org_width;
var img_height = this.org_height;
if(!img_width) {
var img_width = jimg.attr('width');
var img_height = jimg.attr('height');
this.org_width = img_width;
this.org_height = img_height;
}
if(img_width > jmessage_width) {
if(this.tagName == 'IMG') {
jimg.width(jmessage_width);
jimg.css('height', 'auto');
jimg.css('cursor', 'pointer');
jimg.on('click', function() {
});
} else {
jimg.width(jmessage_width);
var height = (img_height / img_width) * jimg.width();
jimg.height(height);
}
}
});
});
}
function resize_table() {
$('div.message').each(function() {
var jdiv = $(this);
jdiv.find('table').addClass('table').wrap('<div class="table-responsive"></div>');
});
}
$(function() {
resize_image();
resize_table();
$(window).on('resize', resize_image);
});
var jmessage = $('#message');
jmessage.on('focus', function() {if(jmessage.t) { clearTimeout(jmessage.t); jmessage.t = null; } jmessage.css('height', '6rem'); });
jmessage.on('blur', function() {jmessage.t = setTimeout(function() { jmessage.css('height', '2.5rem');}, 1000); });
$('#nav li[data-active="fid-1"]').addClass('active');
</script>
