org.salespointframework.accountancy

Class PersistentAccountancy

java.lang.Object

org.salespointframework.accountancy.PersistentAccountancy

All Implemented Interfaces:

Accountancy

@Service
 @Transactional
class PersistentAccountancy
extends Object
implements Accountancy

This class represents an accountancy. An accountancy aggregates of AccountancyEntrys.

Author:

Hannes Weisbach, Thomas Dedek, Oliver Gierke

Constructor Summary

Constructors

Constructor and Description
PersistentAccountancy(BusinessTime businessTime, AccountancyEntryRepository repository)

Method Summary

Modifier and Type	Method and Description
<T extends AccountancyEntry> T	add(T accountancyEntry) Adds a new AccountancyEntry to this Accountancy.
Streamable<AccountancyEntry>	find(Interval interval) Returns all AccountancyEntrys that were created in the given Interval.
Map<Interval,Streamable<AccountancyEntry>>	find(Interval interval, TemporalAmount duration) Returns all AccountancyEntrys which have their date within the given Interval.
Streamable<AccountancyEntry>	findAll() Returns all AccountancyEntrys of the specified type clazz and all sub-types, previously added to the accountancy.
Optional<AccountancyEntry>	get(AccountancyEntryIdentifier accountancyEntryIdentifier) Returns the AccountancyEntry of type clazz and all sub-types, identified by AccountancyEntryIdentifier.
Map<Interval,javax.money.MonetaryAmount>	salesVolume(Interval interval, TemporalAmount duration) Returns the sum of the field amount of all AccountancyEntrys which have their date within (including) from and to.

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistentAccountancy

@ConstructorProperties(value={"businessTime","repository"})
 @Generated(value="lombok")
public PersistentAccountancy(@NonNull
                                                                                                                     BusinessTime businessTime,
                                                                                                                     @NonNull
                                                                                                                     AccountancyEntryRepository repository)

Method Detail

add

public final <T extends AccountancyEntry> T add(T accountancyEntry)

Description copied from interface: Accountancy

Adds a new AccountancyEntry to this Accountancy.

Specified by:

add in interface Accountancy

Parameters:

accountancyEntry - entry to be added to the accountancy

get

public final Optional<AccountancyEntry> get(AccountancyEntryIdentifier accountancyEntryIdentifier)

Description copied from interface: Accountancy

Returns the AccountancyEntry of type clazz and all sub-types, identified by AccountancyEntryIdentifier. null is returned, if no entry with the given identifier exists.

Specified by:

get in interface Accountancy

Parameters:

accountancyEntryIdentifier - the AccountancyEntryIdentifier of the entry to be returned

Returns:

the AccountancyEntry or sub type thereof of type clazz which has the identifier AccountancyEntryIdentifier

findAll

public final Streamable<AccountancyEntry> findAll()

Description copied from interface: Accountancy

Returns all AccountancyEntrys of the specified type clazz and all sub-types, previously added to the accountancy. If no entries of the specified type exist, an empty Iterable is returned.

Specified by:

findAll in interface Accountancy

Returns:

a Streamable containing all entries of type clazz

find

public final Streamable<AccountancyEntry> find(Interval interval)

Description copied from interface: Accountancy

Returns all AccountancyEntrys that were created in the given Interval. So every entry with an time stamp <= to and >= from is returned. If no entries within the specified time span exist, or no entries of the specified class type exist, an empty Streamable is returned.

Specified by:

find in interface Accountancy

Parameters:

interval - the Interval we want to find AccountancyEntry instances for.

Returns:

a Streamable containing all entries in the given Interval.

find

public final Map<Interval,Streamable<AccountancyEntry>> find(Interval interval,
                                                             TemporalAmount duration)

Description copied from interface: Accountancy

Returns all AccountancyEntrys which have their date within the given Interval. The Interval is divided into parts of length of the given Duration. According to their respective date, entries are sorted in exactly one of the time intervals. The last time interval may be shorter than the given Duration. Returned is a map, having a Interval objects as its key, and an Streamable as value. The Streamable contains all entries of the specific type with its date in the interval specified by the key.

Specified by:

find in interface Accountancy

duration - length of the time intervals, the period between from and to is divided

Returns:

a map, with intervals of period length between from and to as keys, and as value an Iterable containing all entries within the key- Interval

salesVolume

public final Map<Interval,javax.money.MonetaryAmount> salesVolume(Interval interval,
                                                                  TemporalAmount duration)

Description copied from interface: Accountancy

Returns the sum of the field amount of all AccountancyEntrys which have their date within (including) from and to.
The time between from and to is divided into parts of period length. According to their time stamp, entries are sorted in exactly one of the time intervals. The last time interval may be shorter than period.
Returned is a map, having a Interval objects as its key, and a MonetaryAmount as value. The MonetaryAmount object's value is equal to the sum of all entries' amount-field, with a date within the key- Interval. If within an interval no entries of the specified type exist, a MonetaryAmount object with a value of zero is added as value for that interval.

Specified by:

salesVolume in interface Accountancy

duration - length of the time intervals, the period between from and to is divided.

Returns:

a Map, with intervals of period length between from and to as keys, and as value a MonetaryAmount object, equal to the sum of the amount fields of all entries within the key- Interval.