net.windward.bean
Interface BeanProvider

All Known Subinterfaces:

StatefulBeanProvider, StatelessBeanProvider

All Known Implementing Classes:

BeanProviderImpl

public interface BeanProvider

This interface must be implemented for any Windward Reports bean. You can use the class BeanProviderImpl instead and inherit from that. This interface is provided for beans that are both a Windward Reports bean and a class that is used for other purposes and must inherit from a different base class.

Version:

3.0 June 18, 2004

Method Summary

boolean	forEachTag(ForEachTag tag) Process a <wr:forEach ...
BeanResult	functionTag(FunctionTag tag, java.lang.String[] nodeValues, java.lang.String value, java.util.Locale locale) Process a <wr:function ...
boolean	ifTag(IfTag tag, boolean value) Process a <wr:if ...
BeanResult	outTag(OutTag tag, java.lang.String value, java.util.Locale locale) Process a <wr:out ...

Method Detail

functionTag

public BeanResult functionTag(FunctionTag tag,
                              java.lang.String[] nodeValues,
                              java.lang.String value,
                              java.util.Locale locale)
                       throws BeanProviderException

Process a <wr:function ... /> tag. Return the string and formatting to display.

Parameters:

tag - The tag that is being printed.

nodeValues - The initial values of each node used by the function tag.

value - The final string value for the tag.

locale - The locale in effect for the document.

Returns:

The string and formatting to write at this point in the report.

Throws:

BeanProviderException - Something is wrong with the bean. This is defined by the bean implementor.

outTag

public BeanResult outTag(OutTag tag,
                         java.lang.String value,
                         java.util.Locale locale)
                  throws BeanProviderException

Process a <wr:out ... /> tag. Return the string and formatting to display.

Parameters:

tag - The tag that is being printed.

value - The final string value for the tag.

locale - The locale in effect for the document.

Returns:

The string and formatting to write at this point in the report.

Throws:

BeanProviderException - Something is wrong with the bean. This is defined by the bean implementor.

forEachTag

public boolean forEachTag(ForEachTag tag)
                   throws BeanProviderException

Process a <wr:forEach ... /> tag. This is called before each iteration of a forEach loop. This provides the ability to end a loop early. Return true to continue in the loop and false to end the loop.

Parameters:

tag - The tag that is being iterated.

Returns:

true to continue in the loop and false to end the loop.

Throws:

BeanProviderException - Something is wrong with the bean. This is defined by the bean implementor.

ifTag

public boolean ifTag(IfTag tag,
                     boolean value)
              throws BeanProviderException

Process a <wr:if ... /> tag. This provides the ability to set the value of the if. Return true to include the text inside the if and false to skip the if (or process the else if there is one).

Parameters:

tag - The tag that is being evaluted.

value - The evaluated value of the tag.

Returns:

true true to include the text inside the if and false to skip the if (or process the else if there is one).

Throws:

BeanProviderException - Something is wrong with the bean. This is defined by the bean implementor.