org.apache.xalan.templates

Class Stylesheet

public class Stylesheet extends ElemTemplateElement implements Serializable

Represents a stylesheet element.

All properties in this class have a fixed form of bean-style property accessors for all properties that represent XSL attributes or elements. These properties have setter method names accessed generically by the processor, and so these names must be fixed according to the system defined in the getSetterMethodName function.

 

 

 
 

 
 

 

See Also: section-Stylesheet-Structure in XSLT Specification

Field Summary
static StringSTYLESHEET_EXT
Extension to be used when serializing to disk.
Constructor Summary
Stylesheet(Stylesheet parent)
Constructor for a Stylesheet.
Method Summary
booleancontainsExcludeResultPrefix(String prefix, String uri)
Get whether or not the passed prefix is contained flagged by the "exclude-result-prefixes" property.
booleancontainsExtensionElementURI(String uri)
Find out if this contains a given "extension-element-prefix" property.
ElemAttributeSetgetAttributeSet(int i)
Get an "xsl:attribute-set" property.
intgetAttributeSetCount()
Get the number of "xsl:attribute-set" properties.
booleangetCompatibleMode()
Get whether or not the stylesheet is in "Forward Compatibility Mode"
DecimalFormatPropertiesgetDecimalFormat(QName name)
Get an "xsl:decimal-format" property.
DecimalFormatPropertiesgetDecimalFormat(int i)
Get an "xsl:decimal-format" property.
intgetDecimalFormatCount()
Get the number of xsl:decimal-format declarations.
StringgetExcludeResultPrefix(int i)
Get an "exclude-result-prefix" property.
intgetExcludeResultPrefixCount()
Get the number of "exclude-result-prefixes" Strings.
StringgetExtensionElementPrefix(int i)
Get and "extension-element-prefix" property.
intgetExtensionElementPrefixCount()
Get the number of "extension-element-prefixes" Strings.
StringgetHref()
Get the base identifier with which this stylesheet is associated.
StringgetId()
Get the "id" property.
StylesheetComposedgetImport(int i)
Get a stylesheet from the "import" list.
intgetImportCount()
Get the number of imported stylesheets.
StylesheetgetInclude(int i)
Get the stylesheet at the given in index in "include" list
intgetIncludeCount()
Get the number of included stylesheets.
KeyDeclarationgetKey(int i)
Get an "xsl:key" property.
intgetKeyCount()
Get the number of "xsl:key" properties.
NamespaceAliasgetNamespaceAlias(int i)
Get an "xsl:namespace-alias" property.
intgetNamespaceAliasCount()
Get the number of "xsl:namespace-alias" properties.
StringgetNodeName()
Return the node name.
shortgetNodeType()
Get the type of the node.
ObjectgetNonXslTopLevel(QName name)
Get a non-xslt element.
OutputPropertiesgetOutput(int i)
Get an "xsl:output" property.
intgetOutputCount()
Get the number of "xsl:output" properties.
ElemParamgetParam(QName qname)
Get an "xsl:param" property.
WhiteSpaceInfogetPreserveSpace(int i)
Get a "xsl:preserve-space" property.
intgetPreserveSpaceCount()
Get the number of "xsl:preserve-space" properties.
WhiteSpaceInfogetStripSpace(int i)
Get an "xsl:strip-space" property.
intgetStripSpaceCount()
Get the number of "xsl:strip-space" properties.
StylesheetgetStylesheet()
Get the owning stylesheet.
StylesheetComposedgetStylesheetComposed()
Get the owning aggregated stylesheet, or this stylesheet if it is aggregated.
StylesheetgetStylesheetParent()
Get the parent of the stylesheet.
StylesheetRootgetStylesheetRoot()
Get the root of the stylesheet, where all the tables common to all stylesheets are kept.
ElemTemplategetTemplate(int i)
Get an "xsl:template" property.
intgetTemplateCount()
Get the number of "xsl:template" properties.
ElemVariablegetVariable(QName qname)
Get an "xsl:variable" property.
ElemVariablegetVariableOrParam(QName qname)
Get an "xsl:variable" or "xsl:param" property.
ElemVariablegetVariableOrParam(int i)
Get an "xsl:variable" property.
intgetVariableOrParamCount()
Get the number of "xsl:variable" properties.
StringgetVersion()
Get the "version" property.
StringgetXmlnsXsl()
Get the "xmlns:xsl" property.
intgetXSLToken()
Get an integer representation of the element type.
booleanisAggregatedType()
Tell if this can be cast to a StylesheetComposed, meaning, you can ask questions from getXXXComposed functions.
booleanisRoot()
Tell if this is the root of the stylesheet tree.
voidreplaceTemplate(ElemTemplate v, int i)
Replace an "xsl:template" property.
voidsetAttributeSet(ElemAttributeSet attrSet)
Set the "xsl:attribute-set" property.
voidsetDecimalFormat(DecimalFormatProperties edf)
Process the xsl:decimal-format element.
voidsetExcludeResultPrefixes(StringVector v)
Set the "exclude-result-prefixes" property.
voidsetExtensionElementPrefixes(StringVector v)
Set the "extension-element-prefixes" property.
voidsetHref(String baseIdent)
Set the base identifier with which this stylesheet is associated.
voidsetId(String v)
Set the "id" property.
voidsetImport(StylesheetComposed v)
Add a stylesheet to the "import" list.
voidsetInclude(Stylesheet v)
Add a stylesheet to the "include" list.
voidsetKey(KeyDeclaration v)
Set the "xsl:key" property.
voidsetLocaterInfo(SourceLocator locator)
Set the location information for this element.
voidsetNamespaceAlias(NamespaceAlias na)
Set the "xsl:namespace-alias" property.
voidsetNonXslTopLevel(QName name, Object obj)
Set found a non-xslt element.
voidsetOutput(OutputProperties v)
Set the "xsl:output" property.
voidsetParam(ElemParam v)
Set an "xsl:param" property.
voidsetPreserveSpaces(WhiteSpaceInfo wsi)
Set the "xsl:preserve-space" property.
voidsetStripSpaces(WhiteSpaceInfo wsi)
Set the "xsl:strip-space" properties.
voidsetStylesheetParent(Stylesheet v)
Set the parent of the stylesheet.
voidsetStylesheetRoot(StylesheetRoot v)
Set the root of the stylesheet, where all the tables common to all stylesheets are kept.
voidsetTemplate(ElemTemplate v)
Set an "xsl:template" property.
voidsetVariable(ElemVariable v)
Set the "xsl:variable" property.
voidsetVersion(String v)
Set the "version" property.
voidsetXmlnsXsl(String v)
Set the "xmlns:xsl" property.

Field Detail

STYLESHEET_EXT

public static final String STYLESHEET_EXT
Extension to be used when serializing to disk.

Constructor Detail

Stylesheet

public Stylesheet(Stylesheet parent)
Constructor for a Stylesheet.

Parameters: parent The including or importing stylesheet.

Method Detail

containsExcludeResultPrefix

public boolean containsExcludeResultPrefix(String prefix, String uri)
Get whether or not the passed prefix is contained flagged by the "exclude-result-prefixes" property.

Parameters: prefix non-null reference to prefix that might be excluded. uri reference to namespace that prefix maps to

Returns: true if the prefix should normally be excluded.>

See Also: literal-result-element in XSLT Specification

containsExtensionElementURI

public boolean containsExtensionElementURI(String uri)
Find out if this contains a given "extension-element-prefix" property.

Parameters: uri URI of extension element to look for

Returns: True if the given URI was found in the list

See Also: extension-element in XSLT Specification

getAttributeSet

public ElemAttributeSet getAttributeSet(int i)
Get an "xsl:attribute-set" property.

Parameters: i Index of ElemAttributeSet to get in list

Returns: ElemAttributeSet at the given index

Throws: ArrayIndexOutOfBoundsException

See Also: attribute-sets in XSLT Specification

getAttributeSetCount

public int getAttributeSetCount()
Get the number of "xsl:attribute-set" properties.

Returns: the number of "xsl:attribute-set" properties.

See Also: attribute-sets in XSLT Specification

getCompatibleMode

public boolean getCompatibleMode()
Get whether or not the stylesheet is in "Forward Compatibility Mode"

Returns: true if in forward compatible mode, false otherwise

getDecimalFormat

public DecimalFormatProperties getDecimalFormat(QName name)
Get an "xsl:decimal-format" property.

Parameters: name The qualified name of the decimal format property.

Returns: null if not found, otherwise a DecimalFormatProperties object, from which you can get a DecimalFormatSymbols object.

See Also: DecimalFormatProperties format-number in XSLT Specification

getDecimalFormat

public DecimalFormatProperties getDecimalFormat(int i)
Get an "xsl:decimal-format" property.

Parameters: i Index of decimal-format property in stack

Returns: The decimal-format property at the given index

Throws: ArrayIndexOutOfBoundsException

See Also: format-number in XSLT Specification

getDecimalFormatCount

public int getDecimalFormatCount()
Get the number of xsl:decimal-format declarations.

Returns: the number of xsl:decimal-format declarations.

See Also:

getExcludeResultPrefix

public String getExcludeResultPrefix(int i)
Get an "exclude-result-prefix" property. The designation of a namespace as an excluded namespace is effective within the subtree of the stylesheet rooted at the element bearing the exclude-result-prefixes or xsl:exclude-result-prefixes attribute; a subtree rooted at an xsl:stylesheet element does not include any stylesheets imported or included by children of that xsl:stylesheet element.

Parameters: i Index of prefix to get in list

Returns: Prefix to be excluded at the given index

Throws: ArrayIndexOutOfBoundsException

See Also: literal-result-element in XSLT Specification

getExcludeResultPrefixCount

public int getExcludeResultPrefixCount()
Get the number of "exclude-result-prefixes" Strings.

Returns: The number of prefix strings to be excluded.

See Also: literal-result-element in XSLT Specification

getExtensionElementPrefix

public String getExtensionElementPrefix(int i)
Get and "extension-element-prefix" property.

Parameters: i Index of extension element URI in list

Returns: The extension element URI at the given index

Throws: ArrayIndexOutOfBoundsException

See Also: extension-element in XSLT Specification

getExtensionElementPrefixCount

public int getExtensionElementPrefixCount()
Get the number of "extension-element-prefixes" Strings.

Returns: Number of URIs in the list

See Also: extension-element in XSLT Specification

getHref

public String getHref()
Get the base identifier with which this stylesheet is associated.

Returns: the base identifier with which this stylesheet is associated.

getId

public String getId()
Get the "id" property.

Returns: The value of the "id" property.

See Also: section-Embedding-Stylesheets in XSLT Specification

getImport

public StylesheetComposed getImport(int i)
Get a stylesheet from the "import" list.

Parameters: i Index of the stylesheet to get

Returns: The stylesheet at the given index

Throws: ArrayIndexOutOfBoundsException

See Also: import in XSLT Specification

getImportCount

public int getImportCount()
Get the number of imported stylesheets.

Returns: the number of imported stylesheets.

See Also: import in XSLT Specification

getInclude

public Stylesheet getInclude(int i)
Get the stylesheet at the given in index in "include" list

Parameters: i Index of stylesheet to get

Returns: Stylesheet at the given index

Throws: ArrayIndexOutOfBoundsException

See Also: include in XSLT Specification

getIncludeCount

public int getIncludeCount()
Get the number of included stylesheets.

Returns: the number of included stylesheets.

See Also: import in XSLT Specification

getKey

public KeyDeclaration getKey(int i)
Get an "xsl:key" property.

Parameters: i Index of KeyDeclaration element to get

Returns: KeyDeclaration element at given index in list

Throws: ArrayIndexOutOfBoundsException

See Also: key in XSLT Specification

getKeyCount

public int getKeyCount()
Get the number of "xsl:key" properties.

Returns: the number of "xsl:key" properties.

See Also: key in XSLT Specification

getNamespaceAlias

public NamespaceAlias getNamespaceAlias(int i)
Get an "xsl:namespace-alias" property.

Parameters: i Index of NamespaceAlias element to get from the list

Returns: NamespaceAlias element at the given index in the list

Throws: ArrayIndexOutOfBoundsException

See Also: literal-result-element in XSLT Specification

getNamespaceAliasCount

public int getNamespaceAliasCount()
Get the number of "xsl:namespace-alias" properties.

Returns: the number of "xsl:namespace-alias" properties.

See Also: top-level-variables in XSLT Specification

getNodeName

public String getNodeName()
Return the node name.

Returns: The node name

getNodeType

public short getNodeType()
Get the type of the node. We'll pretend we're a Document.

Returns: the type of the node: document node.

getNonXslTopLevel

public Object getNonXslTopLevel(QName name)
Get a non-xslt element.

Parameters: name Qualified name of the element to get

Returns: The object associate with the given name

See Also: stylesheet-element in XSLT Specification

getOutput

public OutputProperties getOutput(int i)
Get an "xsl:output" property.

Parameters: i Index of OutputFormatExtended to get

Returns: non-null reference to an OutputProperties object.

Throws: ArrayIndexOutOfBoundsException

See Also: output in XSLT Specification

getOutputCount

public int getOutputCount()
Get the number of "xsl:output" properties.

Returns: The number of OutputProperties objects contained in this stylesheet.

See Also: output in XSLT Specification

getParam

public ElemParam getParam(QName qname)
Get an "xsl:param" property.

Parameters: qname non-null reference to qualified name of the parameter.

Returns: ElemParam with the given name in the list or null

See Also: top-level-variables in XSLT Specification

getPreserveSpace

public WhiteSpaceInfo getPreserveSpace(int i)
Get a "xsl:preserve-space" property.

Parameters: i Index of WhiteSpaceInfo to get

Returns: WhiteSpaceInfo at the given index

Throws: ArrayIndexOutOfBoundsException

See Also: strip in XSLT Specification

getPreserveSpaceCount

public int getPreserveSpaceCount()
Get the number of "xsl:preserve-space" properties.

Returns: the number of "xsl:preserve-space" properties.

See Also: strip in XSLT Specification

getStripSpace

public WhiteSpaceInfo getStripSpace(int i)
Get an "xsl:strip-space" property.

Parameters: i Index of WhiteSpaceInfo to get

Returns: WhiteSpaceInfo at given index

Throws: ArrayIndexOutOfBoundsException

See Also: strip in XSLT Specification

getStripSpaceCount

public int getStripSpaceCount()
Get the number of "xsl:strip-space" properties.

Returns: the number of "xsl:strip-space" properties.

See Also: strip in XSLT Specification

getStylesheet

public Stylesheet getStylesheet()
Get the owning stylesheet. This looks up the inheritance chain until it calls getStylesheet on a Stylesheet object, which will return itself.

Returns: The owning stylesheet, itself.

getStylesheetComposed

public StylesheetComposed getStylesheetComposed()
Get the owning aggregated stylesheet, or this stylesheet if it is aggregated.

Returns: the owning aggregated stylesheet or itself

getStylesheetParent

public Stylesheet getStylesheetParent()
Get the parent of the stylesheet. This will be null if this is the root stylesheet.

Returns: the parent of the stylesheet.

getStylesheetRoot

public StylesheetRoot getStylesheetRoot()
Get the root of the stylesheet, where all the tables common to all stylesheets are kept.

Returns: the root of the stylesheet

getTemplate

public ElemTemplate getTemplate(int i)
Get an "xsl:template" property.

Parameters: i Index of ElemTemplate in the list to get

Returns: ElemTemplate at the given index in the list

Throws: TransformerException

See Also: section-Defining-Template-Rules in XSLT Specification

getTemplateCount

public int getTemplateCount()
Get the number of "xsl:template" properties.

Returns: the number of "xsl:template" properties.

See Also: section-Defining-Template-Rules in XSLT Specification

getVariable

public ElemVariable getVariable(QName qname)
Get an "xsl:variable" property.

Parameters: qname Qualified name of the xsl:variable to get

Returns: reference to the variable named by qname, or null if not found.

See Also: top-level-variables in XSLT Specification

getVariableOrParam

public ElemVariable getVariableOrParam(QName qname)
Get an "xsl:variable" or "xsl:param" property.

Parameters: qname non-null reference to the qualified name of the variable.

Returns: The ElemVariable with the given name in the list or null

See Also: top-level-variables in XSLT Specification

getVariableOrParam

public ElemVariable getVariableOrParam(int i)
Get an "xsl:variable" property.

Parameters: i Index of variable to get in the list

Returns: ElemVariable at the given index in the list

Throws: ArrayIndexOutOfBoundsException

See Also: top-level-variables in XSLT Specification

getVariableOrParamCount

public int getVariableOrParamCount()
Get the number of "xsl:variable" properties.

Returns: the number of "xsl:variable" properties.

See Also: top-level-variables in XSLT Specification

getVersion

public String getVersion()
Get the "version" property.

Returns: The value of the "version" property.

See Also: forwards in XSLT Specification

getXmlnsXsl

public String getXmlnsXsl()
Get the "xmlns:xsl" property.

Returns: The value of the "xmlns:xsl" property.

See Also: xslt-namespace in XSLT Specification

getXSLToken

public int getXSLToken()
Get an integer representation of the element type.

Returns: An integer representation of the element, defined in the Constants class.

See Also: Constants

isAggregatedType

public boolean isAggregatedType()
Tell if this can be cast to a StylesheetComposed, meaning, you can ask questions from getXXXComposed functions.

Returns: False if this is not a StylesheetComposed

isRoot

public boolean isRoot()
Tell if this is the root of the stylesheet tree.

Returns: False is this is not the root of the stylesheet tree.

replaceTemplate

public void replaceTemplate(ElemTemplate v, int i)
Replace an "xsl:template" property. This is a hook for CompilingStylesheetHandler, to allow us to access a template, compile it, instantiate it, and replace the original with the compiled instance. ADDED 9/5/2000 to support compilation experiment

Parameters: v Compiled template to replace with i Index of template to be replaced

Throws: TransformerException

setAttributeSet

public void setAttributeSet(ElemAttributeSet attrSet)
Set the "xsl:attribute-set" property.

Parameters: attrSet ElemAttributeSet to add to the list of attribute sets

See Also: attribute-sets in XSLT Specification

setDecimalFormat

public void setDecimalFormat(DecimalFormatProperties edf)
Process the xsl:decimal-format element.

Parameters: edf Decimal-format element to push into stack

setExcludeResultPrefixes

public void setExcludeResultPrefixes(StringVector v)
Set the "exclude-result-prefixes" property. The designation of a namespace as an excluded namespace is effective within the subtree of the stylesheet rooted at the element bearing the exclude-result-prefixes or xsl:exclude-result-prefixes attribute; a subtree rooted at an xsl:stylesheet element does not include any stylesheets imported or included by children of that xsl:stylesheet element.

Parameters: v A StringVector of prefixes to exclude

See Also: literal-result-element in XSLT Specification

setExtensionElementPrefixes

public void setExtensionElementPrefixes(StringVector v)
Set the "extension-element-prefixes" property.

Parameters: v The value to be set for the "extension-element-prefixes" property: a vector of extension element URIs.

See Also: extension-element in XSLT Specification

setHref

public void setHref(String baseIdent)
Set the base identifier with which this stylesheet is associated.

Parameters: baseIdent the base identifier with which this stylesheet is associated.

setId

public void setId(String v)
Set the "id" property.

Parameters: v Value for the "id" property.

See Also: section-Embedding-Stylesheets in XSLT Specification

setImport

public void setImport(StylesheetComposed v)
Add a stylesheet to the "import" list.

Parameters: v Stylesheet to add to the import list

See Also: import in XSLT Specification

setInclude

public void setInclude(Stylesheet v)
Add a stylesheet to the "include" list.

Parameters: v Stylesheet to add to the "include" list

See Also: include in XSLT Specification

setKey

public void setKey(KeyDeclaration v)
Set the "xsl:key" property.

Parameters: v KeyDeclaration element to add to the list of key declarations

See Also: key in XSLT Specification

setLocaterInfo

public void setLocaterInfo(SourceLocator locator)
Set the location information for this element.

Parameters: locator SourceLocator object with location information

setNamespaceAlias

public void setNamespaceAlias(NamespaceAlias na)
Set the "xsl:namespace-alias" property.

Parameters: na NamespaceAlias elemeent to add to the list

See Also: literal-result-element in XSLT Specification

setNonXslTopLevel

public void setNonXslTopLevel(QName name, Object obj)
Set found a non-xslt element.

Parameters: name Qualified name of the element obj The element object

See Also: stylesheet-element in XSLT Specification

setOutput

public void setOutput(OutputProperties v)
Set the "xsl:output" property.

Parameters: v non-null reference to the OutputProperties object to be added to the collection.

See Also: output in XSLT Specification

setParam

public void setParam(ElemParam v)
Set an "xsl:param" property.

Parameters: v A non-null ElemParam reference.

See Also: top-level-variables in XSLT Specification

setPreserveSpaces

public void setPreserveSpaces(WhiteSpaceInfo wsi)
Set the "xsl:preserve-space" property.

Parameters: wsi WhiteSpaceInfo element to add to list

See Also: strip in XSLT Specification

setStripSpaces

public void setStripSpaces(WhiteSpaceInfo wsi)
Set the "xsl:strip-space" properties.

Parameters: wsi WhiteSpaceInfo element to add to list

See Also: strip in XSLT Specification

setStylesheetParent

public void setStylesheetParent(Stylesheet v)
Set the parent of the stylesheet. This should be null if this is the root stylesheet.

Parameters: v the parent of the stylesheet.

setStylesheetRoot

public void setStylesheetRoot(StylesheetRoot v)
Set the root of the stylesheet, where all the tables common to all stylesheets are kept.

Parameters: v the root of the stylesheet

setTemplate

public void setTemplate(ElemTemplate v)
Set an "xsl:template" property.

Parameters: v ElemTemplate to add to list of templates

See Also: section-Defining-Template-Rules in XSLT Specification

setVariable

public void setVariable(ElemVariable v)
Set the "xsl:variable" property.

Parameters: v ElemVariable object to add to list of top level variables

See Also: top-level-variables in XSLT Specification

setVersion

public void setVersion(String v)
Set the "version" property.

Parameters: v Value for the "version" property.

See Also: forwards in XSLT Specification

setXmlnsXsl

public void setXmlnsXsl(String v)
Set the "xmlns:xsl" property.

Parameters: v The value to be set for the "xmlns:xsl" property.

See Also: xslt-namespace in XSLT Specification

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