APIdia Launch Partner
Top Description Constructors Methods
com.sun.org.apache.xalan.internal.lib

public Class ExsltStrings

extends ExsltBase
Class Inheritance
Imports
java.util.StringTokenizer, com.sun.org.apache.xpath.internal.NodeSet, jdk.xml.internal.JdkXmlUtils, org.w3c.dom.Document, .Element, .Node, .NodeList, .Text

This class contains EXSLT strings extension functions. It is accessed by specifying a namespace URI as follows:
   xmlns:str="http://exslt.org/strings"
The documentation for each function has been copied from the relevant EXSLT Implementer page.
See Also
EXSLT

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public static String

Returns:

The string after alignment
align
(String
The target string
targetStr
,
String
The padding string
paddingStr
,
String
The type of alignment
type
)

The str:align function aligns a string within another string.

public static String
align(String targetStr, String paddingStr)

See above

public static String

Returns:

The concatenation of the string values of the nodes in that node set
concat
(NodeList
A node set
nl
)

The str:concat function takes a node set and returns the concatenation of the string values of the nodes in that node set.

public static String

Returns:

A padding string of the given length
padding
(double
The length of the padding string to be created
length
,
String
The string to be used as pattern
pattern
)

The str:padding function creates a padding string of a certain length.

public static String
padding(double length)

See above

public static NodeList

Returns:

A node set of split tokens
split
(String
The string to be split
str
,
String
The pattern
pattern
)

The str:split function splits up a string and returns a node set of token elements, each containing one token from the string.</token></token></token>

public static NodeList
split(String str)

See above

public static NodeList

Returns:

A node set of split token elements
tokenize
(String
The string to be tokenized
toTokenize
,
String
The delimiter string
delims
)

The str:tokenize function splits up a string and returns a node set of token elements, each containing one token from the string.</token></token></token></token></token></token>

public static NodeList
tokenize(String toTokenize)

See above

Inherited from com.sun.org.apache.xalan.internal.lib.ExsltBase:
toNumbertoString

Constructor Detail

ExsltStringsback to summary
public ExsltStrings()

Method Detail

alignback to summary
public static String align(String targetStr, String paddingStr, String type)

The str:align function aligns a string within another string.

The first argument gives the target string to be aligned. The second argument gives the padding string within which it is to be aligned.

If the target string is shorter than the padding string then a range of characters in the padding string are repaced with those in the target string. Which characters are replaced depends on the value of the third argument, which gives the type of alignment. It can be one of 'left', 'right' or 'center'. If no third argument is given or if it is not one of these values, then it defaults to left alignment.

With left alignment, the range of characters replaced by the target string begins with the first character in the padding string. With right alignment, the range of characters replaced by the target string ends with the last character in the padding string. With center alignment, the range of characters replaced by the target string is in the middle of the padding string, such that either the number of unreplaced characters on either side of the range is the same or there is one less on the left than there is on the right.

If the target string is longer than the padding string, then it is truncated to be the same length as the padding string and returned.

Parameters
targetStr:String

The target string

paddingStr:String

The padding string

type:String

The type of alignment

Returns:String

The string after alignment

alignback to summary
public static String align(String targetStr, String paddingStr)

See above

concatback to summary
public static String concat(NodeList nl)

The str:concat function takes a node set and returns the concatenation of the string values of the nodes in that node set. If the node set is empty, it returns an empty string.

Parameters
nl:NodeList

A node set

Returns:String

The concatenation of the string values of the nodes in that node set

paddingback to summary
public static String padding(double length, String pattern)

The str:padding function creates a padding string of a certain length. The first argument gives the length of the padding string to be created. The second argument gives a string to be used to create the padding. This string is repeated as many times as is necessary to create a string of the length specified by the first argument; if the string is more than a character long, it may have to be truncated to produce the required length. If no second argument is specified, it defaults to a space (' '). If the second argument is an empty string, str:padding returns an empty string.

Parameters
length:double

The length of the padding string to be created

pattern:String

The string to be used as pattern

Returns:String

A padding string of the given length

paddingback to summary
public static String padding(double length)

See above

splitback to summary
public static NodeList split(String str, String pattern)

The str:split function splits up a string and returns a node set of token elements, each containing one token from the string.

The first argument is the string to be split. The second argument is a pattern string. The string given by the first argument is split at any occurrence of this pattern. For example:

str:split('a, simple, list', ', ') gives the node set consisting of:

a
simple
list
If the second argument is omitted, the default is the string ' ' (i.e. a space).
Parameters
str:String

The string to be split

pattern:String

The pattern

Returns:NodeList

A node set of split tokens

splitback to summary
public static NodeList split(String str)

See above

tokenizeback to summary
public static NodeList tokenize(String toTokenize, String delims)

The str:tokenize function splits up a string and returns a node set of token elements, each containing one token from the string.

The first argument is the string to be tokenized. The second argument is a string consisting of a number of characters. Each character in this string is taken as a delimiting character. The string given by the first argument is split at any occurrence of any of these characters. For example:

str:tokenize('2001-06-03T11:40:23', '-T:') gives the node set consisting of:

2001
06
03
11
40
23
If the second argument is omitted, the default is the string ' ' (i.e. whitespace characters).

If the second argument is an empty string, the function returns a set of token elements, each of which holds a single character.

Note

This one is different from the tokenize extension function in the Xalan namespace. The one in Xalan returns a set of Text nodes, while this one wraps the Text nodes inside the token Element nodes.

Parameters
toTokenize:String

The string to be tokenized

delims:String

The delimiter string

Returns:NodeList

A node set of split token elements

tokenizeback to summary
public static NodeList tokenize(String toTokenize)

See above