org.milyn.calc

Class Counter

java.lang.Object

org.milyn.calc.Counter

All Implemented Interfaces:

ContentHandler, DOMVisitAfter, DOMVisitBefore, DOMVisitor, Producer, SAXVisitAfter, SAXVisitBefore, SAXVisitor, Visitor

@VisitBeforeIf(condition="!parameters.containsKey(\'executeAfter\') || parameters.executeAfter.value != \'true\'")
 @VisitAfterIf(condition="parameters.containsKey(\'executeAfter\') && parameters.executeAfter.value == \'true\'")
public class Counter
extends Object
implements SAXVisitBefore, SAXVisitAfter, DOMVisitBefore, DOMVisitAfter, Producer

The counter can increment or decrement a value.

This counter has extended xml schema configuration. Take a look at the schema http://www.milyn.org/xsd/smooks/calc-1.1.xsd for more information.

Example basic configuration:

 <resource-config selector="orderItems">
    <resource>org.milyn.calc.Counter</resource>
    <param name="beanId">count</param>
 </resource-config>
 

 Optional parameters:
    <param name="start">1</param>
    <param name="amount">2</param>
    <param name="amountExpression">incrementAmount</param>
    <param name="startExpression">startValue</param>
    <param name="resetCondition">count == 10</param>
    <param name="direction">DECREMENT</param>
    <param name="executeAfter>false</param>
 

Description of configuration properties:

• beanId: The beanId in which the counter value is stored. The value is always stored as a Long type.
• start: The counter start value.
• startExpression: The result of this expression is the counter start value. This expression is executed at the first count and every time the counter is reset. The expression must result in an integer or a long. If the startIndex attribute of the counter is set then this expression never gets executed.
• amount: The amount that the counter increments or decrements the counter value.
• amountExpression: The result of this expression is the amount the counter increments or decrements. This expression is executed every time the counter counts. The expression must result in an integer. If the amount attribute of the counter is set then this expression never gets executed.
• resetCondition: When the expression is set and results in a true value then the counter is reset to the start index. The expression must result in a boolean.
• direction: The direction that the counter counts. Can be INCREMENT (default) or DECREMENT.
• executeAfter: If the counter is executed after the element else it will execute before the element. Default is 'false'.

Since:

1.1

Author:

maurice.zeijen@smies.com

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_AMOUNT
static Long	DEFAULT_START_INDEX

Constructor Summary

Constructors

Constructor and Description
Counter()

Method Summary

Modifier and Type	Method and Description
void	count(ExecutionContext executionContext, Fragment source)
Set<? extends Object>	getProducts() Get the set of products produced by this producer instance.
void	initialize()
void	visitAfter(Element element, ExecutionContext executionContext) Visit the supplied element after visiting its child elements.
void	visitAfter(SAXElement element, ExecutionContext executionContext) Visit the supplied element after visiting its child elements.
void	visitBefore(Element element, ExecutionContext executionContext) Visit the supplied element before visiting its child elements.
void	visitBefore(SAXElement element, ExecutionContext executionContext) Visit the supplied element before visiting its child elements.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_START_INDEX

public static final Long DEFAULT_START_INDEX

DEFAULT_AMOUNT

public static final int DEFAULT_AMOUNT

See Also:

Constant Field Values

Constructor Detail

Counter

public Counter()

Method Detail

initialize

@Initialize
public void initialize()

visitBefore

public void visitBefore(SAXElement element,
                        ExecutionContext executionContext)
                 throws SmooksException,
                        IOException

Description copied from interface: SAXVisitBefore

Visit the supplied element before visiting its child elements.

Specified by:

visitBefore in interface SAXVisitBefore

Parameters:

element - The SAX element being visited.

executionContext - Execution context.

Throws:

SmooksException - Event processing failure.

IOException - Error writing event to output writer.

visitAfter

public void visitAfter(SAXElement element,
                       ExecutionContext executionContext)
                throws SmooksException,
                       IOException

Description copied from interface: SAXVisitAfter

Visit the supplied element after visiting its child elements.

Specified by:

visitAfter in interface SAXVisitAfter

Parameters:

element - The SAX element being visited.

executionContext - Execution context.

Throws:

SmooksException - Event processing failure.

IOException - Error writing event to output writer.

visitBefore

public void visitBefore(Element element,
                        ExecutionContext executionContext)
                 throws SmooksException

Description copied from interface: DOMVisitBefore

Visit the supplied element before visiting its child elements.

Specified by:

visitBefore in interface DOMVisitBefore

Parameters:

element - The DOM element being visited.

executionContext - Request relative instance.

Throws:

SmooksException - Element processing failure.

visitAfter

public void visitAfter(Element element,
                       ExecutionContext executionContext)
                throws SmooksException

Description copied from interface: DOMVisitAfter

Visit the supplied element after visiting its child elements.

Specified by:

visitAfter in interface DOMVisitAfter

Parameters:

element - The DOM element being visited.

executionContext - Request relative instance.

Throws:

SmooksException - Element processing failure.

count

public void count(ExecutionContext executionContext,
                  Fragment source)

getProducts

public Set<? extends Object> getProducts()

Description copied from interface: Producer

Get the set of products produced by this producer instance.

Specified by:

getProducts in interface Producer

Returns:

The set the set of products produced by this producer instance.