Package org.cyclos.impl.banking

Class ARateTypeHandlerImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseNetworkedHandlerImpl

org.cyclos.impl.banking.BaseRateTypeHandlerImpl<Date,R,D>

org.cyclos.impl.banking.TimeBasedRateTypeHandlerImpl<ARateParameters,ARateParametersDTO>

org.cyclos.impl.banking.ARateTypeHandlerImpl

All Implemented Interfaces:

ARateTypeHandler, ARateTypeHandlerTestable, RateTypeHandler<Date,ARateParameters,ARateParametersDTO>, TimeBasedRateTypeHandler<ARateParameters,ARateParametersDTO>

@Component
public class ARateTypeHandlerImpl
extends TimeBasedRateTypeHandlerImpl<ARateParameters,ARateParametersDTO>
implements ARateTypeHandlerTestable

Nested Class Summary

Nested classes/interfaces inherited from class org.cyclos.impl.banking.BaseRateTypeHandlerImpl

BaseRateTypeHandlerImpl.RateParametersChangeAction

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Fields inherited from interface org.cyclos.impl.banking.RateTypeHandler

RATE_SCALE

Constructor Summary

Constructors

Constructor	Description
ARateTypeHandlerImpl()

Method Summary

Modifier and Type	Method	Description
protected void	assignEntityToCurrency(ARateParameters entity, Currency currency)	Assigns the RateParameters entity to the currency, so that the RateParameters entity becomes the new active RateParameters for this currency.
protected void	assignValidator(Validator currencyValidator, Validator rateParametersValidator)	sets specific checks to the RateParametersValidator, and assigns it as nested Validator to the currencyValidator.
protected BigDecimal	calculateRateChange(BigDecimal oldRate, Date oldDate, Date newDate)	Defines the business logic of rates developing over time.
void	complete(RatesData rates)	Completes the ratesData by calculating all missing fields of the rate (aRate, raw rate field).
Date	convert(BigDecimal rate, Date date)	Converts the nominal rate (as a BigDecimal) to the raw value
void	copy(HasRates source, HasRates destination)	Copies the rate field from source to destination
protected com.querydsl.core.types.Path	getAccountRatesFieldPath()	gets the path for the relevant field of the QAccountRates query.
protected ARateParameters	getCurrentRateParameters(Currency currency)
protected Class<ARateParameters>	getEntityClass()	gets the RateParameters class
Date	getNullSafeRawRate(RatedEntity entity, Currency currency, Date date)	Gets the rawRate from the entity in a null-safe way.
protected List<ARateParameters>	getParametersList()
protected QRateParameters	getQuery()	gets the QXRateParameters.xRateParameters of QueryDSL as a view of itself as the parent type.
ARateParameters	getRateParameters(Currency currency)	Gets the RateParameters from the Currency by simply calling the getter.
ARateParametersDTO	getRateParametersDTO(CurrencyDTO currencyDTO)	Gets the RateParametersDTO of the CurrencyDTO
RateType	getRateType()	Returns the rate type being handled
void	setRate(HasRates destination, BigDecimal rate)	Sets the rate to the destination object
void	setRawRate(RatedEntity destination, Date rawRate)	Sets the rawRate to the desitnation object.

Methods inherited from class org.cyclos.impl.banking.TimeBasedRateTypeHandlerImpl

adjustIncomingRawRateInTransfer, convert, convert, convert, getInitValue, hasEqualProperties

Methods inherited from class org.cyclos.impl.banking.BaseRateTypeHandlerImpl

applyIncomingTransfer, calculateFromRates, convert, getCreationValue, getEnableDate, getRateParameters, immediateDisableActions, inverseMerge, isEnabled, isVisible, isVisibleToUser, merge, nullAllAccountRates, resolveValidator, toEntity

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.impl.banking.ARateTypeHandlerTestable

merge

Methods inherited from interface org.cyclos.impl.banking.RateTypeHandler

applyIncomingTransfer, calculateFromRates, convert, getCreationValue, getEnableDate, getRateParameters, isEnabled, isVisible, isVisibleToUser, nullAllAccountRates, resolveValidator, toEntity

Methods inherited from interface org.cyclos.impl.banking.TimeBasedRateTypeHandler

convert, convert, getInitValue

Constructor Detail

ARateTypeHandlerImpl

public ARateTypeHandlerImpl()

Method Detail

complete

public void complete(RatesData rates)

Description copied from interface: RateTypeHandler

Completes the ratesData by calculating all missing fields of the rate (aRate, raw rate field). If both a rate and its raw value are present, the rate is overwritten with the value belonging to the raw value. So if ARate and EmissionDate are both present, A-rate is set to the value corresponding with EmissionDate.

Specified by:

complete in interface RateTypeHandler<Date,ARateParameters,ARateParametersDTO>

convert

public Date convert(BigDecimal rate,
                    Date date)

Description copied from interface: RateTypeHandler

Converts the nominal rate (as a BigDecimal) to the raw value

Specified by:

convert in interface RateTypeHandler<Date,ARateParameters,ARateParametersDTO>

Parameters:

rate - the input rate as a BigDecimal

date - the date at which this rate is valid. If null, current date/time is used.

Returns:

the raw rate as a java.util.Date.

copy

public void copy(HasRates source,
                 HasRates destination)

Description copied from interface: RateTypeHandler

Copies the rate field from source to destination

Specified by:

copy in interface RateTypeHandler<Date,ARateParameters,ARateParametersDTO>

getNullSafeRawRate

public Date getNullSafeRawRate(RatedEntity entity,
                               Currency currency,
                               Date date)

Description copied from interface: RateTypeHandler

Gets the rawRate from the entity in a null-safe way. That means: if the raw rate appears to be null, it checks if the rate is enabled, and if so, it gets the init value, if applicable.

Specified by:

getNullSafeRawRate in interface RateTypeHandler<Date,ARateParameters,ARateParametersDTO>

Parameters:

entity - the entity from which the raw rate is read

currency - is only used in case the entity has a null rate. In that case the init value is looked up on the entity.

date - is only used in case the entity has a null rate. If null, the present date is used (now).

getRateParameters

public ARateParameters getRateParameters(Currency currency)

Description copied from interface: RateTypeHandler

Gets the RateParameters from the Currency by simply calling the getter.

Specified by:

getRateParameters in interface RateTypeHandler<Date,ARateParameters,ARateParametersDTO>

getRateParametersDTO

public ARateParametersDTO getRateParametersDTO(CurrencyDTO currencyDTO)

Description copied from interface: RateTypeHandler

Gets the RateParametersDTO of the CurrencyDTO

Specified by:

getRateParametersDTO in interface RateTypeHandler<Date,ARateParameters,ARateParametersDTO>

getRateType

public RateType getRateType()

Description copied from interface: RateTypeHandler

Returns the rate type being handled

Specified by:

getRateType in interface RateTypeHandler<Date,ARateParameters,ARateParametersDTO>

setRate

public void setRate(HasRates destination,
                    BigDecimal rate)

Description copied from interface: RateTypeHandler

Sets the rate to the destination object

Specified by:

setRate in interface RateTypeHandler<Date,ARateParameters,ARateParametersDTO>

setRawRate

public void setRawRate(RatedEntity destination,
                       Date rawRate)

Description copied from interface: RateTypeHandler

Sets the rawRate to the desitnation object.

Specified by:

setRawRate in interface RateTypeHandler<Date,ARateParameters,ARateParametersDTO>

assignEntityToCurrency

protected void assignEntityToCurrency(ARateParameters entity,
                                      Currency currency)

Description copied from class: BaseRateTypeHandlerImpl

Assigns the RateParameters entity to the currency, so that the RateParameters entity becomes the new active RateParameters for this currency. Note that the method only calls the currency's setter. See BaseRateTypeHandlerImpl.appendToRateParametersHistory(D,org.cyclos.entities.banking.Currency) for other actions to be taken.

Specified by:

assignEntityToCurrency in class BaseRateTypeHandlerImpl<Date,ARateParameters,ARateParametersDTO>

assignValidator

protected void assignValidator(Validator currencyValidator,
                               Validator rateParametersValidator)

Description copied from class: BaseRateTypeHandlerImpl

sets specific checks to the RateParametersValidator, and assigns it as nested Validator to the currencyValidator.

Specified by:

assignValidator in class BaseRateTypeHandlerImpl<Date,ARateParameters,ARateParametersDTO>

calculateRateChange

protected BigDecimal calculateRateChange(BigDecimal oldRate,
                                         Date oldDate,
                                         Date newDate)

Defines the business logic of rates developing over time. Gives the new rate, on basis of the old rate, the old date, and the new date.
To calculate the rate from the stored emission date, use

 actualARate = calculateRateChange(BigDecimal.ZERO, emissionDate, actualDate);
 

Specified by:

calculateRateChange in class TimeBasedRateTypeHandlerImpl<ARateParameters,ARateParametersDTO>

Parameters:

oldRate - a BigDecimal representing the old rate.

oldDate - the java.util.Date belonging to oldRate

newDate - the java.util.Date for which the new Rate is requested

Returns:

the new rate belonging to newDate.

getAccountRatesFieldPath

protected com.querydsl.core.types.Path getAccountRatesFieldPath()

Description copied from class: BaseRateTypeHandlerImpl

gets the path for the relevant field of the QAccountRates query. For example, returns for A-rate the QAccountRates.emissionDate field path.

Specified by:

getAccountRatesFieldPath in class BaseRateTypeHandlerImpl<Date,ARateParameters,ARateParametersDTO>

Returns:

getCurrentRateParameters

protected ARateParameters getCurrentRateParameters(Currency currency)

Specified by:

getCurrentRateParameters in class BaseRateTypeHandlerImpl<Date,ARateParameters,ARateParametersDTO>

getEntityClass

protected Class<ARateParameters> getEntityClass()

Description copied from class: BaseRateTypeHandlerImpl

gets the RateParameters class

Specified by:

getEntityClass in class BaseRateTypeHandlerImpl<Date,ARateParameters,ARateParametersDTO>

getParametersList

protected List<ARateParameters> getParametersList()

Specified by:

getParametersList in class BaseRateTypeHandlerImpl<Date,ARateParameters,ARateParametersDTO>

getQuery

protected QRateParameters getQuery()

Description copied from class: BaseRateTypeHandlerImpl

gets the QXRateParameters.xRateParameters of QueryDSL as a view of itself as the parent type. So for A-Rate, it gets QARateParametes.aRateParameters as QRateParameters. This is useful for queries on RateParameters for fields which are general for all rate types.

Specified by:

getQuery in class BaseRateTypeHandlerImpl<Date,ARateParameters,ARateParametersDTO>