Using Dynamic SQL - iBATIS in Action - page 169

8.2.2 Binary tags

Binary tags compare the value of a parameter property to another value or param-
eter property. The body content is included if the result of the comparison is true.
All binary tags share the property compareProperty as well as compareValue
attributes. The property attribute serves as the primary value to be compared
against, while compareProperty and compareValue serve as the secondary com-
pare values. The compareProperty attribute specifies a property of the parameter
object that will contain a value used to compare against the primary value. com-
pareValue specifies a static value that will be used to compare against the primary
value. The name of the tag indicates how the values should be compared. The tag
attributes are shown in table 8.2.

Table 8.2 Binary tag attributes

The property of the parameter used to compare against the compare-
Value or compareProperty .

property
(required)

prepend
(optional)

This value is used to prepend to the tag's resulting body content. The
prepend value will not be prepended (a) when the tag's resulting body
content is empty; (b) if the tag is the first to produce body content and
is nested in a tag with the removeFirstPrepend attribute set to true;
or (c) if the tag is the first to produce body content following a
<dynamic> tag with a prepend attribute value that is not empty.

open
(optional)

This value is used to prefix to the tag's resulting body content. The open
value will not be prefixed if the tag's resulting body content is empty.
The open value is prefixed before the prepend attribute's value is pre-
fixed. For example, if prepend="OR " and open="(" then the resulting
combined prefix would be "OR (" .

close
(optional)

The close value is used to append to the tag's resulting body content.
The append value will not be appended if the tag's resulting body con-
tent is empty.

This value defines whether the first nested content-producing tag will
have its prepend value removed (optional).

removeFirstPrepend
(optional)

compareProperty
(required if compareValue is
not specified)

This value names a property on the parameter object to compare
against the property named by the property attribute.

This static comparison value is compared against the property named
by the property attribute.

compareValue
(required if compareProp-
erty is not specified)