Udom2Sax (BandM metatools API doc)

java.lang.Object
- eu.bandm.tools.umod.runtime.OptimizingVisitor
- - eu.bandm.tools.d2d2.rt.MATCH_ONLY_00
  - - eu.bandm.tools.d2d2.rt.SinglePhase_rt
    - - eu.bandm.tools.d2d2.base.Udom2Sax

```
public class Udom2Sax
extends SinglePhase_rt
```
Generates SAX events in name-space mode. Create an instance (always anew, no resuage) and then call convert(MessageReceiver,ContentHandler,ResultingStructure,Map) or convert(MessageReceiver,ContentHandler,LexicalHandler,ResultingStructure,Map).
Has to be piped into a consuming ContentHandler in name-space mode, like eu.bandm.tools.util.NamespaceEmbedder.
An ooption LexicalHandler is for comments and PIs.

Field Summary

Fields
Modifier and Type	Field and Description
`static AttributesImpl`	`ATTRIBUTES_EMPTY`
`protected Set<Definition>`	`attributesDone` All those definitions the content of which (under the currently written node) have already been written out as attributes, and therefore do not need further processing.
`protected Location<String>`	`cachedLocation`
`static Map<Definition,Method>`	`def2postProcessMethod` Cache for performance.
`static Map<Definition,PostProcessor>`	`def2postProcessObject` Cache for performance.
`protected Method`	`foundPostprocMethod`
`protected PostProcessor`	`foundPostprocObject`
`protected MemString`	`lastCharsWritten`
`protected Locator`	`locator`
`protected MessageReceiver<SimpleMessage<Object>>`	`msg` Target of all error messages.
`protected Stack<String>`	`namespacesopen`
`protected Stack<String>`	`namespacesprefix`
`static Set<Definition>`	`NO_ATTRIBUTES`
`protected static Class[]`	`pp_args`
`protected ContentHandler`	`sax` Target of generated write-out.
`protected LexicalHandler`	`saxlex` Target of generated comments and pis.
`static String`	`STRING_defaultNamespacePrefix`
`protected ResultingStructure`	`toplevelStructure` Diagnosis only.
`protected boolean`	`trimfirst` Indicates that no non-white-space character data has appeared yet, and (if trimming) whitespace is NOT written to `ws_buffer`.
`protected boolean`	`trimming` Whether there is any whitespace trimming, as determined by the node type declaration.
`protected List<ResultingChars>`	`ws_buffer` Accumulator for whitespace which will be written out iff non-white-space character data follows.

Fields inherited from class eu.bandm.tools.d2d2.rt.MATCH_ONLY_00
_visitor_debug_stream, partial

Fields inherited from class eu.bandm.tools.umod.runtime.OptimizingVisitor
affectedClasses, fieldFlags, hasdescend, haspost, haspre, METHODNAME_allFields2codeNumber

Constructor Summary

Constructors
Constructor and Description

Udom2Sax()

Constructors
Constructor and Description
`Udom2Sax()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`action(PermutationGroup pg)`
`void`	`action(ResultingChars chars)`
`void`	`action(ResultingStructure res_pre)` If argument is not yet written out as attribute, then (1) apply postproc, (2) collect all attributes, (3) emit an "open element" sax event, (4) visit sub-structure, (5) emit a "close element" sax event.
`ResultingStructure`	`applyPostProc(ResultingStructure input)`
`protected void`	`checknamespace(NamespaceName n, boolean isAttribute)` Generate an SAX call, iff the namespace uri is not yet mapped to a prefix, and memoize.
`void`	`convert(MessageReceiver<SimpleMessage<Object>> msg, ContentHandler sax, ResultingStructure structure, Map<String,String> namespaceContext)` Top-level entry point.
`void`	`findPostProc(Definition def)`
`protected String`	`getCharOnly(ResultContainer c)`
`protected int`	`marknamespace()` Remember the number of currently mapped name spaces.
`protected void`	`memoChars(MemString chars)`
`protected void`	`memoLoc(ResultingStructure res)`
`protected void`	`releasenamespace(int level)` Close all namespaces, as they were at the beginning of the element
`protected void`	`updateCache()`
`protected void`	`wr_simpleElement(NamespaceName tag, char[] c, int o, int l)`
`protected void`	`write(MemString mem)`
`protected void`	`write(ResultingChars c)`
`protected void`	`writeEmptyElement(NamespaceName tag)`
`protected void`	`writeout_enum(Enumeration enumT, ResultingStructure res, AttributesImpl att)`
`protected void`	`writeSimpleElement_synthetic(NamespaceName tag, String val)` write a text which is synthetic, ie.
`protected void`	`writeSimpleElement(NamespaceName tag, MemString val)`
`protected void`	`ws_buffer_flush()` Called when writing out any non-whitespace character data, or when starting an "open" tag.

Methods inherited from class eu.bandm.tools.d2d2.rt.SinglePhase_rt
action, action, action, action, action, action, action, action, action, collectFlags, getKey, getLowestGeneratedClass

Methods inherited from class eu.bandm.tools.d2d2.rt.MATCH_ONLY_00
_visitor_trace, action, action, action, action, action, action, action, action, action, allFields2codeNumber, foreignObject, get_class2reachedSccs, get_class2scc, get_field2sccs, match, match, match, match, match, match, match, match, match, match, match, match, match, nomatch

Methods inherited from class eu.bandm.tools.umod.runtime.OptimizingVisitor
calculateFlags, collectFlags_action, collectFlags_actionDorewrite, collectFlags_actionPreDescendPost, collectFlags_actionRewritefields, collectMethods

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - STRING_defaultNamespacePrefix
```
public static final String STRING_defaultNamespacePrefix
```
    See Also:
    
    Constant Field Values
  - def2postProcessMethod
```
public static final Map<Definition,Method> def2postProcessMethod
```
    Cache for performance.
  - def2postProcessObject
```
public static final Map<Definition,PostProcessor> def2postProcessObject
```
    Cache for performance.
  - pp_args
```
protected static final Class[] pp_args
```
  - foundPostprocMethod
```
protected Method foundPostprocMethod
```
  - foundPostprocObject
```
protected PostProcessor foundPostprocObject
```
  - ATTRIBUTES_EMPTY
```
public static final AttributesImpl ATTRIBUTES_EMPTY
```
  - NO_ATTRIBUTES
```
public static final Set<Definition> NO_ATTRIBUTES
```
  - lastCharsWritten
```
protected MemString lastCharsWritten
```
  - cachedLocation
```
protected Location<String> cachedLocation
```
  - locator
```
protected final Locator locator
```
  - attributesDone
```
protected Set<Definition> attributesDone
```
    All those definitions the content of which (under the currently written node) have already been written out as attributes, and therefore do not need further processing.
  - msg
```
protected MessageReceiver<SimpleMessage<Object>> msg
```
    Target of all error messages. Currently only reflection generated exception (when a post processor cannot be found) or from the sax receiver (SAXExceptions) can happen.
  - sax
```
protected ContentHandler sax
```
    Target of generated write-out.
  - saxlex
```
protected LexicalHandler saxlex
```
    Target of generated comments and pis.
  - toplevelStructure
```
protected ResultingStructure toplevelStructure
```
    Diagnosis only.
  - ws_buffer
```
protected final List<ResultingChars> ws_buffer
```
    Accumulator for whitespace which will be written out iff non-white-space character data follows.
  - trimming
```
protected boolean trimming
```
    Whether there is any whitespace trimming, as determined by the node type declaration. If true, then whitespace character data will at most be put into the intermediate buffer, and written out only when non-white-space data follows.
  - trimfirst
```
protected boolean trimfirst
```
    Indicates that no non-white-space character data has appeared yet, and (if trimming) whitespace is NOT written to ws_buffer.
  - namespacesopen
```
protected Stack<String> namespacesopen
```
  - namespacesprefix
```
protected Stack<String> namespacesprefix
```
- Constructor Detail
  - Udom2Sax
```
public Udom2Sax()
```
- Method Detail
  - findPostProc
```
public void findPostProc(Definition def)
```
  - applyPostProc
```
public ResultingStructure applyPostProc(ResultingStructure input)
```
  - memoChars
```
protected void memoChars(MemString chars)
```
  - memoLoc
```
protected void memoLoc(ResultingStructure res)
```
  - updateCache
```
protected void updateCache()
```
  - convert
```
public void convert(MessageReceiver<SimpleMessage<Object>> msg,
                    ContentHandler sax,
                    ResultingStructure structure,
                    Map<String,String> namespaceContext)
```
    Top-level entry point. No special constructor required! All uris in namespaceContext are added to the output context, the prefix therein is used iff (1) uri not yet defined, (2) if prefix used, it will be mangled. Used primely for xslt source namespaces, which are present only in xpath expressions! THEREFORE IT CAN FAIL BECAUSE MANGLING OF PREFIXES DOES NOT CARRY OVER as long as xslt/xpath is external/unparsed!
    
    Parameters:
    
    msg - target for error messages when trying to write the SAX event.
    
    sax - target for the SAX events.
    
    structure - what to write out.
    
    namespaceContext - map of prefices to uris, output at first, may be ==null.
  - ws_buffer_flush
```
protected void ws_buffer_flush()
```
    Called when writing out any non-whitespace character data, or when starting an "open" tag.
  - checknamespace
```
protected void checknamespace(NamespaceName n,
                              boolean isAttribute)
                       throws SAXException
```
    Generate an SAX call, iff the namespace uri is not yet mapped to a prefix, and memoize. Otherwise do nothing, so that the current (second) prefix (=synonym) will be ignored and the oldest assigned prefix continued to be used.
    
    Throws:
    
    SAXException
  - marknamespace
```
protected int marknamespace()
```
    Remember the number of currently mapped name spaces.
  - releasenamespace
```
protected void releasenamespace(int level)
                         throws SAXException
```
    Close all namespaces, as they were at the beginning of the element
    
    Throws:
    
    SAXException
  - getCharOnly
```
protected String getCharOnly(ResultContainer c)
```
  - action
```
public void action(ResultingStructure res_pre)
```
    If argument is not yet written out as attribute, then (1) apply postproc, (2) collect all attributes, (3) emit an "open element" sax event, (4) visit sub-structure, (5) emit a "close element" sax event.
    
    Overrides:
    
    action in class SinglePhase_rt
  - action
```
public void action(PermutationGroup pg)
```
    Overrides:
    
    action in class SinglePhase_rt
  - write
```
protected void write(MemString mem)
```
  - write
```
protected void write(ResultingChars c)
```
  - wr_simpleElement
```
protected void wr_simpleElement(NamespaceName tag,
                                char[] c,
                                int o,
                                int l)
```
  - writeSimpleElement
```
protected void writeSimpleElement(NamespaceName tag,
                                  MemString val)
```
  - writeSimpleElement_synthetic
```
protected void writeSimpleElement_synthetic(NamespaceName tag,
                                            String val)
```
    write a text which is synthetic, ie. should not influence locator generation!
  - writeEmptyElement
```
protected void writeEmptyElement(NamespaceName tag)
```
  - writeout_enum
```
protected void writeout_enum(Enumeration enumT,
                             ResultingStructure res,
                             AttributesImpl att)
                      throws SAXException
```
    Throws:
    
    SAXException
  - action
```
public void action(ResultingChars chars)
```
    Overrides:
    
    action in class SinglePhase_rt

Class Udom2Sax

Field Summary

Fields inherited from class eu.bandm.tools.d2d2.rt.MATCH_ONLY_00

Fields inherited from class eu.bandm.tools.umod.runtime.OptimizingVisitor

Constructor Summary

Method Summary

Methods inherited from class eu.bandm.tools.d2d2.rt.SinglePhase_rt

Methods inherited from class eu.bandm.tools.d2d2.rt.MATCH_ONLY_00

Methods inherited from class eu.bandm.tools.umod.runtime.OptimizingVisitor

Methods inherited from class java.lang.Object

Field Detail

STRING_defaultNamespacePrefix

def2postProcessMethod

def2postProcessObject

pp_args

foundPostprocMethod

foundPostprocObject

ATTRIBUTES_EMPTY

NO_ATTRIBUTES

lastCharsWritten

cachedLocation

locator

attributesDone

msg

sax

saxlex

toplevelStructure

ws_buffer

trimming

trimfirst

namespacesopen

namespacesprefix

Constructor Detail

Udom2Sax

Method Detail

findPostProc

applyPostProc

memoChars

memoLoc

updateCache

convert

ws_buffer_flush

checknamespace

marknamespace

releasenamespace

getCharOnly

action

action

write

write

wr_simpleElement

writeSimpleElement

writeSimpleElement_synthetic

writeEmptyElement

writeout_enum

action