org.apache.xalan.templates

Class ElemSort

public class ElemSort extends ElemTemplateElement

Implement xsl:sort.
 
 
 
 

See Also: sorting in XSLT Specification

UNKNOWN: advanced

Method Summary
NodeappendChild(Node newChild)
Add a child to the child list.
voidcompose(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.
AVTgetCaseOrder()
Get the "case-order" attribute. case-order has the value upper-first or lower-first; this applies when data-type="text", and specifies that upper-case letters should sort before lower-case letters or vice-versa respectively.
AVTgetDataType()
Get the "data-type" attribute.
AVTgetLang()
Get the "lang" attribute. lang specifies the language of the sort keys; it has the same range of values as xml:lang [XML]; if no lang value is specified, the language should be determined from the system environment.
StringgetNodeName()
Return the node name.
AVTgetOrder()
Get the "order" attribute. order specifies whether the strings should be sorted in ascending or descending order; ascending specifies ascending order; descending specifies descending order; the default is ascending.
XPathgetSelect()
Get the "select" attribute. xsl:sort has a select attribute whose value is an expression.
intgetXSLToken()
Get an int constant identifying the type of element.
voidsetCaseOrder(AVT v)
Set the "case-order" attribute. case-order has the value upper-first or lower-first; this applies when data-type="text", and specifies that upper-case letters should sort before lower-case letters or vice-versa respectively.
voidsetDataType(AVT v)
Set the "data-type" attribute.
voidsetLang(AVT v)
Set the "lang" attribute. lang specifies the language of the sort keys; it has the same range of values as xml:lang [XML]; if no lang value is specified, the language should be determined from the system environment.
voidsetOrder(AVT v)
Set the "order" attribute. order specifies whether the strings should be sorted in ascending or descending order; ascending specifies ascending order; descending specifies descending order; the default is ascending.
voidsetSelect(XPath v)
Set the "select" attribute. xsl:sort has a select attribute whose value is an expression.

Method Detail

appendChild

public Node appendChild(Node newChild)
Add a child to the child list.

Parameters: newChild Child to add to the child list

Returns: Child just added to the child list

Throws: DOMException

compose

public 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.

getCaseOrder

public AVT getCaseOrder()
Get the "case-order" attribute. case-order has the value upper-first or lower-first; this applies when data-type="text", and specifies that upper-case letters should sort before lower-case letters or vice-versa respectively. For example, if lang="en", then A a B b are sorted with case-order="upper-first" and a A b B are sorted with case-order="lower-first". The default value is language dependent.

Returns: The value of the "case-order" attribute

getDataType

public AVT getDataType()
Get the "data-type" attribute. data-type specifies the data type of the strings; the following values are allowed:

The default value is text.

NOTE: The XSL Working Group plans that future versions of XSLT will leverage XML Schemas to define further values for this attribute.

Returns: The value of the "data-type" attribute

getLang

public AVT getLang()
Get the "lang" attribute. lang specifies the language of the sort keys; it has the same range of values as xml:lang [XML]; if no lang value is specified, the language should be determined from the system environment.

Returns: The value of the "lang" attribute

getNodeName

public String getNodeName()
Return the node name.

Returns: The element's name

getOrder

public AVT getOrder()
Get the "order" attribute. order specifies whether the strings should be sorted in ascending or descending order; ascending specifies ascending order; descending specifies descending order; the default is ascending.

Returns: The value of the "order" attribute

getSelect

public XPath getSelect()
Get the "select" attribute. xsl:sort has a select attribute whose value is an expression. For each node to be processed, the expression is evaluated with that node as the current node and with the complete list of nodes being processed in unsorted order as the current node list. The resulting object is converted to a string as if by a call to the string function; this string is used as the sort key for that node. The default value of the select attribute is ., which will cause the string-value of the current node to be used as the sort key.

Returns: The value of the "select" attribute

getXSLToken

public int getXSLToken()
Get an int constant identifying the type of element.

Returns: The token ID of the element

See Also:

setCaseOrder

public void setCaseOrder(AVT v)
Set the "case-order" attribute. case-order has the value upper-first or lower-first; this applies when data-type="text", and specifies that upper-case letters should sort before lower-case letters or vice-versa respectively. For example, if lang="en", then A a B b are sorted with case-order="upper-first" and a A b B are sorted with case-order="lower-first". The default value is language dependent.

Serial:

Parameters: v The value to set for the "case-order" attribute

setDataType

public void setDataType(AVT v)
Set the "data-type" attribute. data-type specifies the data type of the strings; the following values are allowed:

The default value is text.

NOTE: The XSL Working Group plans that future versions of XSLT will leverage XML Schemas to define further values for this attribute.

Parameters: v Value to set for the "data-type" attribute

setLang

public void setLang(AVT v)
Set the "lang" attribute. lang specifies the language of the sort keys; it has the same range of values as xml:lang [XML]; if no lang value is specified, the language should be determined from the system environment.

Parameters: v The value to set for the "lang" attribute

setOrder

public void setOrder(AVT v)
Set the "order" attribute. order specifies whether the strings should be sorted in ascending or descending order; ascending specifies ascending order; descending specifies descending order; the default is ascending.

Parameters: v The value to set for the "order" attribute

setSelect

public void setSelect(XPath v)
Set the "select" attribute. xsl:sort has a select attribute whose value is an expression. For each node to be processed, the expression is evaluated with that node as the current node and with the complete list of nodes being processed in unsorted order as the current node list. The resulting object is converted to a string as if by a call to the string function; this string is used as the sort key for that node. The default value of the select attribute is ., which will cause the string-value of the current node to be used as the sort key.

Parameters: v Value to set for the "select" attribute

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