org.apache.xalan.templates

Class OutputProperties

Implemented Interfaces:
Cloneable, Document, Element, ExpressionNode, Node, NodeList, PrefixResolver, Serializable, SourceLocator, WhitespaceStrippingElementMatcher, XSLTVisitable

public class OutputProperties
extends ElemTemplateElement
implements Cloneable

This class provides information from xsl:output elements. It is mainly a wrapper for java.util.Properties, but can not extend that class because it must be part of the ElemTemplateElement heararchy.

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.

See Also:
XSLT DTD, xsl:output in XSLT Specification

Nested Class Summary

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

OutputProperties()
Creates an empty OutputProperties with no default values.
OutputProperties(Properties defaults)
Creates an empty OutputProperties with the specified defaults.
OutputProperties(String method)
Creates an empty OutputProperties with the defaults specified by a property file.

Method Summary

Object
clone()
Clone this OutputProperties, including a clone of the wrapped Properties reference.
void
compose(StylesheetRoot sroot)
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.
void
copyFrom(Properties src)
Copy the keys and values from the source to this object.
void
copyFrom(Properties src, boolean shouldResetDefaults)
Copy the keys and values from the source to this object.
void
copyFrom(OutputProperties opsrc)
Copy the keys and values from the source to this object.
boolean
getBooleanProperty(String key)
Searches for the boolean property with the specified key in the property list.
boolean
getBooleanProperty(QName key)
Searches for the boolean property with the specified key in the property list.
static Properties
getDefaultMethodProperties(String method)
Deprecated. Use org.apache.xml.serializer.OuputPropertiesFactory. getDefaultMethodProperties directly.
int
getIntProperty(String key)
Searches for the int property with the specified key in the property list.
int
getIntProperty(QName key)
Searches for the int property with the specified key in the property list.
Properties
getProperties()
Get the Properties object that this class wraps.
String
getProperty(String key)
Searches for the property with the specified key in the property list.
String
getProperty(QName key)
Searches for the property with the specified key in the property list.
Vector
getQNameProperties(String key)
Searches for the list of qname properties with the specified key in the property list.
static Vector
getQNameProperties(String key, Properties props)
Searches for the list of qname properties with the specified key in the property list.
Vector
getQNameProperties(QName key)
Searches for the list of qname properties with the specified key in the property list.
QName
getQNameProperty(String key)
Searches for the qname property with the specified key in the property list.
static QName
getQNameProperty(String key, Properties props)
Searches for the qname property with the specified key in the property list.
QName
getQNameProperty(QName key)
Searches for the qname property with the specified key in the property list.
static boolean
isLegalPropertyKey(String key)
Report if the key given as an argument is a legal xsl:output key.
void
recompose(StylesheetRoot root)
This function is called to recompose all of the output format extended elements.
void
setBooleanProperty(String key, boolean value)
Set an output property.
void
setBooleanProperty(QName key, boolean value)
Set an output property.
void
setIntProperty(String key, int value)
Set an output property.
void
setIntProperty(QName key, int value)
Set an output property.
void
setMethodDefaults(String method)
Reset the default properties based on the method.
void
setProperty(String key, String value)
Set an output property.
void
setProperty(QName key, String value)
Set an output property.
void
setQNameProperties(String key, Vector v)
Set an output property with a QName list value.
void
setQNameProperties(QName key, Vector v)
Set an output property with a QName list value.
void
setQNameProperty(String key, QName value)
Set an output property with a QName value.
void
setQNameProperty(QName key, QName value)
Set an output property with a QName value.

Methods inherited from class org.apache.xalan.templates.ElemTemplateElement

appendChild, appendChild, callVisitors, canAcceptVariables, canStripWhiteSpace, compareTo, compose, containsExcludeResultPrefix, endCompose, error, error, execute, exprAddChild, exprGetChild, exprGetNumChildren, exprGetParent, exprSetParent, getBaseIdentifier, getChildNodes, getColumnNumber, getDOMBackPointer, getDeclaredPrefixes, getEndColumnNumber, getEndLineNumber, getFirstChild, getFirstChildElem, getLastChild, getLastChildElem, getLength, getLineNumber, getLocalName, getNamespaceForPrefix, getNamespaceForPrefix, getNextSibling, getNextSiblingElem, getNodeName, getNodeType, getOwnerDocument, getOwnerXSLTemplate, getParentElem, getParentNode, getParentNodeElem, getPrefixes, getPreviousSibling, getPreviousSiblingElem, getPublicId, getStylesheet, getStylesheetComposed, getStylesheetRoot, getSystemId, getTagName, getUid, getXSLToken, getXmlSpace, handlesNullPrefixes, hasChildNodes, hasTextLitOnly, hasVariableDecl, insertBefore, isCompiledTemplate, item, recompose, removeChild, replaceChild, replaceChild, resolvePrefixTables, runtimeInit, setDOMBackPointer, setEndLocaterInfo, setLocaterInfo, setParentElem, setPrefixes, setPrefixes, setUid, setXmlSpace, shouldStripWhiteSpace

Methods inherited from class org.apache.xml.utils.UnImplNode

adoptNode, appendChild, appendData, cloneNode, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, deleteData, error, error, getAttribute, getAttributeNS, getAttributeNode, getAttributeNodeNS, getAttributes, getChildNodes, getDoctype, getDocumentElement, getElementById, getElementsByTagName, getElementsByTagNameNS, getEncoding, getFirstChild, getImplementation, getLastChild, getLength, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getOwnerElement, getParentNode, getPrefix, getPreviousSibling, getSpecified, getStandalone, getStrictErrorChecking, getTagName, getVersion, hasAttribute, hasAttributeNS, hasAttributes, hasChildNodes, importNode, insertBefore, insertData, isSupported, item, normalize, removeAttribute, removeAttributeNS, removeAttributeNode, removeChild, replaceChild, replaceData, setAttribute, setAttributeNS, setAttributeNode, setAttributeNodeNS, setData, setEncoding, setNodeValue, setPrefix, setStandalone, setStrictErrorChecking, setValue, setVersion, splitText, substringData

Constructor Details

OutputProperties

public OutputProperties()
Creates an empty OutputProperties with no default values.


OutputProperties

public OutputProperties(Properties defaults)
Creates an empty OutputProperties with the specified defaults.

Parameters:
defaults - the defaults.


OutputProperties

public OutputProperties(String 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.

At the moment, anything other than 'text', 'xml', and 'html', will use the output_xml.properties file.

Parameters:
method - non-null reference to method name.

Method Details

clone

public Object clone()
Clone this OutputProperties, including a clone of the wrapped Properties reference.

Returns:
A new OutputProperties reference, mutation of which should not effect this object.


compose

public void compose(StylesheetRoot sroot)
            throws TransformerException
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.
Overrides:
compose in interface ElemTemplateElement


copyFrom

public void copyFrom(Properties src)
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.

Parameters:
src - non-null reference to the source properties.


copyFrom

public void copyFrom(Properties src,
                     boolean shouldResetDefaults)
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.

Parameters:
src - non-null reference to the source properties.
shouldResetDefaults - true if the defaults should be reset based on the method property.


copyFrom

public void copyFrom(OutputProperties opsrc)
            throws TransformerException
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.

Parameters:
opsrc - non-null reference to an OutputProperties.


getBooleanProperty

public boolean getBooleanProperty(String key)
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 false if the property is not found, or if the value is other than "yes".

Parameters:
key - the property key.

Returns:
the value in this property list as a boolean value, or false if null or not "yes".


getBooleanProperty

public boolean getBooleanProperty(QName key)
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 false if the property is not found, or if the value is other than "yes".

Parameters:
key - the property key.

Returns:
the value in this property list as a boolean value, or false if null or not "yes".


getDefaultMethodProperties

public static Properties getDefaultMethodProperties(String method)

Deprecated. Use org.apache.xml.serializer.OuputPropertiesFactory. getDefaultMethodProperties directly.

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.

At the moment, anything other than 'text', 'xml', and 'html', will use the output_xml.properties file.

Parameters:
method - non-null reference to method name.

Returns:
Properties object that holds the defaults for the given method.


getIntProperty

public int getIntProperty(String key)
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 false if the property is not found, or if the value is other than "yes".

Parameters:
key - the property key.

Returns:
the value in this property list as a int value, or false if null or not a number.


getIntProperty

public int getIntProperty(QName key)
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 false if the property is not found, or if the value is other than "yes".

Parameters:
key - the property key.

Returns:
the value in this property list as a int value, or false if null or not a number.


getProperties

public Properties getProperties()
Get the Properties object that this class wraps.

Returns:
non-null reference to Properties object.


getProperty

public String getProperty(String key)
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 null if the property is not found.

Parameters:
key - the property key.

Returns:
the value in this property list with the specified key value.


getProperty

public String getProperty(QName key)
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 null if the property is not found.

Parameters:
key - the property key.

Returns:
the value in this property list with the specified key value.


getQNameProperties

public Vector getQNameProperties(String key)
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 null if the property is not found.

Parameters:
key - the property key.

Returns:
the value in this property list as a vector of QNames, or false if null or not "yes".


getQNameProperties

public static Vector getQNameProperties(String key,
                                        Properties props)
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 null if the property is not found.

Parameters:
key - the property key.
props - the list of properties to search in.

Returns:
the value in this property list as a vector of QNames, or false if null or not "yes".


getQNameProperties

public Vector getQNameProperties(QName key)
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 null if the property is not found.

Parameters:
key - the property key.

Returns:
the value in this property list as a vector of QNames, or false if null or not "yes".


getQNameProperty

public QName getQNameProperty(String key)
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 null if the property is not found.

Parameters:
key - the property key.

Returns:
the value in this property list as a QName value, or false if null or not "yes".


getQNameProperty

public static QName getQNameProperty(String key,
                                     Properties props)
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 null if the property is not found.

Parameters:
key - the property key.
props - the list of properties to search in.

Returns:
the value in this property list as a QName value, or false if null or not "yes".


getQNameProperty

public QName getQNameProperty(QName key)
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 null if the property is not found.

Parameters:
key - the property key.

Returns:
the value in this property list as a QName value, or false if null or not "yes".


isLegalPropertyKey

public static boolean isLegalPropertyKey(String key)
Report if the key given as an argument is a legal xsl:output key.

Parameters:
key - non-null reference to key name.

Returns:
true if key is legal.


recompose

public void recompose(StylesheetRoot root)
            throws TransformerException
This function is called to recompose all of the output format extended elements.
Overrides:
recompose in interface ElemTemplateElement

Parameters:
root - non-null reference to the stylesheet root object.


setBooleanProperty

public void setBooleanProperty(String key,
                               boolean value)
Set an output property.

Parameters:
key - the key to be placed into the property list.
value - the value corresponding to key.

See Also:
OutputKeys


setBooleanProperty

public void setBooleanProperty(QName key,
                               boolean value)
Set an output property.

Parameters:
key - the key to be placed into the property list.
value - the value corresponding to key.

See Also:
OutputKeys


setIntProperty

public void setIntProperty(String key,
                           int value)
Set an output property.

Parameters:
key - the key to be placed into the property list.
value - the value corresponding to key.

See Also:
OutputKeys


setIntProperty

public void setIntProperty(QName key,
                           int value)
Set an output property.

Parameters:
key - the key to be placed into the property list.
value - the value corresponding to key.

See Also:
OutputKeys


setMethodDefaults

public void setMethodDefaults(String method)
Reset the default properties based on the method.

Parameters:
method - the method value.

See Also:
OutputKeys


setProperty

public void setProperty(String key,
                        String value)
Set an output property.

Parameters:
key - the key to be placed into the property list.
value - the value corresponding to key.

See Also:
OutputKeys


setProperty

public void setProperty(QName key,
                        String value)
Set an output property.

Parameters:
key - the key to be placed into the property list.
value - the value corresponding to key.

See Also:
OutputKeys


setQNameProperties

public void setQNameProperties(String key,
                               Vector v)
Set an output property with a QName list value. The QNames will be turned into strings with the namespace in curly brackets.

Parameters:
key - the key to be placed into the property list.
v - non-null list of QNames corresponding to key.

See Also:
OutputKeys


setQNameProperties

public void setQNameProperties(QName key,
                               Vector v)
Set an output property with a QName list value. The QNames will be turned into strings with the namespace in curly brackets.

Parameters:
key - the key to be placed into the property list.
v - non-null list of QNames corresponding to key.

See Also:
OutputKeys


setQNameProperty

public void setQNameProperty(String key,
                             QName value)
Set an output property with a QName value. The QName will be turned into a string with the namespace in curly brackets.

Parameters:
key - the key to be placed into the property list.
value - the value corresponding to key.

See Also:
OutputKeys


setQNameProperty

public void setQNameProperty(QName key,
                             QName value)
Set an output property with a QName value. The QName will be turned into a string with the namespace in curly brackets.

Parameters:
key - the key to be placed into the property list.
value - the value corresponding to key.

See Also:
OutputKeys


Copyright B) 2004 Apache XML Project. All Rights Reserved.