001: /*
002: * The Apache Software License, Version 1.1
003: *
004: *
005: * Copyright (c) 1999 The Apache Software Foundation. All rights
006: * reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * 1. Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * 2. Redistributions in binary form must reproduce the above copyright
016: * notice, this list of conditions and the following disclaimer in
017: * the documentation and/or other materials provided with the
018: * distribution.
019: *
020: * 3. The end-user documentation included with the redistribution,
021: * if any, must include the following acknowledgment:
022: * "This product includes software developed by the
023: * Apache Software Foundation (http://www.apache.org/)."
024: * Alternately, this acknowledgment may appear in the software itself,
025: * if and wherever such third-party acknowledgments normally appear.
026: *
027: * 4. The names "Xerces" and "Apache Software Foundation" must
028: * not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact apache@apache.org.
031: *
032: * 5. Products derived from this software may not be called "Apache",
033: * nor may "Apache" appear in their name, without prior written
034: * permission of the Apache Software Foundation.
035: *
036: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
040: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: * SUCH DAMAGE.
048: * ====================================================================
049: *
050: * This software consists of voluntary contributions made by many
051: * individuals on behalf of the Apache Software Foundation and was
052: * originally based on software copyright (c) 1999, International
053: * Business Machines, Inc., http://www.apache.org. For more
054: * information on the Apache Software Foundation, please see
055: * <http://www.apache.org/>.
056: */
057:
058: package org.apache.xml.serialize;
059:
060: import java.io.OutputStream;
061: import java.io.Writer;
062: import java.io.UnsupportedEncodingException;
063: import java.util.Hashtable;
064: import java.util.StringTokenizer;
065:
066: /**
067: *
068: *
069: * @version $Revision: 1.5 $ $Date: 2000/12/05 22:48:29 $
070: * @author <a href="mailto:Scott_Boag/CAM/Lotus@lotus.com">Scott Boag</a>
071: * @author <a href="mailto:arkin@intalio.com">Assaf Arkin</a>
072: */
073: public abstract class SerializerFactory {
074:
075: public static final String FactoriesProperty = "org.apache.xml.serialize.factories";
076:
077: private static Hashtable _factories = new Hashtable();
078:
079: static {
080: SerializerFactory factory;
081: String list;
082: StringTokenizer token;
083: String className;
084:
085: // The default factories are always registered first,
086: // any factory specified in the properties file and supporting
087: // the same method will override the default factory.
088: factory = new SerializerFactoryImpl(Method.XML);
089: registerSerializerFactory(factory);
090: factory = new SerializerFactoryImpl(Method.HTML);
091: registerSerializerFactory(factory);
092: factory = new SerializerFactoryImpl(Method.XHTML);
093: registerSerializerFactory(factory);
094: factory = new SerializerFactoryImpl(Method.TEXT);
095: registerSerializerFactory(factory);
096:
097: list = System.getProperty(FactoriesProperty);
098: if (list != null) {
099: token = new StringTokenizer(list, " ;,:");
100: while (token.hasMoreTokens()) {
101: className = token.nextToken();
102: try {
103: factory = (SerializerFactory) Class.forName(
104: className).newInstance();
105: if (_factories.containsKey(factory
106: .getSupportedMethod()))
107: _factories.put(factory.getSupportedMethod(),
108: factory);
109: } catch (Exception except) {
110: }
111: }
112: }
113: }
114:
115: /**
116: * Register a serializer factory, keyed by the given
117: * method string.
118: */
119: public static void registerSerializerFactory(
120: SerializerFactory factory) {
121: String method;
122:
123: synchronized (_factories) {
124: method = factory.getSupportedMethod();
125: _factories.put(method, factory);
126: }
127: }
128:
129: /**
130: * Register a serializer factory, keyed by the given
131: * method string.
132: */
133: public static SerializerFactory getSerializerFactory(String method) {
134: return (SerializerFactory) _factories.get(method);
135: }
136:
137: /**
138: * Returns the method supported by this factory and used to register
139: * the factory. This call is required so factories can be added from
140: * a properties file by knowing only the class name. This method is
141: * protected, it is only required by this class but must be implemented
142: * in derived classes.
143: */
144: protected abstract String getSupportedMethod();
145:
146: /**
147: * Create a new serializer based on the {@link OutputFormat}.
148: * If this method is used to create the serializer, the {@link
149: * Serializer#setOutputByteStream} or {@link Serializer#setOutputCharStream}
150: * methods must be called before serializing a document.
151: */
152: public abstract Serializer makeSerializer(OutputFormat format);
153:
154: /**
155: * Create a new serializer, based on the {@link OutputFormat} and
156: * using the writer as the output character stream. If this
157: * method is used, the encoding property will be ignored.
158: */
159: public abstract Serializer makeSerializer(Writer writer,
160: OutputFormat format);
161:
162: /**
163: * Create a new serializer, based on the {@link OutputFormat} and
164: * using the output byte stream and the encoding specified in the
165: * output format.
166: *
167: * @throws UnsupportedEncodingException The specified encoding is
168: * not supported
169: */
170: public abstract Serializer makeSerializer(OutputStream output,
171: OutputFormat format) throws UnsupportedEncodingException;
172:
173: }
|