Object

Description Map of request header name to a String array of values Map of cookie name to a Cookie object Map of context initialization parameter name to a String parameter value (set in web.xml)

Operator ! (not)

Description True if operand is false; false, otherwise.

JSTL Quick Reference

Copyright 2003 Bill Siggelkow

headerValues cookie initParam

Other Operators
Operator empty Description True if the operand is null, an empty String, empty array, empty Map, or empty List; false, otherwise. Paranthesis for changing operator precedence.

Expressions (EL)
In Attribute Values <a:tag value="${expr}"/> <a:tag value="me${expr} ${expr}"/>

Arithmetic Operators
Operator + * / (div) % (mod) Addition Subtraction Multiplication Division Remainder (modulus) Description

()

bean.name bean["name"]

Bean Property Access

EL Functions (JSTL 1.1)

Note: All functions treat null Strings as empty Strings.

<%@ taglib prefix="fn" uri="http://java.sun.com/jstl/functions" %>

Indexed Property Access

bean.property[index]
Map Property Access bean.property["key"] Implicit Objects (maps)
Object pageContext pageScope requestScope sessionScope Description JSP Page Context object Page-scoped variables (valid only on a given JSP page) Request-scoped variables (valid for a given request) Session-scoped variables (valid for the user's session) given application context)

Usage: ${fn:function(arg0, ...)}

<p>We offer ${fn:length(flavorSet)} ice cream flavors.</p> Description

Relational Operators
Operator == (eq) != (ne) < (lt) > (gt) <= (le) >= (ge) <= (le) Equality Inequality Less than Greater than Less than or equal to Greater than or equal to Less than or equal to

Function fn:contains (string, substring) : boolean

Description Returns true if substring is contained in string; false, otherwise.

fn:containsIgnoreCase Returns true if substring is contained in string regardless of case; false, (string, substring) : otherwise. boolean fn:endsWith (string, suffix) : boolean fn:escapeXml Returns true if string ends with the specified suffix; false, otherwise.

applicationScope Application-scoped variables (valid for a

Logical Operators
Operator && (and) || (or) Description True if both operands are true; false, otherwise. True if either or both operands are true; false, otherwise.

(string) : String fn:indexOf (string, substring) : int

param paramValues header

Map of request parameter name to a String parameter value Map of request parameter name to a String array of parameter values Map of request header name to a header String value

Escapes characters (e.g changing < to &lt;) that could be interpreted as XML (including HTML) markup. Returns an integer representing the 0based index within string of the first occurrence of substring. If substring is empty, 0 is returned.

Function fn:join (string[], separator) : String

Description Joins all elements of the string array into a single string. Separator separates each element in the resulting string. If separator is an empty string, the elements are joined without a separator. If a collection or array is passed, the size of the collection or array is returned; If a string is passed, the number of characters in the string is returned.

<c:remove var="dogAge" scope="page"/>

Core Tag Library

Attribute <%@ taglib prefix="c" uri="http://java.sun.com/jstl/core" %> var scope Description Name of variable to delete Scope of variable Rqd Yes No Default None All scopes

fn:length (collection or string) : int

General-Purpose Actions Actions for rendering data, creating and modifying scoped variables, and catching exceptions. <c:out> - renders data to the page
<h2>Welcome, <c:out value="${user.name}" default="Guest"/></h2> Attribute value default escapeXml Description Data to output Fallback data to output if value is empty Rqd Yes No No Default None Body true

<c:catch> - traps all exceptions or errors from the enclosed body.

<c:catch var="err"> <c:import value="http://java.sun.com"/> </c:catch> <c:if test="${not empty err}"> Could not connect to Java web site. </c:if>

fn:replace

Replaces in inputString, every occurrence of beforeString with (inputString, afterString. An empty string is beforeSubstring, returned if either inputString or afterSubstring) : String beforeString is empty. If afterString is empty, all occurences of the beforeString are removed. fn:split (string, delimiters) : String[] fn:startsWith (string, prefix) : boolean fn:substring (string, beginIndex, endIndex) : String fn:substringAfter (string, substring) : String fn:substringBefore (string, substring) : String fn:toLowerCase (string) : String fn:toUpperCase (string) : String fn:trim (string) : String Splits string into a string array using the given set of delimiter characters. The delimiter characters are not included in any returned tokens. Returns true if string starts with the specified prefix; false, otherwise. Returns true if prefix is empty. Returns a subset of string using the zero-based indices inclusive of the begin index, but exclusive of the end index. Returns the subset of string following the given substring.

Attribute var

Description Name of variable to hold the thrown exception, if any. Variable will be of type java.lang.Throwable.

Rqd No

Default None

true

to escape special characters

Conditional Actions Actions for processing markup based on logical conditions. <c:if> - processes the body if test is true
<c:if test="${user.age ge 40}"> You are over the hill. </c:if> Attribute test Description Condition to evaluate Name of variable to store test condition's result Scope of variable Rqd Yes No No Default None None page

<c:set> - saves data to a scoped variable

<c:set var="dogAge" value="${age div 7}"/> You are <c:out value="${dogAge}"/> in dog years.

Attribute Returns the subset of string that procedes the given substring. value target Converts all characters of a string to lowercase. Converts all characters of a string to uppercase. Removes whitespace from both ends of a string. property var scope

Description Data to save Name of variable to modify Property of target to modify Name of variable to store data Scope of variable

Rqd No No No No No

Default Body None

var None None page scope

<c:remove> - deletes a scoped variable

<c:choose> - multiple conditions processes the body of the first enclosed when tag where the test condition is true. If none match then the body of the otherwise tag (if present) is processed.
<c:choose>

<c:when test="${a boolean expr}"> // do something </c:when> <c:when test="${another boolean expr}"> // do something else </c:when> <c:otherwise> // do this when nothing else is true </c:otherwise> </c:choose>

Attribute varStatus

Description Name of variable to hold the loop status with the following properties:

Rqd No

Default None

Attribute var

Description Name of variable to hold the current token. This variable has only nested visibility. String of tokens to loop over. Set of characters that separate the tokens (e.g. delims=,; will tokenize a string separated by commas or semi-colons).

Rqd No

Default None

index position of the current item count number of times through the loop (starting with 1) first boolean indicator if this is the first iteration last boolean indicator if this is the last iteration

items delims

Yes Yes

None None

The choose tag accepts no attributes and can only contain when tag(s) and an optional otherwise tag. <c:when> - processes the body if test is true and no other previous <c:when> tags evaluated to true.
Attribute test Description Condition to evaluate Rqd Yes Default None

<c:forEach> - repeats the nested body content over a collection or for a fixed number of times.
<c:forEach items="${user.languages}" var="lang" varStatus="status"> <c:if test="${status.first}"> You speak these languages:<br><ul> </c:if> <li><c:out value="${lang}"/></li> <c:if test="${status.last}"></ul></c:if> </c:forEach> Attribute var Description Name of variable to hold the current item. This variable has only nested visibility. Rqd No Default None

URL Related Actions Actions for importing content from URLs, building URLs, and redirecting. <c:import> - imports the content of a URL-based resource. Action may include nested <c:param> tags to specify the query string (unless the varReader attribute is specified).
<c:import url="includes/header.jsp"> <c:param name="title">Hello World</c:param> </c:import> Attribute url context Description URL of the resource to import. Name of the context (beginning with a /) of some other local web application to import the resource from. Name of the variable to hold the imported content as a String. Scope of the var variable Name of the variable to hold the imported content as a Reader. This variable has only nested visibility so that the reader will always be closed. Rqd Yes No Default None Current context

<c:otherwise> - processes the body if no other previous <c:when> condition matched. This tag accepts no attributes and, if present, must be the last tag in the <c:choose> body. Iterator Actions Actions that loop over collections, for a fixed number of times, or over a set of string tokens. These actions share the following attributes for iterating over a subset of elements.
Attribute begin end step Description Zero-based index of first item to process, inclusive. Zero-based index of last item to process, inclusive. Rqd No No Default 0

items Last item 1

Collection, iterator, map, or No array to loop over.

None var

No

None

Process every stepth element No (e.g 2 = every second element).

<c:forTokens> - repeats the nested body content for each token of a delimited string.
<c:set var="users">Fred,Joe,Mary<c:set> <c:forTokens var="name" items="${users}" delims=","> <c:out value="${name}"/><br/> </c:forTokens> Attribute Description Rqd Default

scope varReader

No No

page None

<c:url> - builds a URL with the proper rewriting rules applied (only relative URLs are rewritten). Action may include nested <c:param> tags to specify the query string.
<c:url="editProfile.do" var="profileLnk"> <c:param name="id" value="${user.id}"/> </c:url> <a href='<c:out value="${profileLnk}"/>'> Edit Profile </a> Attribute value context Description URL to be processed. Name of the context (beginning with a /) of some other local web application. Name of the variable to hold the URL as a String. Scope of the var variable Rqd Yes No Default None Current context None page

<c:redirect> - sends the client a response to redirect to the specified URL. This action will abort processing of the current page. Action may include nested <c:param> tags to specify the query string.
<c:if test="${empty user}"> <c:redirect url="login.do"/> </c:if>

Formatting Tag Library

<%@ taglib prefix="fmt" uri="http://java.sun.com/jstl/fmt" %>

Attribute url context

Description URL of the resource to redirect to. Name of the context (beginning with a /) of some other local web application.

Rqd Yes No

Default None Current context

Internationalization (I18N) Actions Actions that establish localization (l10n) contexts, specify resource bundles, and format messages. <fmt:setLocale> - Sets the default locale for the specified scope. This will override the browserbased locale.
<fmt:setLocale scope="session" value="fr_CA"> Attribute value Description String representation of a locale (e.g. en_US) or an actual java.util.Locale object. Rqd Yes Default None

var scope

No No

<c:param> - adds request parameters to a URL. This action can only be nested within <c:import>, <c:url>, or <c:redirect>.
Attribute name value Description Name of the query string parameter. Rqd Yes Default None Body

variant

Locale variant (as a String) to No specify in conjunction with the locale (language and country). Scope to set the default locale No for.

None

scope

page

Value of the parameter. If not No specified, value is taken from the tag body.

<fmt:bundle> - Sets the localization context, based on the specified resource bundle, to be used within the body content of this tag.
<fmt:bundle basename="resources" prefix="label."> <fmt:message key="userId"/> <fmt:bundle> Attribute Description Rqd Default None

basename Fully-qualified name of the Yes base bundle without a file type (such as .properties). prefix String prefix to be prepended No to the value of the message key. Note that the prefix must include all characters a separator character (e.g. .) is not assumed.

None

<fmt:setBundle> - Creates and stores in a scoped variable, a localization context based on the specified resource bundle.
<fmt:setBundle basename="ApplicationResources var="strutsMessages" scope="application"/> Attribute basename Description Rqd Default None

<fmt:message key="fieldRequired"> <fmt:param value="User ID"/> </fmt:message>

<fmt:setTimeZone> - Sets the specified time zone in a named scoped variable or using the default time zone name if var is not specified.
Rqd No Default Body <fmt:setTimeZone var="mtnTime" value="America/Denver"/> Mountain Time: <fmt:formatDate type="time" timeStyle="short" value="${now}" timeZone="${mtnTime}"/>

Attribute value

Description Value used for parametric message format substitution.

Fully-qualified name of the Yes base bundle without a file type (such as .properties). Name of the variable to hold the localization context. No

var

Default l10n context (see Configu ration) page

<fmt:requestEncoding> - Instructs JSTL to use a specific character encoding (see http://www.iana.org/assignments/character-sets) to decode request parameters. Omitting a value indicates to use automatic detection of the proper encoding.
<fmt:requestEncoding key="ISO-8859-1"/>

Attribute value

Description

Rq d

Default

String representation of a time Yes None zone (such as America/New_York, GMT5, or EST) or an actual java.util.TimeZone object. Name of the variable to store the time zone. No Default time zone (see Configur ation) page

var Attribute value Description Character encoding (e.g. UTF8) to use. Rqd No Default Automatic scope

scope

Scope of the var variable

No

<fmt:message> - Looks up a localized message in a resource bundle. This tag can contain nested <fmt:param> tags to specify message format substitution values. The resultant message is printed or stored in a scoped variable.
<fmt:message key="title" bundle="${strutsResources}"/> Attribute key bundle Description Message key to be looked up. Rqd No Default Body Default l10n context

Scope of the var variable

No

Formatting Actions Actions that format and parse numbers, currencies, percentages, dates and times. <fmt:timeZone> - Sets the specified time zone to be applied to the nested body content. The following example demonstrates that the time zone by this action has only nested visibility.
<jsp:useBean id="now" class="java.util.Date"/> <fmt:timeZone value="America/Los_Angeles"> Pacific Time:<fmt:formatDate type="time" timeStyle="short" value="${now}"/> </fmt:timeZone> <br/> Local Time:<fmt:formatDate type="time" timeStyle="short" value="${now}"/>

<fmt:formatNumber> - Formats a number, currency, or percentage in a locale-sensitive manner. The formatted value is printed or stored in a scoped variable.
<fmt:formatNumber type="currency" value="3.977"> Attribute value type Description Numeric value to format. Rqd Default No Body number

Localization context (set by prio No configuration, <fmt:bundle>, or <fmt:setBundle>, which specifies the resource bundle the message key is to be looked up in. Variable to hold the message. Scope of the var variable. No No

var scope

Specifies the type of No value. Valid values are:

page Attribute Description String representation of a time zone (such as America/New_York, GMT-5, or EST) or an actual java.util.TimeZone object. Rqd Yes Default None pattern

number currency percentage None

<fmt:param> - Supplies a parameter for message format substitution in a containing <fmt:message> tag. Parameters are substituted in sequential order.

value

Custom formatting No pattern (overrides other formatting options including type see java.text.DecimalFormat )

Attribute currencyCode

Description

Rqd Default Based on default locale Based on default locale true

Attribute value type

Description Value to parse. Specifies the type of value. Valid values are:

Rqd No No

Default Body number

Attribute timeStyle

Description

Rqd

Default default

Currency code (ISO No 4217) used for formatting currencies. Such as USD (US dollars) or EUR (euro). Currency symbol used when formatting currencies. Such as $ for US dollars, or F for Francs. Specifies if grouping separators will be used (for example formatting 23890 as 23,890). No

Predefined formatting style for a No time (ignored if type=date) -- see java.text.DateFormat. Valid values are: default (2:51:16 PM) short (2:51 PM) medium (2:51:16 PM) long (2:51:16 PM EDT) full (2:51:16 PM EDT)

currencySymbol

pattern

number currency percentage No None pattern No Default locale timeZone No false

Custom parsing pattern (overrides type see java.text.DecimalFormat) String representation of a locale (e.g. en_US) or an actual java.util.Locale object used for parsing. Specifies if only the integer portion of the value should be parsed. Variable to store the formatted number. Scope of the var variable

groupingUsed

No

parseLocale

Custom formatting style (overrides No type, dateStyle, and timeStyle) see java.text.SimpleDateFormat. String representation of a time zone or an actual java.util.TimeZone object. No

None

maxIntegerDigits Maximum number of digits to print in the integer part of the number. minIntegerDigits Minimum number of digits to print in the integer part of the number.

No

None

integerOnly

Default time zone

No

None

var scope

No No

None page

<fmt:formatDate> - Formats a date and/or time in a locale-sensitive manner. The formatted value is printed or stored in a scoped variable.
<fmt:formatDate value="${now}" pattern="yy-MMM-dd"/>

maxFractionDigit Maximum number of s digits to print in the fractional part of the number. minFractionDigit s Minimum number of digits to print in the fractional part of the number. Variable to store the formatted number. Scope of the var variable

No

None

Formatting Dates Dates are formatted and parsed using the <fmt:formatDate> and <fmt:parseDate> actions which share the following common attributes.
Attribute Description Specifies the type of value. Valid values are: Rqd No Default date Attribute value Description Date value to format. Value must be a java.util.Date object. Variable to store the formatted number. Scope of the var variable Rqd Default No None

No

None

var scope

No No

None page

var scope

No No

None page

type

dateStyle

time (time only) date (date only) both (date and time) default

<fmt:parseNumber> - Parses a String representing a number, currency, or percentage in a localesensitive manner. The parsed value is printed or stored in a scoped variable.
<fmt:parseNumber var="num" type="number" pattern="#,###" value="2,447"/> <c:out value="${num}"/>

Predefined formatting style for a No date (ignored if type=time) -- see java.text.DateFormat. Valid values are: default (Jul 19, 2003) short (7/19/03) medium (Jul 19, 2003) long (July 19, 2003) full (Saturday, July 19, 2003)

<fmt:parseDate> - Parses a string representing a date and/or time in a locale-sensitive manner. The parsed value is printed or stored in a scoped variable.
<fmt:parseDate var="bday" pattern="MM/dd/yy" value="05/10/63"/> <fmt:formatDate value="${bday}" dateStyle="full"/>

Attribute value parseLocale

Description Date/time string to parse. String representation of a locale (e.g. en_US) or an actual java.util.Locale object used for parsing. Variable to store the parsed value as a java.util.Date. Scope of the var variable

Rqd Default No No None Default locale

SQL Tag Library

<%@ taglib prefix="sql" uri="http://java.sun.com/jstl/sql" %>

Attribute scope

Description Scope of the variable var.

Rqd No

Default page

var scope

No No

None page

The SQL tag library provides actions to perform transactional database queries and updates and easily access query results. <sql:query> - Performs a database query (e.g. select statement). The query should be expected to return a ResultSet. This action may include body content containing the actual query string as well as <sql:param> and <sql:dateParam> tags for parameter substitution. If the body contains the SQL query, it must appear before any nested parameter tags.
<sql:query var="users"> SELECT * FROM users WHERE last_name = "Burdell" </sql:query> <c:forEach var="user"items="${users.rows}"> <c:out value="${users.user_name}"/><br/> </c:forEach>

<sql:update> - Performs a database insert, update, delete or other statement (such as a DDL statement) that does not return any results. This action may include body content containing the actual update string as well as <sql:param> tags for parameter substitution. Like <sql:query>, the <sql:param> tags must occur after the sql statement if it is contained in the <sql:update> tag body.
<sql:update var="updateCount"> UPDATE users SET first_name="William" WHERE first_name = "Bill" </sql:update> <c:out value="${updateCount} rows updated."/> Attribute sql dataSource Description SQL statement to execute. Database connection to use. A javax.sql.DataSource object, or a String representing a JNDI resource or the parameters for java.sql.DriverManager. If specified, this action cannot be nested in <sql:transaction>. Rqd No No Default Body Default data source

Attribute sql

Description SQL query to execute.

Rqd No

Default Body Default data source

dataSource Database connection to use. A No javax.sql.DataSource object, or a String representing a JNDI resource or the parameters for java.sql.DriverManager. If specified, this action cannot be nested in <sql:transaction>. maxRows Maximum number of rows to return in the result. If not specified or set to -1, no limit is enforced. Returned results include rows starting at this index. The first row is row 0. No

var

Name of the variable to store No the query results as a java.lang.Integer object (e.g. SQL update statements return the number of rows affected). Scope of the variable var. No

None

Default maxRows (see Configur ation) 0

scope

page

startRow

No

var

Name of the variable to store the Yes query results. Returned rows are accessible via the rows property of this object.

None

<sql:transaction> - Establishes a database transaction for <sql:query> and <sql:update> tags contained in this tag's body. That is, all SQL actions contained in the body of this tag will be treated as a single atomic transaction. The transaction will be committed only if all statements succeed. If any of the contained SQL actions cause an exception, the transaction will be rolled back. Note: this action will reinstate the prior auto commit setting after completion.

<sql:transaction> <sql:update sql="DELETE users WHERE user_name='bsiggelkow'"/> <sql:update sql="INSERT INTO users VALUES ('billsigg','Bill','Siggy')"/> </sql:transaction> Attribute dataSource Description Rqd Default Default data source (see Configu ration) Databas e 's default

Attribute user password var

Description

Rqd

Default None None Default data source name (see Configur ation) page

Attribute value

Description Value of the parameter. Must be a java.util.Date object. Indicates how the database should interpret the value. Valid values are: date time timestamp

Rqd Yes

Default None

Database user's username No Database user's password Name of the variable to hold the data source. No No

type

No

timestamp

Database connection to No use. A javax.sql.DataSource object, or a String representing a JNDI resource or the parameters for java.sql.DriverManager. Transaction isolation level. Valid values are: read_committed read_uncommitted repeatable_read serializable No

scope

Scope of the variable var.

No

isolation

<sql:param> - Substitutes parameters into SQL prepared statement placeholders (?). This action can only be nested within <sql:query> or <sql:update> tags. If the enclosing tag specifies the SQL in the body, any <sql:param> tags must appear after the SQL. Parameters are substituted in sequential order.
<c:set var="firstName">Bill</c:set> <sql:query var="users"> SELECT user_name, last_name FROM users WHERE first_name = ? <sql:param value="${firstName}"/> </sql:query>

<sql:setDataSource> - Creates and stores in a scoped variable an SQL data source. This tag cannot have a body. Either the dataSource or url attribute must be specified.
<sql:setDataSource var="testDB" url="jdbc:mysql://localhost/test, com.mysql.jdbc.Driver"/> <sql:query var="users" dataSource="${testDB}"> SELECT * FROM users </sql:query>

Attribute value

Description

Rqd

Default Body

Value of the parameter. If not No specified, value is taken from the tag body.

Attribute dataSource

Description

Rqd

Default None

Database connection to No use or create. A javax.sql.DataSource object, or a String representing a JNDI resource or the parameters for java.sql.DriverManager. Name of the JDBC driver class. URL for the JDBC database connection. No No

<sql:dateParam> - Substitutes time, date, or timestamp parameters into SQL prepared statement placeholders. This action can only be nested within <sql:query> or <sql:update> tags. Parameters are substituted in sequential order.
<fmt:parseDate var="ww2End" pattern="yyyy-MM-dd" value="1945-09-02"/> <sql:query var="postWarBabies"> SELECT user_name FROM user_profile WHERE birth_date > ? <sql:dateParam value="${ww2End}" type="date"/> </sql:query>

driver url

None None

scope="page"/>

XML Tag Library

<%@ taglib prefix="x" uri="http://java.sun.com/jstl/xml" %>

Function contains (string1, string2): boolean count (node-set): Example $doc//first-name $doc/users/user/. $doc//[firstname='George']/../lastname $doc//user[@id="997"]/firs t-name $doc/users/user[lastname='Burdell'] $doc//*[localname()='users']/user number floor (number or object): number last(): number local-name (node-set): string name (node-set): string

Description Returns true if string1 contains string2; false, otherwise. Non-string arguments are converted to strings as if by the string() function. Returns the number of nodes in the node set.

<%-- Find the user with matching ID --%> <x:set var="user" select="$doc//users/user[@id=$pageScope:user Id]"/> <%-- Say Hi to the user --%> Hi <x:out select="$user/first-name"/> !

The XML tag library supports parsing of XML documents, selection of XML fragments, conditional and iterative processing based on XML content, and XSLT transformations. A common pattern for using the XML tags is as follows: 1. Use <x:parse> to parse XML into a scoped variable. The XML can come from the body literally, from the body via <c:import>, or from the value attribute which may refer to any XML source. <x:parse var="varName" ...> 2. Use the scoped variable from <x:parse> to specify the XML document to use in XPath expressions. <x:out select="$varName/XPath expression"/> Using JSTL Data as XPath Variables Scoped variables can be used in XPath expressions ($implicitObject:variableName) similar to how they are used in EL (${implicitObject.variableName}). If the implicit object is omitted, scopes will be searched in standard order. Note that the . and [] notations cannot be used for accessing bean properties. The following example demonstrates the above techniques.
<%-- Create the XML --%> <x:parse var="doc"> <users> <user id="997"> <first-name>George</first-name> <last-name>Burdell</last-name> </user> <user id="998"> <first-name>Joseph</first-name> <last-name>Blough</last-name> </user> </users> </x:parse> <%-- Define a variable holding user ID --%> <c:set var="userId" value="${user.id}"

XPath Abbreviated Syntax

Abbr. // . .. XPath Axis descendant self parent

Returns the greatest integer less than or equal to number or object (as converted as if by the number() function).

Returns the number of nodes in the context node. Returns the part of the element name after the colon (:) when namespaces are used. If node set is not specified the function is applied to the context node. Returns the qualified element name, that is, prefix:local-name, when namespaces are used. If node set is not specified the function is applied to the context node. Returns the uri of the namespace of the given node set. If node set is not specified the function is applied to the context node.

attribute child

(blank) * (matches any namespace)

Useful XPath Functions Following are some useful XPath functions that can be used in XPath expressions. This list does not include all XPath functions just those deemed particularly useful when using the JSTL XML tags.
Function ceiling (number or object): number concat (string1, string 2, ...): string Concatenates the arguments in order from left to right. Non-string arguments are converted to strings as if by the string() function. Description Returns the smallest integer greater than or equal to number or object (as converted as if by the number() function).

namespace-uri (node-set): string not (boolean or object): boolean number (object): number position(): number

Returns the logical inversion of the supplied argument. That is, if the argument is true, false is returned; if argument is false, true is returned.

Converts object (or the current node if object is not specifed) to a number. True is converted to 1, and false to 0. If the number cannot be converted NaN is returned. Returns the position of the current node in the current context node set. The first position is 1.

Function round (number or object): number starts-with (string1,string2): boolean string (object): string string-length (object): number substring (string, index, length): string substring-after (string1, string2): string substring-before (string1, string2): string sum (node-set): number

Description Returns the closest integer to number or object (as converted as if by the number() function). If two integers are equally close, the value closer to positive infinity is chosen. (e.g. round(3.5) returns 4, round(3.5) returns -3). Returns true if string1 starts with string2; false, otherwise.

Converts the object, or the current node if object is not specifed, to a string. Generally, this function will output the body of the elements (e.g. string(<a>b</a>) returns b). Number of characters in the string. If object is not a string it is first converted to a string as if by the string() function.

<title>feed title</title> <link>source url</link> <description>feed desc</description> <item> <title>article title</title> <link>article url</link> <description>article desc</description> </item> <item> <title>article title</title> <link>article url</link> <description>article desc</description> </item> </channel> </rss>

expression as a string.
RSS Channel: <x:out select="$news//channel/title"/>

Attribute select escapeXml

Description XPath expression.

Rqd Yes No

Default None true

true

to escape special characters

<x:parse> - Parses XML content, provided by the value attribute or the tags body, into a scoped variable(s). This variable can then be used for subsequent processing by other XML tags.
<c:import var="rss" url="http://servlet.java.sun.com/syndication /rss_java_highlights-PARTNER-20.xml"/> <x:parse var="news" xml="${rss}"/>

<x:set> - Saves the result of the select XPath expression to a scoped variable. Returned value may be a node set (XML fragment), boolean, string, or number.
<x:set select="$news//channel/item" var="newsItems"/>

Returns a substring of string starting at index and continuing for length characters. The first character is position 1, not position 0 as in Java and JavaScript.

Attribute select var

Description XPath expression. Name of variable to store results. The variable type is equal to whatever is returned by the select expression.

Rqd No No

Default None None

Attribute doc xml

Description (JSTL 1.1) Text of the document to a parse as a String or Reader. (JSTL 1.0 deprecated in 1.1) Same as doc attribute. URI of the original document, used for entity resolution. XML filter to apply. Value should be of type org.xml.sax.XMLFilter. Name of the variable to store the results may be an implementation-specific object. Scope of the variable var. Name of the variable to store the result stored as a DOM object.

Rqd No No No No Yes

Default Body Body None None None

Returns the substring in string1 following the first of occurrence of string2 in string1.

Returns the substring in string1 preceding the first of occurrence of string2 in string1.

Boolean java.lang.Boolean Number java.lang.Number Node or node set implementationdependent type No page

systemId filter var

Converts each node in the set to a number, as if by the number() function, adds up the numbers and returns the sum.

scope

Scope of variable var.

General XML Actions Actions for parsing XML, outputting to the page, and selecting XML fragments. The examples that follow demonstrate use of the XML tags for processing Rich Site Summary (RSS) feeds. RSS has more or less the following format:
<?xml version="1.0"?> <rss version="0.91"> <channel>

scope varDom

No Yes No

page None page

Flow Control Actions Actions for processing markup based on logical and iterative conditions. <x:if> - Processes the body if select XPath evaluates to true (following the rules of the boolean() XPath function).
<x:if select=

scopeDom Scope to store variable varDOM in.

<x:out> - Prints the result of the XPath

"$news//item[contains(description,'Linux')]"> Linux is in the news today! </x:if>

Attribute select

Description Test condition as an XPath expression. Body content is processed if the condition is true.

Rqd Yes

Default None

<x:choose> -- Processes the body of the first enclosed <x:when> tag where the select XPath expression evaluates to true. If none match then the body of the <x:otherwise> tag (if present) is processed.
<x:choose> <x:when select="$news//item"> We've got news :) </x:when> <x:otherwise> No news today :( </x:otherwise> </x:choose>

Attribute var

Description Name of variable to hold the current item. This variable has only nested visibility.

Rqd Default No None

Transformation Actions JSTL provides an <x:transform> tag for performing XSLT transformations. The <x:param> tag can be nested in the <x:transform> tag to set a parameter that is used in the stylesheet. <x:transform> - Conducts an XSLT transformation on source XML. The source XML is provided by the doc attribute or the body of the tag. The XSL stylesheet is specified by the xslt attribute. While in most cases, the stylesheet will be set up by back-end code it is possible to define the stylesheet inline and make it available with <c:set> as in the following example:
<c:set var="xsl"> <?xml version="1.0" encoding="UTF-8"?> <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform "> <xsl:template match="item"> <li> <xsl:value-of select="title"/> </li> </xsl:template> <xsl:template match="/"> <ol> <xsl:apply-templates select="//item"/> </ol> </xsl:template> </xsl:stylesheet> </c:set> <x:transform xml="${news}" xslt="${xsl}"/>

var scope

Name of variable to store test No condition's result Scope of variable No

None page

The choose tag accepts no attributes and can only contain <x:when> tag(s) and an optional <x:otherwise> tag. <x:when> - Represents an alternative in an <x:choose> tag. Processes the body if the select expression evaluates to true and no other previous <x:when> tags in the <x:choose> matched.
Attribute select Description Test condition as an XPath expression. Rqd Yes Default None

<x:otherwise> - Processes the body if no other previous <x:when> condition in the <x:choose> matched. This tag accepts no attributes and, if present, must be the last tag in <x:choose> body. <x:forEach> - Repeats the nested body content over a node set determined by an XPath expression, setting the context node to each element in the iteration.
<x:forEach select="$news//item"> <a href='<x:out select="link"/>'> <x:out select="title"/></a><br/> </x:forEach>

Attribute doc

Description

Rqd

Default Body

Attribute select

Description Name of variable to hold the current item. This variable has only nested visibility.

Rqd Default No None

No (JSTL 1.1) Source XML document for the transformation. Value can be a String, Reader, javax.xml.transform.Source , org.w3c.dom.Document, or any value exported <x:parse> or <x:set>. If the value comes from <x:set> it cannot be a partial document.

Attribute xml docSystemId

Description

Rqd

Default Body None

Attribute name

Description Name of the parameter as a String. This name must match the name in the corresponding <xsl:param> XSLT tag.

Rqd Yes

Default None

(JSTL 1.0 deprecated in No 1.1) Same as doc attribute. (JSTL 1.1) URI of the source XML to used to resolve entity references. (JSTL 1.0 deprecated in 1.1) Same as docSystemId. No

JSTL Configuration
JSTL can utilize configuration parameters for setting such things as a default application resource bundle, time zone, and data source. These values can be established using (1) setVariable-like tags (e.g. <fmt:setLocale>, <sql:setDataSource>), (2) programmatically using the JSTL Config API or by (3) the web container itself via context initialization parameters set in the application's web.xml file. 1. Set by a JSTL action this allows specification of scope by the scope attribute.

value No None

xmlSystemId

Value of the parameter. If not No specified, value is taken from the tag body.

Body

xslt

XSLT stylesheet to use. Yes The value must be a String, Reader or an javax.xml.transform.Source object. URI of the stylesheet to use to resolve entity references. Variable to hold the result as a org.w3c.doc.Document object. Scope of the variable var. javax.xml.transform.Result object that holds or processes the transformed XML. No No

None

xsltSystemId

None

<fmt:setLocale value="en_US" scope="session"/>

var

No

Non e

2. Set Programmatically allows specification of scope via the Config API.

import javax.servlet.jst.jstl.core.Config; ... Config.set( session, Config.FMT_LOCALE, new java.util.Locale(en_US") );

scope result

None

3. Set by Context Initialization Parameters specifies value used if setting not found in any of the standard scopes.
<web-app> ... <context-param> <param-name> javax.servlet.jsp.jstl.fmt.locale </param-name> <param-value> en_US </param-value> </context-param> ... </web-app>

<x:param> - Sets a transformation parameter that will be passed to stylesheet which declares parameters using the <xsl:param> tag. The <x:param> tag can only be nested within an <x:transform> tag. Any <x:param> tags must come after the XML body content of the <x:transform> tag, if present.
<x:transform xml="${news}" xslt="${searchXsl}"/> <x:param name="searchParam"> Web Services </x:param> </x:transform>

Attribute

Description

Rqd

Default

Locale Specifies the default locale to be used by the formatting tags. This variable sets an applicationbased locale and has priority over any browser-based locales.
Variable Name Java Constant Type Set by javax.servlet.jsp.jstl.fmt.locale Config.FMT_LOCALE String (e.g. en_US) or java.util.Locale <fmt:setLocale>, Config API, web.xml

Variable Name Java Constant Type Set by

javax.servlet.jsp.jstl.fmt.timeZone Config.FMT_TIMEZONE String (e.g. America/Los_Angeles) or java.uti.TimeZone <fmt:setTimeZone>, Config API, web.xml

Data Source Specifies the data source to be accessed by the SQL tags. The value can be specified as a javax.sql.DataSource object, as a string representing a JNDI relatove path (e.g. jdbc/myDatabase if the absolute JNDI name is java:comp/env/jdbc/myDatabase), or a JDBC parameters string (url, driver, user, password) (e.g. jdbc:mysql://localhost/,com.mysql.Driver).
Variable Name javax.servlet.jsp.jstl.sql.dataSource Java Constant Type Config.SQL_DATA_SOURCE String (JNDI relative path or JDBC parameters string) or javax.sql.DataSource <fmt:setDataSource>, Config API, web.xml

Fallback Locale Specifies the default locale to be used for finding resource bundle messages. This locale will be used if a message cannot be found using any of the preferred locales.
Variable Name Java Constant Type Set by javax.servlet.jsp.jstl.fmt.fallbackLocale Config.FMT_FALLBACK_LOCALE String (e.g. en_US) or java.util.Locale Config API, web.xml

Set by

Max Rows Sets the maximum number of rows that can be returned by any <sql:query> tag. A value of -1 indicates no limit.
Variable Name javax.servlet.jsp.jstl.sql.maxRows Java Constant Config.SQL_MAX_ROWS Integer Config API, web.xml

I18n Localization Context Specifies the default resource bundle to use for localized messages. If a String is used (e.g. via the <fmt:setBundle> tag or a context-initialization parameter), the value refers to the name of the resource bundle (including any package name but excluding .properties or .class).
Variable Name javax.servlet.jsp.jstl.fmt.localizationConte xt Java Constant Type Config.FMT_LOCALIZATION_CONTEXT String (e.g. resources.ApplicationResources) or javax.servlet.jsp.jstl.fmt.LocalizationConte xt <fmt:setBundle>, Config API, web.xml

Type Set by

Set by

Time Zone Specifies the default time zone to be used by the formatting tags.
Variable Name javax.servlet.jsp.jstl.fmt.timeZone