Skip Headers

Oracle9iAS Containers for J2EE JSP Tag Libraries and Utilities Reference
Release 2 (9.0.2)

Part Number A95883-01
Go To Documentation Library
Home
Go To Product List
Solution Area
Go To Table Of Contents
Contents
Go To Index
Index

Go to previous page Go to next page

A
JML Compile-Time Syntax and Tags

Oracle JSP releases prior to the implementation of the JSP 1.1 specification could support JML tags only as Oracle-specific extensions. The tag library framework was added to the Sun Microsystems JavaServer Pages Specification, Version 1.1. For those releases, JML tag processing was built into the JSP translator. This is referred to as "compile-time tag support" in this manual.

JSP releases with OC4J continue to support the compile-time JML implementation; however, it is generally advisable to use the runtime implementation whenever possible. The runtime implementation is documented in Chapter 3, "JSP Markup Language Tags".

This appendix discusses features of the compile-time implementation that are not in common with the runtime implementation. This includes the following topics:

For a general discussion of when it may be advantageous to use a compile-time implementation, refer to the Oracle9iAS Containers for J2EE Support for JavaServer Pages Reference.

JML Compile-Time Syntax Support

This section describes Oracle-specific bean reference syntax and expression syntax supported by the compile-time JML implementation, for specifying tag attribute values. The following topics are covered:

This functionality requires the OC4J JSP translator; it is not portable to other JSP environments.

JML Bean References and Expressions, Compile-Time Implementation

A bean reference is any reference to a JavaBean instance (bean) that results in accessing either a property or a method of the bean. This includes a reference to a property or method of a bean where the bean itself is a property of another bean.

This becomes cumbersome, because standard JavaBeans syntax requires that properties be accessed by calling their accessor methods rather than by direct reference. For example, consider the following direct reference:

a.b.c.d.doIt()

This must be expressed as follows in standard JavaBeans syntax:

a.getB().getC().getD().doIt()

The Oracle compile-time JML implementation, however, offers abbreviated syntax, as described in the following subsections.

JML Bean References

Oracle-specific syntax supported by the compile-time JML implementation allows bean references to be expressed using direct dot (".") notation. Note that standard bean property accessor method syntax is also still valid.

Consider the following standard JavaBean reference:

customer.getName()

In JML bean reference syntax, you can express this in either of the following ways:

customer.getName()

or:

customer.name

JavaBeans can optionally have a default property, whose reference is assumed if no reference is explicitly stated. You can omit default property names in JML bean references. In the example above, if name is the default property, then the following are all valid JML bean references:

customer.getName()

or:

customer.name

or simply:

customer

Most JavaBeans do not define a default property. Of those that do, the most significant are the JML datatype JavaBeans described in Chapter 2, "JavaBeans for Extended Types".

JML Expressions

JML expression syntax supported by the compile-time JML implementation is a superset of standard JSP expression syntax, adding support for the JML bean reference syntax documented in the preceding section.

A JML bean reference appearing in a JML expression must be enclosed in the following syntax:

$[JML_bean_reference]

Attribute Settings with JML Expressions

Tag attribute documentation under "JSP Markup Language (JML) Tag Descriptions" notes standard syntax that is portable. You can set attributes, as documented there, for either the runtime or the compile-time JML implementation and even for non-Oracle JSP environments.

If you intend to use only the Oracle-specific compile-time implementation, however, you can set attributes using JML bean references and JML expression syntax, as documented in "JML Bean References and Expressions, Compile-Time Implementation" above.

Note the following requirements:

JML Compile-Time Tag Support

This section presents the following:

The taglib Directive for Compile-Time JML Support

The Oracle compile-time JML support implementation uses a custom class, OpenJspRegisterLib, to implement JML tag support.

In a JSP page using JML tags with the compile-time implementation, the taglib directive must specify the fully qualified name of this class (instead of specifying a TLD file as in standard JSP 1.1 tag library usage).

Following is an example:

<%@ taglib uri="oracle.jsp.parse.OpenJspRegisterLib" prefix="jml" %>

For information about usage of the taglib directive for the JML runtime implementation, see "Overview of the JSP Markup Language (JML) Tag Library".

JML Tag Summary, Compile-Time Versus Runtime

Most JML tags are available in both the runtime model and the compile-time model; however, there are exceptions, as summarized in Table A-1.

Table A-1 JML Tags Supported: Compile-Time Model Versus Runtime Model  
Tag Supported in Oracle Compile-Time Implementation? Supported in Oracle Runtime Implementation?

Bean Binding Tags:

useBean

yes

no; use jsp:useBean

useVariable

yes

yes

useForm

yes

yes

useCookie

yes

yes

remove

yes

yes

Bean Manipulation Tags:

getProperty

yes

no; use jsp:getProperty

setProperty

yes

no; use jsp:setProperty

set

yes

no

call

yes

no

lock

yes

no

Control Flow Tags:

if

yes

yes

choose

yes

yes

for

yes

yes

foreach

yes; type attribute is optional

yes; type attribute is required

return

yes

yes

flush

yes

yes

include

yes

no; use jsp:include

forward

yes

no; use jsp:forward

XML Tags:

transform

yes

yes

styleSheet

yes

yes

Utility Tags:

print

yes; use double-quotes to specify a string literal

no; use JSP expressions

plugin

yes

no; use jsp:plugin

Descriptions of Additional JML Tags, Compile-Time Implementation

This section provides detailed descriptions of JML tags that are still supported by the JML compile-time implementation, but are not supported by the JML runtime implementation. The tags supported in the runtime implementation are documented under "JSP Markup Language (JML) Tag Descriptions".

The following JML tags, for compile-time only, are documented here:

JML useBean Tag

This tag declares an object to be used in the page, locating the previously instantiated object at the specified scope by name if it exists. If it does not exist, the tag creates a new instance of the appropriate class and attaches it to the specified scope by name.

The syntax and semantics are the same as for the standard jsp:useBean tag, except that wherever a JSP expression is valid in jsp:useBean usage, either a JML expression or a JSP expression is valid in JML useBean usage.

You can refer to the Oracle9iAS Containers for J2EE Support for JavaServer Pages Reference for an overview of the jsp:useBean tag.

Syntax

<jml:useBean id = "beanInstanceName" 
[ scope ="page" | "request" | "session" | "application" ]
  class ="package.class" | 
  type = "package.class" | 
  class ="package.class" type = "package.class" |
  beanName = "package.class" | "<%= jmlExpression %>" type = "package.class"  /> 

Alternatively, you can have additional nested tags, such as setProperty tags, and use a </jml:useBean> end tag.

Attributes

Refer to the Sun Microsystems JavaServer Pages Specification, Version 1.1 for detailed information about jsp:useBean attributes and their syntax.

Example

<jml:useBean id = "isValidUser" class = "oracle.jsp.jml.JmlBoolean" scope = "session" /> 

JML getProperty Tag

This tag is functionally identical to the standard jsp:getProperty tag. It prints the value of the bean property into the response.

For general information about getProperty usage, refer to the Oracle9iAS Containers for J2EE Support for JavaServer Pages Reference or the Sun Microsystems JavaServer Pages Specification, Version 1.1.

Syntax

<jml:getProperty name = "beanInstanceName" 
                 property = "propertyName" />

Attributes

Example

The following example outputs the current value of the salary property. Assume salary is of type JmlNumber.

<jml:getProperty name="salary" property="value" />

This is equivalent to the following:

<%= salary.getValue() %>

JML setProperty Tag

This tag covers the functionality supported by the standard jsp:setProperty tag, but also adds functionality to support JML expressions. In particular, you can use JML bean references.

For general information about setProperty usage, refer to the Oracle9iAS Containers for J2EE Support for JavaServer Pages Reference or the Sun Microsystems JavaServer Pages Specification, Version 1.1.

Syntax

<jml:setProperty name = "beanInstanceName" 
                 property = " * " | 
                 property = "propertyName" [ param = "parameterName" ] | 
                 property = "propertyName"
               [ value = "stringLiteral" | "<%= jmlExpression %>" ] />

Attributes

Example

The following example updates salary with a six percent raise. (Assume salary is of type JmlNumber.)

<jml:setProperty name="salary" property="value" value="<%= $[salary] * 1.06 %>" /> 

This is equivalent to the following:

<% salary.setValue(salary.getValue() * 1.06); %>

JML set Tag

This tag provides an alternative for setting a bean property, using syntax that is more convenient than that of the setProperty tag.

Syntax

<jml:set name = "beanInstanceName.propertyName"
         value = "stringLiteral" | "<%= jmlExpression %>" />

Attributes

Example

Each of the following examples updates salary with a six percent raise. (Assume salary is of type JmlNumber.)

<jml:set name="salary.value" value="<%= salary.getValue() * 1.06 %>" />

or:

<jml:set name="salary.value" value="<%= $[salary.value] * 1.06 %>" />

or:

<jml:set name="salary" value="<%= $[salary] * 1.06 %>" /> 

These are equivalent to the following:

<% salary.setValue(salary.getValue() * 1.06); %>

JML call Tag

This tag provides a mechanism to invoke bean methods that return nothing.

Syntax

<jml:call method = "beanInstanceName.methodName(parameters)" />

Attributes

Example

The following example redirects the client to a different page:

<jml:call name='response.sendRedirect("http://www.oracle.com/")' />

This is equivalent to the following:

<% response.sendRedirect("http://www.oracle.com/"); %>

JML lock Tag

This tag allows controlled, synchronous access to the named object for any code that uses it within the tag body.

Generally, JSP developers need not be concerned with concurrency issues. However, because application-scope objects are shared across all users running the application, access to critical data must be controlled and coordinated.

You can use the JML lock tag to prevent concurrent updates by different users.

Syntax

<jml:lock name = "beanInstanceName" >
   ...body...
</jml:lock>

Attributes

Example

In the following example, pageCount is an application-scope JmlNumber value. The variable is locked to prevent the value from being updated by another user between the time this code gets the current value and the time it sets the new value.

<jml:lock name="pageCount" >
    <jml:set name="pageCount.value" value="<%= pageCount.getValue() + 1 %>" />
</jml:lock>

This is equivalent to the following:

<% synchronized(pageCount) 
   {
      pageCount.setValue(pageCount.getValue() + 1);
   } 
%>

JML include Tag

This tag includes the output of another JSP page, a servlet, or an HTML page in the response of the including page (the page invoking include). It provides the same functionality as the standard jsp:include tag except that the page attribute can also be expressed as a JML expression.

For general information about include usage, refer to the Oracle9iAS Containers for J2EE Support for JavaServer Pages Reference or the Sun Microsystems JavaServer Pages Specification, Version 1.1.

Syntax

<jml:include page = "relativeURL" | "<%= jmlExpression %>" 
             flush = "true" />

Attributes

For general information about include attributes and usage, refer to the Sun Microsystems JavaServer Pages Specification, Version 1.1.

Example

The following example includes the output of table.jsp, a presentation component that renders an HTML table based on data in the query string and request attributes.

<jml:include page="table.jsp?maxRows=10" flush="true" />

JML forward Tag

This tag forwards the request to another JSP page, a servlet, or an HTML page. It provides the same functionality as the standard jsp:forward tag except that the page attribute can also be expressed as a JML expression.

For general information about forward usage, refer to the Oracle9iAS Containers for J2EE Support for JavaServer Pages Reference or the Sun Microsystems JavaServer Pages Specification, Version 1.1.

Syntax

<jml:forward page = "relativeURL" | "<%= jmlExpression %>" />

Attributes

For general information about forward attributes and usage, refer to the Sun Microsystems JavaServer Pages Specification, Version 1.1.

Example

<jml:forward page="altpage.jsp" />

JML print Tag

This tag provides essentially the same functionality as a standard JSP expression: <%= expr %>. A specified JML expression or string literal is evaluated, and the result is output into the response. With this tag, the JML expression does not have to be enclosed in <%= ... %> syntax; however, a string literal must be enclosed in double-quotes.

Syntax

<jml:print eval = '"stringLiteral"' | "jmlExpression" />

Attributes

Examples

Either of the following examples outputs the current value of salary, which is of type JmlNumber:

<jml:print eval="$[salary]" /> 

or:

<jml:print eval="salary.getValue()" />

The following example prints a string literal:

<jml:print eval='"Your string here"' />

JML plugin Tag

This tag has functionality identical to that of the standard jsp:plugin tag.

For general information about plugin usage, refer to the Oracle9iAS Containers for J2EE Support for JavaServer Pages Reference or the Sun Microsystems JavaServer Pages Specification, Version 1.1.


Go to previous page Go to next page
Oracle
Copyright © 2002 Oracle Corporation.

All Rights Reserved.
Go To Documentation Library
Home
Go To Product List
Solution Area
Go To Table Of Contents
Contents
Go To Index
Index