Changeset 3707 for trunk/gsdl3/docs/manual

Timestamp:

2003-01-24T15:54:55+13:00 (21 years ago)

Author:

kjdon

Message:

updated

File:

• trunk/gsdl3/docs/manual/hints.tex (modified) (1 diff)

trunk/gsdl3/docs/manual/hints.tex

@@ -13 +13 @@
 \maketitle
 
+\section{Java code}
+
+the java code is found in gsdl3/src/java/org/greenstone/gsdl3
+util has various utility classes, service has the services, action has the actions, build has the building code, etc.
+
 \section{Working with XML}
 
-We use the DOM model for handling XML. This involves Documents, Nodes, Elements etc. Node is the basic thing in the tree, all others inherit from this. A Document represents a whole document, and is a kind of container for all the nodes. Elements and Nodes are not supposed to exist outside of the context of a document, so you have to have a document to create them. The document is not the top level node in the tree, to get this, use Document.getDocumentElement(). If you create nodes etc but dont append them to something already n the document tree, they will be separate - but they still know who their owner document is.
+We use the DOM model for handling XML. This involves Documents, Nodes, Elements etc. Node is the basic thing in the tree, all others inherit from this. A Document represents a whole document, and is a kind of container for all the nodes. Elements and Nodes are not supposed to exist outside of the context of a document, so you have to have a document to create them. The document is not the top level node in the tree, to get this, use Document.getDocumentElement(). If you create nodes etc but dont append them to something already in the document tree, they will be separate - but they still know who their owner document is.
+
+There is a utility class called XMLConverter - this creates new Documents, and converts Strings or files to Documents.
+eg:
+XMLConverter converter = new XMLConverter();
+Document doc = converter.newDOM();
+
+File stylesheet = new File(``query.xsl'');
+Document style = converter.getDOM(stylesheet);
+
+String message = ``<message><request type='cgi'/></message>'';
+Document m = converter.getDOM(message);
+
+To output a document as a String, use converter.getString(doc);
+
+
+To add nodes and stuff to an empty document - create them, then append to the tree
+
+Document doc = converter.newDOM();
+Element e = doc.createElement(``message'');
+doc.appendChild(e);
+
+Note, you can only append one node to a document - this will become the toplevel node. After that, you can append nodes to child nodes as you like, but a document is only allowed one top level node.
 
 \section{Working with XSLT}