sboag 00/12/05 21:52:42
Modified: java/src/org/apache/xalan/templates Stylesheet.java
StylesheetRoot.java ElemTemplateElement.java
StylesheetComposed.java
Added: java/src/org/apache/xalan/templates output_html.properties
output_text.properties output_xml.properties
OutputProperties.java
Log:
Deleted OutputFormat and OutputFormatExtended in favor of new
OutputProperties class. Default properties are now resource based.
Serializers should be pluggable, though this hasn't been tested.
Entity references are now specified through resources, and a bitmap
is built for fast test to determine special status of character.
indent-amount and URI character escaping can now be controled
via xalan attributes on xsl:output.
Revision Changes Path
1.20 +11 -10
xml-xalan/java/src/org/apache/xalan/templates/Stylesheet.java
Index: Stylesheet.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/Stylesheet.java,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- Stylesheet.java 2000/12/05 22:43:48 1.19
+++ Stylesheet.java 2000/12/06 05:52:40 1.20
@@ -750,7 +750,7 @@
}
/**
- * The "xsl:output" properties. This is a vector of OutputFormatExtended
objects.
+ * The "xsl:output" properties. This is a vector of OutputProperties
objects.
*/
private Vector m_output;
@@ -758,9 +758,10 @@
* Set the "xsl:output" property.
* @see <a href="http://www.w3.org/TR/xslt#output";>output in XSLT
Specification</a>
*
- * @param v OutputFormatExtended element to add to the list
+ * @param v non-null reference to the OutputProperties object to be
+ * added to the collection.
*/
- public void setOutput(OutputFormatExtended v)
+ public void setOutput(OutputProperties v)
{
if (null == m_output)
{
@@ -776,24 +777,24 @@
*
* @param i Index of OutputFormatExtended to get
*
- * @return OutputFormatExtended at the given index
+ * @return non-null reference to an OutputProperties object.
*
* @throws ArrayIndexOutOfBoundsException
*/
- public OutputFormatExtended getOutput(int i) throws
ArrayIndexOutOfBoundsException
+ public OutputProperties getOutput(int i) throws
ArrayIndexOutOfBoundsException
{
if (null == m_output)
throw new ArrayIndexOutOfBoundsException();
- return (OutputFormatExtended) m_output.elementAt(i);
+ return (OutputProperties) m_output.elementAt(i);
}
/**
* Get the number of "xsl:output" properties.
* @see <a href="http://www.w3.org/TR/xslt#output";>output in XSLT
Specification</a>
*
- * @return the number of "xsl:output" properties.
+ * @return The number of OutputProperties objects contained in this
stylesheet.
*/
public int getOutputCount()
{
@@ -928,7 +929,7 @@
* Get an "xsl:variable" or "xsl:param" property.
* @see <a
href="http://www.w3.org/TR/xslt#top-level-variables";>top-level-variables in
XSLT Specification</a>
*
- * @param qname Qualified name of variable or param to get
+ * @param qname non-null reference to the qualified name of the variable.
*
* @return The ElemVariable with the given name in the list or null
*/
@@ -958,7 +959,7 @@
*
* @param qname Qualified name of the xsl:variable to get
*
- * @return ElemVariable with the given name in the list or null
+ * @return reference to the variable named by qname, or null if not found.
*/
public ElemVariable getVariable(QName qname)
{
@@ -1024,7 +1025,7 @@
* Get an "xsl:param" property.
* @see <a
href="http://www.w3.org/TR/xslt#top-level-variables";>top-level-variables in
XSLT Specification</a>
*
- * @param qname The qualified name of the param to get
+ * @param qname non-null reference to qualified name of the parameter.
*
* @return ElemParam with the given name in the list or null
*/
1.30 +36 -84
xml-xalan/java/src/org/apache/xalan/templates/StylesheetRoot.java
Index: StylesheetRoot.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/StylesheetRoot.java,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
--- StylesheetRoot.java 2000/12/05 22:52:10 1.29
+++ StylesheetRoot.java 2000/12/06 05:52:40 1.30
@@ -172,23 +172,7 @@
public Properties getDefaultOutputProps()
{
- OutputFormat outputProps = m_outputFormatComposed;
- Properties defaultProps = new Properties();
- defaultProps.put(OutputKeys.METHOD, outputProps.getMethod());
- defaultProps.put(OutputKeys.INDENT, outputProps.getIndent() ? "yes" :
"no");
- if(null != outputProps.getDoctypePublicId())
- defaultProps.put(OutputKeys.DOCTYPE_PUBLIC,
outputProps.getDoctypePublicId());
- if(null != outputProps.getDoctypeSystemId())
- defaultProps.put(OutputKeys.DOCTYPE_SYSTEM,
outputProps.getDoctypeSystemId());
- if(null != outputProps.getMediaType())
- defaultProps.put(OutputKeys.MEDIA_TYPE, outputProps.getMediaType());
- defaultProps.put(OutputKeys.OMIT_XML_DECLARATION,
outputProps.getOmitXMLDeclaration() ? "yes" : "no");
- defaultProps.put(OutputKeys.STANDALONE, outputProps.getStandalone() ?
"yes" : "no");
- if(null != outputProps.getEncoding())
- defaultProps.put(OutputKeys.ENCODING, outputProps.getEncoding());
- if(null != outputProps.getVersion())
- defaultProps.put(OutputKeys.VERSION, outputProps.getVersion());
- return defaultProps;
+ return m_outputProperties.getProperties();
}
/**
@@ -207,46 +191,6 @@
return getDefaultOutputProps();
}
- /**
- * Get the properties for xsl:output. The object returned will
- * be a clone of the internal values, and thus it can be mutated
- * without mutating the Templates object, and then handed in to
- * the process method.
- * <p>A stylesheet may contain multiple xsl:output elements and may
- * include or import stylesheets that also contain xsl:output elements.
- * All the xsl:output elements occurring in a stylesheet are merged
- * into a single effective xsl:output element. For the
- * cdata-section-elements attribute, the effective value is the
- * union of the specified values. For other attributes, the effective
- * value is the specified value with the highest import precedence.
- * It is an error if there is more than one such value for an attribute.
- * An XSLT processor may signal the error; if it does not signal the
- * error, if should recover by using the value that occurs last in
- * the stylesheet. The values of attributes are defaulted after
- * the xsl:output elements have been merged; different output
- * methods may have different default values for an attribute.</p>
- * @see <a href="http://www.w3.org/TR/xslt#output";>output in XSLT
Specification</a>
- * @return A Properties object that may be mutated.
- *
- * @see org.xml.org.apache.xalan.serialize.OutputFormat
- */
- public OutputFormat getOutputFormat()
- {
-
- OutputFormatExtended cloned = new OutputFormatExtended(0);
-
- if (m_outputFormatComposed instanceof OutputFormatExtended)
- {
- cloned.copyFrom((OutputFormatExtended) m_outputFormatComposed);
- }
- else
- {
- cloned.copyFrom(m_outputFormatComposed);
- }
-
- return cloned;
- }
-
//============== End Templates Interface ================
/**
@@ -304,7 +248,8 @@
// We set up the global variables that will hold the recomposed
information.
- m_outputFormatComposed = new OutputFormatExtended(0);
+ m_outputProperties = new OutputProperties(Method.XML);
+
m_attrSets = new Hashtable();
m_decimalFormatSymbols = new Hashtable();
m_keyDecls = new Vector();
@@ -316,13 +261,14 @@
// calling the recompose() function on each one. This will call back
into the
// appropriate routine here to actually do the recomposition.
// Note that we're going backwards, encountering the highest precedence
items first.
-
for (int i = recomposableElements.size() - 1; i >= 0; i--)
((Recomposable) recomposableElements.elementAt(i)).recompose(this);
-
+
// Need final composition of TemplateList. This adds the wild cards
onto the chains.
-
m_templateList.compose();
+
+ // Need to clear check for properties at the same import level.
+ m_outputProperties.compose();
// Now call the compose() method on every element to give it a chance to
adjust
// based on composed values.
@@ -344,7 +290,9 @@
/**
* Call the compose function for each ElemTemplateElement.
*
- * @param templ ElemTemplateElement to compose
+ * @param templ non-null reference to template element that will have
+ * the composed method called on it, and will have it's children's
composed
+ * methods called.
*/
static void composeTemplates(ElemTemplateElement templ)
{
@@ -475,16 +423,18 @@
* This will be set up with the default values, and then the values
* will be set as stylesheets are encountered.
*/
- private OutputFormatExtended m_outputFormatComposed;
+ private OutputProperties m_outputProperties;
/**
* Recompose the output format object from the included elements.
*
- * @param of OutputFormatExtended to recompose
+ * @param oprops non-null reference to xsl:output properties
representation.
*/
- void recomposeOutput(OutputFormatExtended of)
+ void recomposeOutput(OutputProperties oprops)
+ throws TransformerException
{
- m_outputFormatComposed.copyFrom(of);
+
+ m_outputProperties.copyFrom(oprops);
}
/**
@@ -492,19 +442,18 @@
* combined from the included stylesheets. If a xsl:output
* is not declared in this stylesheet or an included stylesheet,
* look in the imports.
- * Please note that this returns a reference to the OutputFormat
- * object, not a cloned object, like getOutputFormat does.
+ * Please note that this returns a reference to the OutputProperties
+ * object, not a cloned object, like getOutputProperties does.
* @see <a href="http://www.w3.org/TR/xslt#output";>output in XSLT
Specification</a>
*
- * @return the combined "xsl:output" property with the properties
- * combined from the included stylesheets.
+ * @return non-null reference to composed output properties object.
*/
- public OutputFormat getOutputComposed()
+ public OutputProperties getOutputComposed()
{
- // System.out.println("getOutputComposed.getIndent:
"+m_outputFormatComposed.getIndent());
- // System.out.println("getOutputComposed.getIndenting:
"+m_outputFormatComposed.getIndenting());
- return m_outputFormatComposed;
+ // System.out.println("getOutputComposed.getIndent:
"+m_outputProperties.getIndent());
+ // System.out.println("getOutputComposed.getIndenting:
"+m_outputProperties.getIndenting());
+ return m_outputProperties;
}
/** Flag indicating whether an output method has been set by the user
*/
@@ -724,24 +673,27 @@
* well as this stylesheet.
* @see <a
href="http://www.w3.org/TR/xslt#section-Defining-Template-Rules";>section-Defining-Template-Rules
in XSLT Specification</a>
*
- * @param support The XPath runtime state.
- * @param targetNode Node to match
- * @param mode Template mode
- * @param quietConflictWarnings Flag for conflict warnings
+ * @param xctxt non-null reference to XPath runtime execution context.
+ * @param targetNode non-null reference of node that the template must
match.
+ * @param mode qualified name of the node, or null.
+ * @param maxImportLevel The maximum importCountComposed that we should
consider or -1
+ * if we should consider all import levels. This is used by
apply-imports to
+ * access templates that have been overridden.
+ * @param quietConflictWarnings true if conflict warnings should not be
reported.
*
- *
- * @return The ElemTemplate matching the target node
+ * @return reference to ElemTemplate that is the best match for
targetNode, or
+ * null if no match could be made.
*
* @throws TransformerException
*/
- public ElemTemplate getTemplateComposed(XPathContext support,
+ public ElemTemplate getTemplateComposed(XPathContext xctxt,
Node targetNode,
QName mode,
int maxImportLevel,
boolean quietConflictWarnings)
throws TransformerException
{
- return m_templateList.getTemplate(support, targetNode, mode,
maxImportLevel,
+ return m_templateList.getTemplate(xctxt, targetNode, mode,
maxImportLevel,
quietConflictWarnings);
}
@@ -750,9 +702,9 @@
* well as this stylesheet.
* @see <a
href="http://www.w3.org/TR/xslt#section-Defining-Template-Rules";>section-Defining-Template-Rules
in XSLT Specification</a>
*
- * @param qname Qualified name of template to get
+ * @param qname non-null reference to qualified name of template.
*
- * @return ElemTemplate matching the given name
+ * @return reference to named template, or null if not found.
*/
public ElemTemplate getTemplateComposed(QName qname)
{
1.29 +0 -4
xml-xalan/java/src/org/apache/xalan/templates/ElemTemplateElement.java
Index: ElemTemplateElement.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/ElemTemplateElement.java,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -r1.28 -r1.29
--- ElemTemplateElement.java 2000/12/05 22:29:30 1.28
+++ ElemTemplateElement.java 2000/12/06 05:52:41 1.29
@@ -80,10 +80,6 @@
import javax.xml.transform.Templates;
import javax.xml.transform.SourceLocator;
-// Serializer imports
-import org.apache.xalan.serialize.OutputFormat;
-import org.apache.xalan.serialize.Serializer;
-
// DOM Imports
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
1.23 +2 -4
xml-xalan/java/src/org/apache/xalan/templates/StylesheetComposed.java
Index: StylesheetComposed.java
===================================================================
RCS file:
/home/cvs/xml-xalan/java/src/org/apache/xalan/templates/StylesheetComposed.java,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- StylesheetComposed.java 2000/12/05 22:29:35 1.22
+++ StylesheetComposed.java 2000/12/06 05:52:41 1.23
@@ -63,7 +63,6 @@
import javax.xml.transform.TransformerConfigurationException;
import org.apache.xpath.XPath;
import org.apache.xml.utils.QName;
-import org.apache.xalan.serialize.OutputFormat;
import org.apache.xalan.transformer.TransformerImpl;
import org.apache.xpath.XPathContext;
@@ -80,7 +79,7 @@
* imports. It has methods on it that
* return "composed" properties, which mean that:
* <ol>
- * <li>Properties that are aggregates, like OutputFormat, will
+ * <li>Properties that are aggregates, like OutputProperties, will
* be composed of properties declared in this stylsheet and all
* included stylesheets.</li>
* <li>Properties that aren't found, will be searched for first in
@@ -149,8 +148,7 @@
int s = included.getOutputCount();
for (int j = 0; j < s; j++)
{
- OutputFormatExtended ofe = included.getOutput(j);
- recomposableElements.addElement(new RecomposableImpl(this,
ofe.getUid(), ofe));
+ recomposableElements.addElement(included.getOutput(j));
}
// Next, add in the attribute-set elements
1.1
xml-xalan/java/src/org/apache/xalan/templates/output_html.properties
Index: output_html.properties
===================================================================
#
# Specify defaults when method="html". These defaults use
output_xml.properties
# as a base.
#
# XSLT properties do not need namespace qualification.
method=xml
indent=yes
# Xalan-specific output properties. These can be overridden in the
stylesheet
# assigning a xalan namespace. For example:
# <xsl:stylesheet version="1.0"
# xmlns:xsl="http://www.w3.org/1999/XSL/Transform";
# xmlns:xalan="http://xml.apache.org/xslt";>
# <xsl:output method="html" encoding="UTF-8"
# xalan:content-handler="MyContentHandler"/>
# ...
# Note that the colon after the protocol needs to be escaped.
{http\u003a//xml.apache.org/xslt}indent-amount=0
{http\u003a//xml.apache.org/xslt}content-handler=org.apache.xalan.serialize.FormatterToHTML
{http\u003a//xml.apache.org/xslt}entities=HTMLEntities.res
{http\u003a//xml.apache.org/xslt}use-url-escaping=yes
1.1
xml-xalan/java/src/org/apache/xalan/templates/output_text.properties
Index: output_text.properties
===================================================================
#
# Specify defaults when method="text". These defaults use
output_xml.properties
# as a base.
#
# XSLT properties do not need namespace qualification.
method=text
# Xalan-specific output properties. These can be overridden in the
stylesheet
# assigning a xalan namespace. For example:
# <xsl:stylesheet version="1.0"
# xmlns:xsl="http://www.w3.org/1999/XSL/Transform";
# xmlns:xalan="http://xml.apache.org/xslt";>
# <xsl:output method="html" encoding="UTF-8"
# xalan:content-handler="MyContentHandler"/>
# ...
# Note that the colon after the protocol needs to be escaped.
{http\u003a//xml.apache.org/xslt}content-handler=org.apache.xalan.serialize.FormatterToText
1.1
xml-xalan/java/src/org/apache/xalan/templates/output_xml.properties
Index: output_xml.properties
===================================================================
#
# Specify defaults when method="xml". These defaults serve as a base for
# other defaults, such as output_html and output_text.
#
# XSLT properties do not need namespace qualification.
method=xml
version=1.0
encoding=UTF-8
indent=no
omit-xml-declaration=no
standalone=no
media-type=text/xml
# Xalan-specific output properties. These can be overridden in the
stylesheet
# assigning a xalan namespace. For example:
# <xsl:stylesheet version="1.0"
# xmlns:xsl="http://www.w3.org/1999/XSL/Transform";
# xmlns:xalan="http://xml.apache.org/xslt";>
# <xsl:output method="html" encoding="UTF-8"
# xalan:content-handler="MyContentHandler"/>
# ...
# Note that the colon after the protocol needs to be escaped.
{http\u003a//xml.apache.org/xslt}indent-amount=0
{http\u003a//xml.apache.org/xslt}content-handler=org.apache.xalan.serialize.FormatterToXML
1.1
xml-xalan/java/src/org/apache/xalan/templates/OutputProperties.java
Index: OutputProperties.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Xalan" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 1999, Lotus
* Development Corporation., http://www.lotus.com. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.xalan.templates;
import java.io.BufferedInputStream;
import java.io.InputStream;
import java.io.IOException;
import java.util.Vector;
import java.util.Properties;
import java.util.Enumeration;
import java.lang.Cloneable;
import org.w3c.dom.Document;
import org.apache.xml.utils.QName;
import org.apache.xml.utils.FastStringBuffer;
import org.apache.xml.utils.WrappedRuntimeException;
import org.apache.xalan.serialize.Method;
import javax.xml.transform.TransformerException;
import javax.xml.transform.OutputKeys;
/**
* This class provides information from xsl:output elements. It is mainly
* a wrapper for [EMAIL PROTECTED] java.util.Properties}, but can not extend
that class
* because it must be part of the [EMAIL PROTECTED]
org.apache.xalan.templates.ElemTemplateElement}
* heararchy.
* <p>An OutputProperties list can contain another OutputProperties list as
* its "defaults"; this second property list is searched if the property key
* is not found in the original property list.</p>
* @see <a href="http://www.w3.org/TR/xslt#dtd";>XSLT DTD</a>
* @see <a href="http://www.w3.org/TR/xslt#output";>xsl:output in XSLT
Specification</a>
* @
*/
public class OutputProperties extends ElemTemplateElement
implements RecomposableBase, Cloneable
{
/**
* Creates an empty OutputProperties with no default values.
*/
public OutputProperties()
{
this(Method.XML);
}
/**
* Creates an empty OutputProperties with the specified defaults.
*
* @param defaults the defaults.
*/
public OutputProperties(Properties defaults)
{
m_properties = new Properties(defaults);
}
/**
* Creates an empty OutputProperties with the defaults specified by
* a property file. The method argument is used to construct a string of
* the form output_[method].properties (for instance,
output_html.properties).
* The output_xml.properties file is always used as the base.
* <p>At the moment, anything other than 'text', 'xml', and 'html', will
* use the output_xml.properties file.</p>
*
* @param method non-null reference to method name.
*/
public OutputProperties(String method)
{
m_properties = new Properties(getDefaultMethodProperties(method));
}
/**
* Creates an empty OutputProperties with the defaults specified by
* a property file. The method argument is used to construct a string of
* the form output_[method].properties (for instance,
output_html.properties).
* The output_xml.properties file is always used as the base.
* <p>At the moment, anything other than 'text', 'xml', and 'html', will
* use the output_xml.properties file.</p>
*
* @param method non-null reference to method name.
*
* @return Properties object that holds the defaults for the given method.
*/
static public Properties getDefaultMethodProperties(String method)
{
Properties defaultProperties = null;
try
{
if (null == m_xml_properties) // fast check
{
synchronized (m_synch_object)
{
if (null == m_xml_properties) // double check
{
m_xml_properties = new Properties();
InputStream is = OutputProperties.class.getResourceAsStream(
"output_xml.properties");
BufferedInputStream bis = new BufferedInputStream(is);
m_xml_properties.load(bis);
}
}
}
if (method.equals(Method.XML))
{
defaultProperties = m_xml_properties;
}
else if (method.equals(Method.HTML))
{
if (null == m_html_properties) // fast check
{
synchronized (m_synch_object)
{
if (null == m_html_properties) // double check
{
m_html_properties = new Properties(m_xml_properties);
InputStream is = OutputProperties.class.getResourceAsStream(
"output_html.properties");
BufferedInputStream bis = new BufferedInputStream(is);
m_html_properties.load(bis);
}
}
}
defaultProperties = m_html_properties;
}
else if (method.equals(Method.Text))
{
if (null == m_text_properties) // fast check
{
synchronized (m_synch_object)
{
if (null == m_text_properties) // double check
{
m_text_properties = new Properties(m_xml_properties);
InputStream is = OutputProperties.class.getResourceAsStream(
"output_text.properties");
BufferedInputStream bis = new BufferedInputStream(is);
m_text_properties.load(bis);
}
}
}
defaultProperties = m_text_properties;
}
else
{
// TODO: Calculate res file from name.
defaultProperties = m_xml_properties;
}
}
catch (IOException ioe)
{
throw new org.apache.xml.utils.WrappedRuntimeException(ioe);
}
return defaultProperties;
}
/**
* Clone this OutputProperties, including a clone of the wrapped Properties
* reference.
*
* @return A new OutputProperties reference, mutation of which should not
* effect this object.
*/
public Object clone()
{
try
{
OutputProperties cloned = (OutputProperties) super.clone();
cloned.m_properties = (Properties) cloned.m_properties.clone();
return cloned;
}
catch (CloneNotSupportedException e)
{
return null;
}
}
/**
* Set an output property.
*
* @param key the key to be placed into the property list.
* @param value the value corresponding to <tt>key</tt>.
* @see [EMAIL PROTECTED] javax.xml.transform.OutputKeys}.
*/
public void setProperty(QName key, String value)
{
setProperty(key.toNamespacedString(), value);
}
/**
* Set an output property.
*
* @param key the key to be placed into the property list.
* @param value the value corresponding to <tt>key</tt>.
* @see [EMAIL PROTECTED] javax.xml.transform.OutputKeys}.
*/
public void setProperty(String key, String value)
{
if(key.equals(OutputKeys.METHOD))
{
setMethodDefaults(value);
}
m_properties.put(key, value);
}
/**
* Searches for the property with the specified key in the property list.
* If the key is not found in this property list, the default property list,
* and its defaults, recursively, are then checked. The method returns
* <code>null</code> if the property is not found.
*
* @param key the property key.
* @return the value in this property list with the specified key value.
*/
public String getProperty(QName key)
{
return m_properties.getProperty(key.toNamespacedString());
}
/**
* Searches for the property with the specified key in the property list.
* If the key is not found in this property list, the default property list,
* and its defaults, recursively, are then checked. The method returns
* <code>null</code> if the property is not found.
*
* @param key the property key.
* @return the value in this property list with the specified key value.
*/
public String getProperty(String key)
{
return m_properties.getProperty(key);
}
/**
* Set an output property.
*
* @param key the key to be placed into the property list.
* @param value the value corresponding to <tt>key</tt>.
* @see [EMAIL PROTECTED] javax.xml.transform.OutputKeys}.
*/
public void setBooleanProperty(QName key, boolean value)
{
m_properties.put(key.toNamespacedString(), value ? "yes" : "no");
}
/**
* Set an output property.
*
* @param key the key to be placed into the property list.
* @param value the value corresponding to <tt>key</tt>.
* @see [EMAIL PROTECTED] javax.xml.transform.OutputKeys}.
*/
public void setBooleanProperty(String key, boolean value)
{
m_properties.put(key, value ? "yes" : "no");
}
/**
* Searches for the boolean property with the specified key in the property
list.
* If the key is not found in this property list, the default property list,
* and its defaults, recursively, are then checked. The method returns
* <code>false</code> if the property is not found, or if the value is other
* than "yes".
*
* @param key the property key.
* @return the value in this property list as a boolean value, or false
* if null or not "yes".
*/
public boolean getBooleanProperty(QName key)
{
return getBooleanProperty(key.toNamespacedString());
}
/**
* Searches for the boolean property with the specified key in the property
list.
* If the key is not found in this property list, the default property list,
* and its defaults, recursively, are then checked. The method returns
* <code>false</code> if the property is not found, or if the value is other
* than "yes".
*
* @param key the property key.
* @return the value in this property list as a boolean value, or false
* if null or not "yes".
*/
public boolean getBooleanProperty(String key)
{
return getBooleanProperty(key, m_properties);
}
/**
* Searches for the boolean property with the specified key in the property
list.
* If the key is not found in this property list, the default property list,
* and its defaults, recursively, are then checked. The method returns
* <code>false</code> if the property is not found, or if the value is other
* than "yes".
*
* @param key the property key.
* @param props the list of properties that will be searched.
* @return the value in this property list as a boolean value, or false
* if null or not "yes".
*/
public static boolean getBooleanProperty(String key, Properties props)
{
String s = props.getProperty(key);
if (null == s ||!s.equals("yes"))
return false;
else
return true;
}
/**
* Set an output property.
*
* @param key the key to be placed into the property list.
* @param value the value corresponding to <tt>key</tt>.
* @see [EMAIL PROTECTED] javax.xml.transform.OutputKeys}.
*/
public void setIntProperty(QName key, int value)
{
setIntProperty(key.toNamespacedString(), value);
}
/**
* Set an output property.
*
* @param key the key to be placed into the property list.
* @param value the value corresponding to <tt>key</tt>.
* @see [EMAIL PROTECTED] javax.xml.transform.OutputKeys}.
*/
public void setIntProperty(String key, int value)
{
m_properties.put(key, Integer.toString(value));
}
/**
* Searches for the int property with the specified key in the property
list.
* If the key is not found in this property list, the default property list,
* and its defaults, recursively, are then checked. The method returns
* <code>false</code> if the property is not found, or if the value is other
* than "yes".
*
* @param key the property key.
* @return the value in this property list as a int value, or false
* if null or not a number.
*/
public int getIntProperty(QName key)
{
return getIntProperty(key.toNamespacedString());
}
/**
* Searches for the int property with the specified key in the property
list.
* If the key is not found in this property list, the default property list,
* and its defaults, recursively, are then checked. The method returns
* <code>false</code> if the property is not found, or if the value is other
* than "yes".
*
* @param key the property key.
* @return the value in this property list as a int value, or false
* if null or not a number.
*/
public int getIntProperty(String key)
{
return getIntProperty(key, m_properties);
}
/**
* Searches for the int property with the specified key in the property
list.
* If the key is not found in this property list, the default property list,
* and its defaults, recursively, are then checked. The method returns
* <code>false</code> if the property is not found, or if the value is other
* than "yes".
*
* @param key the property key.
* @param props the list of properties that will be searched.
* @return the value in this property list as a int value, or 0
* if null or not a number.
*/
public static int getIntProperty(String key, Properties props)
{
String s = props.getProperty(key);
if (null == s)
return 0;
else
return Integer.parseInt(s);
}
/**
* Set an output property with a QName value. The QName will be turned
* into a string with the namespace in curly brackets.
*
* @param key the key to be placed into the property list.
* @param value the value corresponding to <tt>key</tt>.
* @see [EMAIL PROTECTED] javax.xml.transform.OutputKeys}.
*/
public void setQNameProperty(QName key, QName value)
{
setQNameProperty(key.toNamespacedString(), value);
}
/**
* Reset the default properties based on the method.
*
* @param method the method value.
* @see [EMAIL PROTECTED] javax.xml.transform.OutputKeys}.
*/
public void setMethodDefaults(String method)
{
String defaultMethod = m_properties.getProperty(OutputKeys.METHOD);
if((null == defaultMethod) || !defaultMethod.equals(method))
{
Properties savedProps = m_properties;
Properties newDefaults = getDefaultMethodProperties(method);
m_properties = new Properties(newDefaults);
copyFrom(savedProps, false);
}
}
/**
* Set an output property with a QName value. The QName will be turned
* into a string with the namespace in curly brackets.
*
* @param key the key to be placed into the property list.
* @param value the value corresponding to <tt>key</tt>.
* @see [EMAIL PROTECTED] javax.xml.transform.OutputKeys}.
*/
public void setQNameProperty(String key, QName value)
{
setProperty(key, value.toNamespacedString());
}
/**
* Searches for the qname property with the specified key in the property
list.
* If the key is not found in this property list, the default property list,
* and its defaults, recursively, are then checked. The method returns
* <code>null</code> if the property is not found.
*
* @param key the property key.
* @return the value in this property list as a QName value, or false
* if null or not "yes".
*/
public QName getQNameProperty(QName key)
{
return getQNameProperty(key.toNamespacedString());
}
/**
* Searches for the qname property with the specified key in the property
list.
* If the key is not found in this property list, the default property list,
* and its defaults, recursively, are then checked. The method returns
* <code>null</code> if the property is not found.
*
* @param key the property key.
* @return the value in this property list as a QName value, or false
* if null or not "yes".
*/
public QName getQNameProperty(String key)
{
return getQNameProperty(key, m_properties);
}
/**
* Searches for the qname property with the specified key in the property
list.
* If the key is not found in this property list, the default property list,
* and its defaults, recursively, are then checked. The method returns
* <code>null</code> if the property is not found.
*
* @param key the property key.
* @param props the list of properties to search in.
* @return the value in this property list as a QName value, or false
* if null or not "yes".
*/
public static QName getQNameProperty(String key, Properties props)
{
String s = props.getProperty(key);
if (null != s)
return QName.getQNameFromString(s);
else
return null;
}
/**
* Set an output property with a QName list value. The QNames will be
turned
* into strings with the namespace in curly brackets.
*
* @param key the key to be placed into the property list.
* @param v non-null list of QNames corresponding to <tt>key</tt>.
* @see [EMAIL PROTECTED] javax.xml.transform.OutputKeys}.
*/
public void setQNameProperties(QName key, Vector v)
{
setQNameProperties(key.toNamespacedString(), v);
}
/**
* Set an output property with a QName list value. The QNames will be
turned
* into strings with the namespace in curly brackets.
*
* @param key the key to be placed into the property list.
* @param v non-null list of QNames corresponding to <tt>key</tt>.
* @see [EMAIL PROTECTED] javax.xml.transform.OutputKeys}.
*/
public void setQNameProperties(String key, Vector v)
{
int s = v.size();
FastStringBuffer fsb = new FastStringBuffer();
for (int i = 0; i < s; i++)
{
QName qname = (QName) v.elementAt(i);
fsb.append(qname.toNamespacedString());
fsb.append(' ');
}
m_properties.put(key, fsb.toString());
}
/**
* Searches for the list of qname properties with the specified key in
* the property list.
* If the key is not found in this property list, the default property list,
* and its defaults, recursively, are then checked. The method returns
* <code>null</code> if the property is not found.
*
* @param key the property key.
* @return the value in this property list as a vector of QNames, or false
* if null or not "yes".
*/
public Vector getQNameProperties(QName key)
{
return getQNameProperties(key.toNamespacedString());
}
/**
* Searches for the list of qname properties with the specified key in
* the property list.
* If the key is not found in this property list, the default property list,
* and its defaults, recursively, are then checked. The method returns
* <code>null</code> if the property is not found.
*
* @param key the property key.
* @return the value in this property list as a vector of QNames, or false
* if null or not "yes".
*/
public Vector getQNameProperties(String key)
{
return getQNameProperties(key, m_properties);
}
/**
* Searches for the list of qname properties with the specified key in
* the property list.
* If the key is not found in this property list, the default property list,
* and its defaults, recursively, are then checked. The method returns
* <code>null</code> if the property is not found.
*
* @param key the property key.
* @param props the list of properties to search in.
* @return the value in this property list as a vector of QNames, or false
* if null or not "yes".
*/
public static Vector getQNameProperties(String key, Properties props)
{
String s = props.getProperty(key);
if (null != s)
{
Vector v = new Vector();
int l = s.length();
boolean inCurly = false;
FastStringBuffer buf = new FastStringBuffer();
// parse through string, breaking on whitespaces. I do this instead
// of a tokenizer so I can track whitespace inside of curly brackets,
// which theoretically shouldn't happen if they contain legal URLs.
for (int i = 0; i < l; i++)
{
char c = s.charAt(i);
if (Character.isWhitespace(c))
{
if (!inCurly)
{
if (buf.length() > 0)
{
QName qname = QName.getQNameFromString(buf.toString());
v.addElement(qname);
buf.reset();
}
continue;
}
}
else if ('{' == c)
inCurly = true;
else if ('}' == c)
inCurly = false;
buf.append(c);
}
if (buf.length() > 0)
{
QName qname = QName.getQNameFromString(buf.toString());
v.addElement(qname);
buf.reset();
}
return v;
}
else
return null;
}
/**
* This function is called to recompose all of the output format extended
elements.
*
* @param root non-null reference to the stylesheet root object.
*/
public void recompose(StylesheetRoot root)
throws TransformerException
{
root.recomposeOutput(this);
}
/**
* This function is called after everything else has been
* recomposed, and allows the template to set remaining
* values that may be based on some other property that
* depends on recomposition.
*/
public void compose()
{
super.compose(); // just good form, not really needed.
m_currentStylesheetComposed = null;
}
/**
* Get the Properties object that this class wraps.
*
* @return non-null reference to Properties object.
*/
public Properties getProperties()
{
return m_properties;
}
/**
* Copy the keys and values from the source to this object. This will
* not copy the default values. This is meant to be used by going from
* a higher precedence object to a lower precedence object, so that if a
* key already exists, this method will not reset it.
*
* @param src non-null reference to the source properties.
*/
public void copyFrom(Properties src)
{
copyFrom(src, true);
}
/**
* Copy the keys and values from the source to this object. This will
* not copy the default values. This is meant to be used by going from
* a higher precedence object to a lower precedence object, so that if a
* key already exists, this method will not reset it.
*
* @param src non-null reference to the source properties.
* @param shouldResetDefaults true if the defaults should be reset based on
* the method property.
*/
public void copyFrom(Properties src, boolean shouldResetDefaults)
{
Enumeration enum = src.keys();
while (enum.hasMoreElements())
{
String key = (String) enum.nextElement();
if (null == m_properties.get(key))
{
String val = (String) src.get(key);
if(shouldResetDefaults && key.equals(OutputKeys.METHOD))
{
setMethodDefaults(val);
}
m_properties.put(key, val);
}
}
}
/**
* Copy the keys and values from the source to this object. This will
* not copy the default values. This is meant to be used by going from
* a higher precedence object to a lower precedence object, so that if a
* key already exists, this method will not reset it.
*
* @param opsrc non-null reference to an OutputProperties.
*/
public void copyFrom(OutputProperties opsrc)
throws TransformerException
{
checkDuplicates(opsrc);
copyFrom(opsrc.getProperties());
}
/**
* Check to see if a set of properties is at the same import level as the
* last set of properties set that was passed as an argument to this method.
* This operation assumes that the OutputProperties are being called
* from most important to least important, in document order.
*
* @param newProps non-null reference to OutputProperties that is about to
* be added to this set.
*/
private void checkDuplicates(OutputProperties newProps)
throws TransformerException
{
// This operation assumes that the OutputProperties are being called
// from most important to least important, in document order.
// Are the new properties at the same importance level as the properties
// that were last used?
StylesheetComposed sc = newProps.getStylesheetComposed();
if (sc != m_currentStylesheetComposed)
{
m_currentStylesheetComposed = sc;
}
else
{
Properties p = newProps.getProperties();
Enumeration enum = p.keys();
while (enum.hasMoreElements())
{
String key = (String) enum.nextElement();
// Do we already have this property? Call hashtable operation,
// since we don't want to look at default properties.
if (null != m_properties.get(key))
{
String msg = key + " can not be multiply defined at the same "
+ "import level!";
throw new TransformerException(msg, newProps);
}
}
}
}
/**
* Report if the key given as an argument is a legal xsl:output key.
*
* @param key non-null reference to key name.
*
* @return true if key is legal.
*/
public boolean isLegalPropertyKey(String key)
{
return (key.equals(OutputKeys.CDATA_SECTION_ELEMENTS)
|| key.equals(OutputKeys.DOCTYPE_PUBLIC)
|| key.equals(OutputKeys.DOCTYPE_SYSTEM)
|| key.equals(OutputKeys.ENCODING)
|| key.equals(OutputKeys.INDENT)
|| key.equals(OutputKeys.MEDIA_TYPE)
|| key.equals(OutputKeys.METHOD)
|| key.equals(OutputKeys.OMIT_XML_DECLARATION)
|| key.equals(OutputKeys.STANDALONE)
|| key.equals(OutputKeys.VERSION)
|| (key.length() > 0) && (key.charAt(0) == '{'));
}
/**
* This ugly field is to let us know what StylesheetComposed was last
* used to set this element, so we can flag errors about values being
* set multiple time at the same precedence level. There is likely to
* be discovered a better way to do this, but this is the easiest mechanism
* I can work out for the moment. Note that this field is only used
* during recomposition, with the OutputProperties object owned by the
* [EMAIL PROTECTED] org.apache.xalan.templates.StylesheetRoot} object.
*/
private transient StylesheetComposed m_currentStylesheetComposed;
/** The output properties. */
private Properties m_properties = null;
// Some special Xalan keys.
/** The number of whitespaces to indent by, if indent="yes". */
public static String S_KEY_INDENT_AMOUNT =
"{http://xml.apache.org/xslt}indent-amount";;
/**
* Fully qualified name of class with a default constructor that
* implements the ContentHandler interface, where the result tree events
* will be sent to.
*/
public static String S_KEY_CONTENT_HANDLER =
"{http://xml.apache.org/xslt}content-handler";;
/** File name of file that specifies character to entity reference
mappings. */
public static String S_KEY_ENTITIES =
"{http://xml.apache.org/xslt}entities";;
/** Use a value of "yes" if the href values for HTML serialization should
* use %xx escaping. */
public static String S_USE_URL_ESCAPING =
"{http://xml.apache.org/xslt}use-url-escaping";;
/** The default properties of all output files. */
private static Properties m_xml_properties = null;
/** The default properties when method="html". */
private static Properties m_html_properties = null;
/** The default properties when method="text". */
private static Properties m_text_properties = null;
/** Synchronization object for lazy initialization of the above tables. */
private static Integer m_synch_object = new Integer(1);
}
