atg.commerce.pricing

Class Aggregator

java.lang.Object

atg.commerce.pricing.Aggregator

Direct Known Subclasses:

PropertyAggregator, SpendAmountAggregator

public abstract class Aggregator
extends java.lang.Object

Base abstract class for an aggregator.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected java.lang.String	mDecimalFormatString
protected java.lang.String	mWholeNumberFormatString

Constructor Summary

Constructors

Constructor and Description
Aggregator()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDecimalFormatString() Getter for the decimal format string
java.util.List<java.lang.String>	getOperations() Getter for the operations property, which is the list of operations that this aggregator supports.
java.lang.String	getOverrideProperty() Getter for the override property, which is the the name of the property that this aggregator is overriding (if any at all).
java.lang.String	getWholeNumberFormatString() Getter for the whole number format string
boolean	isValidOperation(java.lang.String pOperation) Returns true if the given operation is supported for the aggregator, false otherwise.
java.lang.String	parseToLocalizedValue(java.lang.String pValue, java.lang.Class<?> pType) Parses a string value and returns a localized string representation.
void	setDecimalFormatString(java.lang.String pDecimalFormatString) Setter for the decimal format string
void	setOperations(java.util.List<java.lang.String> pOperations) Setter for the aggregators property.
void	setOverrideProperty(java.lang.String pOverrideProperty) Setter for the override property.
void	setWholeNumberFormatString(java.lang.String pWholeNumberFormatString) Setter for the whole number format string

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mDecimalFormatString

protected java.lang.String mDecimalFormatString

mWholeNumberFormatString

protected java.lang.String mWholeNumberFormatString

Constructor Detail

Aggregator

public Aggregator()

Method Detail

setOperations

public void setOperations(java.util.List<java.lang.String> pOperations)

Setter for the aggregators property.

Parameters:

pOperations - map of aggregators

getOperations

public java.util.List<java.lang.String> getOperations()

Getter for the operations property, which is the list of operations that this aggregator supports.

Returns:

a map of aggregators

setOverrideProperty

public void setOverrideProperty(java.lang.String pOverrideProperty)

Setter for the override property.

Parameters:

pOverrideProperty - the name of the property that this aggregator is overriding (if any at all)

getOverrideProperty

public java.lang.String getOverrideProperty()

Getter for the override property, which is the the name of the property that this aggregator is overriding (if any at all).

Returns:

the name of the property that this aggregator is overriding (if any at all)

getDecimalFormatString

public java.lang.String getDecimalFormatString()

Getter for the decimal format string

Returns:

DecimalFormatString

setDecimalFormatString

public void setDecimalFormatString(java.lang.String pDecimalFormatString)

Setter for the decimal format string

Parameters:

pDecimalFormatString - String

getWholeNumberFormatString

public java.lang.String getWholeNumberFormatString()

Getter for the whole number format string

Returns:

WholeNumberFormatString

setWholeNumberFormatString

public void setWholeNumberFormatString(java.lang.String pWholeNumberFormatString)

Setter for the whole number format string

Parameters:

pWholeNumberFormatString - String

isValidOperation

public boolean isValidOperation(java.lang.String pOperation)

Returns true if the given operation is supported for the aggregator, false otherwise.

Parameters:

pOperation - the name of the operation to validate

Returns:

true if the operation is supported for the aggregator, false otherwise

parseToLocalizedValue

public java.lang.String parseToLocalizedValue(java.lang.String pValue,
                                     java.lang.Class<?> pType)
                                       throws java.lang.NumberFormatException

Parses a string value and returns a localized string representation. Does not round or have maximum fraction digits

Parameters:

pValue - value to be parsed

pType - class type of pValue

Returns:

parsed value

Throws:

java.lang.NumberFormatException - if pValue could not be parsed