00001 /**
00002 
00003 

00004   This is the  RexxLiterated documentation for xmlDOM work-in-progress.
00005 
00006 
00007 
 Overview
00008 

00009   Currently, the basic stuff, building a DOM Level1 from a XML source with 
00010   a non-validating simple XML parser and supporting access to that DOM by 
00011   means of the navigating/accessing interfaces defined by W3C, shoudl be 
00012   mostly working.
00013 
00014 
00015 

00016   The source browser is a browser (with syntax highlighting) not an editor
00017   and part of the RexxLiterate package, see the 
00018   RexxLiterate project.
00019 
00020 
00021 

00022   Use the tabs to find items belonging to the tab's category.
00023   You can also navigate the tree on the left to explore the
00024   documentation and source.
00025 
00026 
00027 
Licence
00028 

00029   This version of  xmlDOM  is  licensed  under  the Common Public License
00030   http://www.opensource.org/licenses/cpl1.0.php
00031 
00032 
00033 

00034   Copyright (c) 2011-2015 Ruurd J. Idenburg
00035 
00036 
00037 

00038   Author: Ruurd J. Idenburg
00039 
00040 
00041 
Structure
00042 

00043   Click on the documents tab above, then on the Structure link.
00044 
00045 
00046 
Operation
00047 

00048   To be expanded.
00049 
00050 */
00051 
00052 /** Structure - how it fits together
00053 

00054   xmlDOM is composed of three cooperating classes:
00055   

00056     

00057       XML parser that analyzes the input and provides the necessary data 
00058       to a DOM builder, which is given as an argument when the parser instance
00059       is created.
00060     
00061     

00062       DOM builder that receives the necessary data, to be able to construct 
00063       a DOM tree of nodes, from the parser, such as the start and end of an element
00064       or the name and value of attributes for an element.
00065     
00066     

00067       A class that allows the builder to build the DOM tree and provides 
00068       access and navigating methods for ooRexx programs processing the created DOM.
00069     
  
00070   
00071 

00072 

00073     A program that would interact with the DOM should do something akin to the
00074     following to create a workable situation:
00075     
00076       builder = .dom1Builder~new                     -- create the DOM builder
00077       parser = .xmlParser~new(builder)               -- create the XML parser
00078       xmlFile = "something.xml"                      -- a proper XML file
00079       xml = .stream~new(xmlFile)                     -- make it suppliable for the parser
00080       dom = parser~parseStream(xmlFile)              -- get the DOM from the parser
00081       document = dom~documentElement                 -- retrieve the document
00082       elements = document~getrElementsByTagName("*") -- get all elements in the DOM
00083       elementArray = elements~toOorexxArray          -- convert to ooRexx array
00084       ......
00085       ::requires 'xmlDOM.cls'
00086     
00087 

00088 */
00089 /** tryxmldom.rex
00090 

00091   Is just an excercise in using/testing the parser and builder, not necessarily in the most efficient or elegant way.
00092   It uses LongPondLane-vanEttenLane.xml as the xml input stream. The input file is the same as the result of the
00093   following query for Google Maps:
00094 

00095     https://maps.googleapis.com/maps/api/directions/xml?origin=8+Long+Pond+Lane,+Saugerties,+NY&destination=5+van+Etten+Lane,+Lake +Katrine,+NY&units=imperial&mode=bicycling
00096 

00097   tryxmldom.rex will parse the input into a DOM and will output a GPX file with route directions/tracks that can be 
00098   viewed/used on your smartphone or tablet with apps like Viewranger, OSMAnd+ and MyTrails.
00099 /** Todo
00100 

00101    Lots. 
00102 
00103 
00104 */