atg.commerce.pricing

Class PricingModelComparator

java.lang.Object

atg.commerce.pricing.PricingModelComparator

All Implemented Interfaces:

java.util.Comparator

public final class PricingModelComparator
extends java.lang.Object
implements java.util.Comparator

A comparator used for sorting pricing models by priority and optional secondary sort by repository id.
It accomplishes this by comparing the priority property of two pricing models (RepositoryItems).
The name of the priority property is configurable.
If they are equal then it compares the repository IDs instead to ensure a consistent sort order. Use of the repository IDs can be turned off via configuration or an alternate constructor.

Properties:

• pricingModelPriorityProperty is the name of the property by which the pricing models are sorted.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected boolean	mIncludeRepositoryId determines whether to include the repository ID as a secondary sort key
protected java.lang.String	mPricingModelPriorityProperty name of the pricing model priority property.

Constructor Summary

Constructors

Constructor and Description
PricingModelComparator() Default constructor.
PricingModelComparator(boolean pIncludeRepositoryId) Constructor used to override the default behavior of using repository IDs as a secondary sort key

Method Summary

Modifier and Type	Method and Description
int	compare(java.lang.Object o1, java.lang.Object o2) Compares two promotion items for sorting by priority and and optional secondary sort by repository ID.
boolean	equals(java.lang.Object obj)
boolean	getIncludeRepositoryId() Get property includeRepositoryId
java.lang.String	getPricingModelPriorityProperty() Get property PricingModelPriorityProperty
void	setIncludeRepositoryId(boolean pIncludeRepositoryId) Set property includeRepositoryId
void	setPricingModelPriorityProperty(java.lang.String pPricingModelPriorityProperty) Set property PricingModelPriorityProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mPricingModelPriorityProperty

protected java.lang.String mPricingModelPriorityProperty

name of the pricing model priority property.

mIncludeRepositoryId

protected boolean mIncludeRepositoryId

determines whether to include the repository ID as a secondary sort key

Constructor Detail

PricingModelComparator

public PricingModelComparator()

Default constructor.

PricingModelComparator

public PricingModelComparator(boolean pIncludeRepositoryId)

Constructor used to override the default behavior of using repository IDs as a secondary sort key

Parameters:

pIncludeRepositoryId - false to remove repository IDs from consideration as a secondary sort key

Method Detail

setPricingModelPriorityProperty

public void setPricingModelPriorityProperty(java.lang.String pPricingModelPriorityProperty)

Set property PricingModelPriorityProperty

Parameters:

pPricingModelPriorityProperty - new value to set

getPricingModelPriorityProperty

public java.lang.String getPricingModelPriorityProperty()

Get property PricingModelPriorityProperty

Returns:

PricingModelPriorityProperty

setIncludeRepositoryId

public void setIncludeRepositoryId(boolean pIncludeRepositoryId)

Set property includeRepositoryId

Parameters:

pIncludeRepositoryId - new value to set

getIncludeRepositoryId

public boolean getIncludeRepositoryId()

Get property includeRepositoryId

Returns:

includeRepositoryId

compare

public int compare(java.lang.Object o1,
                   java.lang.Object o2)

Compares two promotion items for sorting by priority
and and optional secondary sort by repository ID.

Specified by:

compare in interface java.util.Comparator

Parameters:

o1 - Promotion repository item

o2 - Promotion repository item

Returns:

int comparison result.

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Comparator

Overrides:

equals in class java.lang.Object