SpecificXMLWriter (Soapkit 0.11 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

soapical.likeoldsax
Class SpecificXMLWriter

java.lang.Object
  soapical.likeoldsax.SpecificXMLWriter

All Implemented Interfaces:: org.xml.sax.ContentHandler

Direct Known Subclasses:: SpecificContentHandler, XSDWriter

public class SpecificXMLWriter
extends java.lang.Object
implements org.xml.sax.ContentHandler

Convenience class for generating XML.

This class provides easy, SAX1-style functions for your convenience when you are generating XML in mostly one namespace:

`startElement`	just pass in a local name and optionally an `Attributes`
`endElement`	just pass in a local name
`emptyElement`	equivilant to calling `startElement` then `endElement`
`addAttributes`	adds unprefixed attributes

The best way to use this class is to extend it and create a simpler version of the constructor. For example:


 public class ExampleWriter extends SpecificXMLWriter {
 
   public ExampleWriter(Writer writer) {
     super(writer, EXAMPLE_NAMESPACE, EXAMPLE_NAMESPACE_PREFIX);
   }

   public ExampleWriter(Writer writer, String prefix) {
     super(writer, EXAMPLE_NAMESPACE, prefix);
   }
  
   public static final String EXAMPLE_NAMESPACE_PREFIX =  "example";
   public static final String EXAMPLE_NAMESPACE = "http://www.example.org/foo";
  
 } // end ExampleWriter

Here is how you would use the above code:

 ExampleWriter xmlout = new ExampleWriter(System.out);
 
 xmlout.startDocument();
 
 AttributesImpl fooAtts = new AttributesImpl();
 xmlout.addAttributes(fooAtts, "myattr", "CDATA", "myvalue");
 
 xmlout.startElement("foo", fooAtts);

 AttributesImpl barAtts = new AttributesImpl();
 xmlout.addAttributes(barAtts, "myotherattr", "CDATA", "myothervalue");
 xmlout.emptyElement("bar1", barAtts);
 
 xmlout.emptyElement("bar2");

 xmlout.endElement("foo");
 xmlout.endDocument();

This is the XML it would produce

 <example:foo xmlns:foo="http://www.example.org/foo" myattr="myvalue">
  <example:bar1 myotherattr="myothervalue"/>
  <example:bar2/>
 </example:foo>

Now, you might argue that the XML produced was much shorter than the code it took to write it. True, but the code to write this XML probably has less chance of error, and that's the real benefit of automation.

If you really want to know, this class is merely a decorator to ContentHandler and XMLWriter.

Version:: $Revision: 1.3 $
$Date: 2003/04/24 13:26:24 $
Author:: Eric Kow (kow at loria point fr)
See Also:: XSDWriter

Constructor Summary
`SpecificXMLWriter(org.xml.sax.ContentHandler handler, java.lang.String namespaceURI, java.lang.String prefix)` Creates a new SpecificXMLWriter which passes its events to another `ContentHandler`.
`SpecificXMLWriter(java.io.Writer writer, java.lang.String namespaceURI, java.lang.String prefix)` Creates a new SpecificXMLWriter which generates XML to the `Writer` parameter.

Method Summary
`void`	`addAttribute(org.xml.sax.helpers.AttributesImpl attrs, java.lang.String localName, java.lang.String type, java.lang.String value)` Add an unprefixed attribute to an attributes list.
`void`	`characters(char[] ch, int start, int len)`
`void`	`emptyElement(java.lang.String localName)` Creates an empty element in the assumed namespace, with no attributes.
`void`	`emptyElement(java.lang.String localName, org.xml.sax.Attributes atts)` Creates an empty element in the assumed namespace.
`void`	`endDocument()`
`void`	`endElement(java.lang.String localName)` End an element in the assumed namespace.
`void`	`endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)`
`void`	`endPrefixMapping(java.lang.String prefix)`
`void`	`ignorableWhitespace(char[] ch, int start, int len)`
`void`	`processingInstruction(java.lang.String target, java.lang.String data)`
`void`	`setDocumentLocator(org.xml.sax.Locator locator)`
`void`	`skippedEntity(java.lang.String name)`
`void`	`startDocument()`
`void`	`startElement(java.lang.String localName)` Start a new element in the assumed namespace, with no attributes
`void`	`startElement(java.lang.String localName, org.xml.sax.Attributes atts)` Start a new element in the assumed namespace
`void`	`startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)`
`void`	`startPrefixMapping(java.lang.String prefix, java.lang.String uri)`

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail