Google Git
Sign in
apache / xalan-site / baed2198e564a4221346ce9823f7f57830a0d758 / . / docs / xalan / xalan-j / apidocs / src-html / org / apache / xml / serializer / dom3 / DOM3SerializerImpl.html
blob: bf03be43d10febccb2824c3c6e6a3d8245c904f0 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the "License");<a name="line.6"></a>
<FONT color="green">007</FONT> * you may not use this file except in compliance with the License.<a name="line.7"></a>
<FONT color="green">008</FONT> * You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<FONT color="green">013</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<FONT color="green">014</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<FONT color="green">015</FONT> * See the License for the specific language governing permissions and<a name="line.15"></a>
<FONT color="green">016</FONT> * limitations under the License.<a name="line.16"></a>
<FONT color="green">017</FONT> */<a name="line.17"></a>
<FONT color="green">018</FONT> /*<a name="line.18"></a>
<FONT color="green">019</FONT> * $Id: DOM3SerializerImpl.java 1225426 2011-12-29 04:13:08Z mrglavas $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> <a name="line.21"></a>
<FONT color="green">022</FONT> package org.apache.xml.serializer.dom3;<a name="line.22"></a>
<FONT color="green">023</FONT> <a name="line.23"></a>
<FONT color="green">024</FONT> import java.io.IOException;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.xml.serializer.DOM3Serializer;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.xml.serializer.SerializationHandler;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.xml.serializer.utils.WrappedRuntimeException;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.w3c.dom.DOMErrorHandler;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.w3c.dom.Node;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.w3c.dom.ls.LSSerializerFilter;<a name="line.31"></a>
<FONT color="green">032</FONT> <a name="line.32"></a>
<FONT color="green">033</FONT> /**<a name="line.33"></a>
<FONT color="green">034</FONT> * This class implements the DOM3Serializer interface.<a name="line.34"></a>
<FONT color="green">035</FONT> * <a name="line.35"></a>
<FONT color="green">036</FONT> * @xsl.usage internal<a name="line.36"></a>
<FONT color="green">037</FONT> */<a name="line.37"></a>
<FONT color="green">038</FONT> public final class DOM3SerializerImpl implements DOM3Serializer {<a name="line.38"></a>
<FONT color="green">039</FONT> <a name="line.39"></a>
<FONT color="green">040</FONT> /**<a name="line.40"></a>
<FONT color="green">041</FONT> * Private class members<a name="line.41"></a>
<FONT color="green">042</FONT> */<a name="line.42"></a>
<FONT color="green">043</FONT> // The DOMErrorHandler<a name="line.43"></a>
<FONT color="green">044</FONT> private DOMErrorHandler fErrorHandler;<a name="line.44"></a>
<FONT color="green">045</FONT> <a name="line.45"></a>
<FONT color="green">046</FONT> // A LSSerializerFilter<a name="line.46"></a>
<FONT color="green">047</FONT> private LSSerializerFilter fSerializerFilter;<a name="line.47"></a>
<FONT color="green">048</FONT> <a name="line.48"></a>
<FONT color="green">049</FONT> // A LSSerializerFilter<a name="line.49"></a>
<FONT color="green">050</FONT> private String fNewLine;<a name="line.50"></a>
<FONT color="green">051</FONT> <a name="line.51"></a>
<FONT color="green">052</FONT> // A SerializationHandler ex. an instance of ToXMLStream<a name="line.52"></a>
<FONT color="green">053</FONT> private SerializationHandler fSerializationHandler;<a name="line.53"></a>
<FONT color="green">054</FONT> <a name="line.54"></a>
<FONT color="green">055</FONT> /**<a name="line.55"></a>
<FONT color="green">056</FONT> * Constructor<a name="line.56"></a>
<FONT color="green">057</FONT> * <a name="line.57"></a>
<FONT color="green">058</FONT> * @param handler An instance of the SerializationHandler interface. <a name="line.58"></a>
<FONT color="green">059</FONT> */<a name="line.59"></a>
<FONT color="green">060</FONT> public DOM3SerializerImpl(SerializationHandler handler) {<a name="line.60"></a>
<FONT color="green">061</FONT> fSerializationHandler = handler;<a name="line.61"></a>
<FONT color="green">062</FONT> }<a name="line.62"></a>
<FONT color="green">063</FONT> <a name="line.63"></a>
<FONT color="green">064</FONT> // Public memebers<a name="line.64"></a>
<FONT color="green">065</FONT> <a name="line.65"></a>
<FONT color="green">066</FONT> /**<a name="line.66"></a>
<FONT color="green">067</FONT> * Returns a DOMErrorHandler set on the DOM Level 3 Serializer.<a name="line.67"></a>
<FONT color="green">068</FONT> * <a name="line.68"></a>
<FONT color="green">069</FONT> * This interface is a public API.<a name="line.69"></a>
<FONT color="green">070</FONT> *<a name="line.70"></a>
<FONT color="green">071</FONT> * @return A Level 3 DOMErrorHandler<a name="line.71"></a>
<FONT color="green">072</FONT> */<a name="line.72"></a>
<FONT color="green">073</FONT> public DOMErrorHandler getErrorHandler() {<a name="line.73"></a>
<FONT color="green">074</FONT> return fErrorHandler;<a name="line.74"></a>
<FONT color="green">075</FONT> }<a name="line.75"></a>
<FONT color="green">076</FONT> <a name="line.76"></a>
<FONT color="green">077</FONT> /**<a name="line.77"></a>
<FONT color="green">078</FONT> * Returns a LSSerializerFilter set on the DOM Level 3 Serializer to filter nodes<a name="line.78"></a>
<FONT color="green">079</FONT> * during serialization.<a name="line.79"></a>
<FONT color="green">080</FONT> * <a name="line.80"></a>
<FONT color="green">081</FONT> * This interface is a public API.<a name="line.81"></a>
<FONT color="green">082</FONT> *<a name="line.82"></a>
<FONT color="green">083</FONT> * @return The Level 3 LSSerializerFilter<a name="line.83"></a>
<FONT color="green">084</FONT> */<a name="line.84"></a>
<FONT color="green">085</FONT> public LSSerializerFilter getNodeFilter() {<a name="line.85"></a>
<FONT color="green">086</FONT> return fSerializerFilter;<a name="line.86"></a>
<FONT color="green">087</FONT> }<a name="line.87"></a>
<FONT color="green">088</FONT> <a name="line.88"></a>
<FONT color="green">089</FONT> /**<a name="line.89"></a>
<FONT color="green">090</FONT> * Gets the end-of-line sequence of characters to be used during serialization.<a name="line.90"></a>
<FONT color="green">091</FONT> */<a name="line.91"></a>
<FONT color="green">092</FONT> public char[] getNewLine() {<a name="line.92"></a>
<FONT color="green">093</FONT> return (fNewLine != null) ? fNewLine.toCharArray() : null;<a name="line.93"></a>
<FONT color="green">094</FONT> }<a name="line.94"></a>
<FONT color="green">095</FONT> <a name="line.95"></a>
<FONT color="green">096</FONT> /**<a name="line.96"></a>
<FONT color="green">097</FONT> * Serializes the Level 3 DOM node by creating an instance of DOM3TreeWalker<a name="line.97"></a>
<FONT color="green">098</FONT> * which traverses the DOM tree and invokes handler events to serialize<a name="line.98"></a>
<FONT color="green">099</FONT> * the DOM NOde. Throws an exception only if an I/O exception occured<a name="line.99"></a>
<FONT color="green">100</FONT> * while serializing.<a name="line.100"></a>
<FONT color="green">101</FONT> * This interface is a public API.<a name="line.101"></a>
<FONT color="green">102</FONT> *<a name="line.102"></a>
<FONT color="green">103</FONT> * @param node the Level 3 DOM node to serialize<a name="line.103"></a>
<FONT color="green">104</FONT> * @throws IOException if an I/O exception occured while serializing<a name="line.104"></a>
<FONT color="green">105</FONT> */<a name="line.105"></a>
<FONT color="green">106</FONT> public void serializeDOM3(Node node) throws IOException {<a name="line.106"></a>
<FONT color="green">107</FONT> try {<a name="line.107"></a>
<FONT color="green">108</FONT> DOM3TreeWalker walker = new DOM3TreeWalker(fSerializationHandler,<a name="line.108"></a>
<FONT color="green">109</FONT> fErrorHandler, fSerializerFilter, fNewLine);<a name="line.109"></a>
<FONT color="green">110</FONT> <a name="line.110"></a>
<FONT color="green">111</FONT> walker.traverse(node);<a name="line.111"></a>
<FONT color="green">112</FONT> } catch (org.xml.sax.SAXException se) {<a name="line.112"></a>
<FONT color="green">113</FONT> throw new WrappedRuntimeException(se);<a name="line.113"></a>
<FONT color="green">114</FONT> }<a name="line.114"></a>
<FONT color="green">115</FONT> }<a name="line.115"></a>
<FONT color="green">116</FONT> <a name="line.116"></a>
<FONT color="green">117</FONT> /**<a name="line.117"></a>
<FONT color="green">118</FONT> * Sets a DOMErrorHandler on the DOM Level 3 Serializer.<a name="line.118"></a>
<FONT color="green">119</FONT> * <a name="line.119"></a>
<FONT color="green">120</FONT> * This interface is a public API.<a name="line.120"></a>
<FONT color="green">121</FONT> *<a name="line.121"></a>
<FONT color="green">122</FONT> * @param handler the Level 3 DOMErrorHandler<a name="line.122"></a>
<FONT color="green">123</FONT> */<a name="line.123"></a>
<FONT color="green">124</FONT> public void setErrorHandler(DOMErrorHandler handler) {<a name="line.124"></a>
<FONT color="green">125</FONT> fErrorHandler = handler;<a name="line.125"></a>
<FONT color="green">126</FONT> }<a name="line.126"></a>
<FONT color="green">127</FONT> <a name="line.127"></a>
<FONT color="green">128</FONT> /**<a name="line.128"></a>
<FONT color="green">129</FONT> * Sets a LSSerializerFilter on the DOM Level 3 Serializer to filter nodes<a name="line.129"></a>
<FONT color="green">130</FONT> * during serialization.<a name="line.130"></a>
<FONT color="green">131</FONT> * <a name="line.131"></a>
<FONT color="green">132</FONT> * This interface is a public API.<a name="line.132"></a>
<FONT color="green">133</FONT> *<a name="line.133"></a>
<FONT color="green">134</FONT> * @param filter the Level 3 LSSerializerFilter<a name="line.134"></a>
<FONT color="green">135</FONT> */<a name="line.135"></a>
<FONT color="green">136</FONT> public void setNodeFilter(LSSerializerFilter filter) {<a name="line.136"></a>
<FONT color="green">137</FONT> fSerializerFilter = filter;<a name="line.137"></a>
<FONT color="green">138</FONT> }<a name="line.138"></a>
<FONT color="green">139</FONT> <a name="line.139"></a>
<FONT color="green">140</FONT> /**<a name="line.140"></a>
<FONT color="green">141</FONT> * Sets a SerializationHandler on the DOM Serializer.<a name="line.141"></a>
<FONT color="green">142</FONT> * <a name="line.142"></a>
<FONT color="green">143</FONT> * This interface is a public API.<a name="line.143"></a>
<FONT color="green">144</FONT> *<a name="line.144"></a>
<FONT color="green">145</FONT> * @param handler An instance of SerializationHandler<a name="line.145"></a>
<FONT color="green">146</FONT> */<a name="line.146"></a>
<FONT color="green">147</FONT> public void setSerializationHandler(SerializationHandler handler) {<a name="line.147"></a>
<FONT color="green">148</FONT> fSerializationHandler = handler;<a name="line.148"></a>
<FONT color="green">149</FONT> }<a name="line.149"></a>
<FONT color="green">150</FONT> <a name="line.150"></a>
<FONT color="green">151</FONT> /**<a name="line.151"></a>
<FONT color="green">152</FONT> * Sets the end-of-line sequence of characters to be used during serialization.<a name="line.152"></a>
<FONT color="green">153</FONT> * @param newLine The end-of-line sequence of characters to be used during serialization.<a name="line.153"></a>
<FONT color="green">154</FONT> */<a name="line.154"></a>
<FONT color="green">155</FONT> public void setNewLine(char[] newLine) {<a name="line.155"></a>
<FONT color="green">156</FONT> fNewLine = (newLine != null) ? new String(newLine) : null;<a name="line.156"></a>
<FONT color="green">157</FONT> }<a name="line.157"></a>
<FONT color="green">158</FONT> }<a name="line.158"></a>
</PRE>
</BODY>
</HTML>