@barchart/portfolio-api-common 1.0.68 → 1.0.72

package/lib/data/PositionSummaryFrame.js

@@ -1,6 +1,7 @@
 const array = require('@barchart/common-js/lang/array'),
 	assert = require('@barchart/common-js/lang/assert'),
 	Day = require('@barchart/common-js/lang/Day'),
+	Decimal = require('@barchart/common-js/lang/Decimal'),
 	Enum = require('@barchart/common-js/lang/Enum'),
 	is = require('@barchart/common-js/lang/is');
 
@@ -16,23 +17,68 @@ module.exports = (() => {
 	 * @param {String} description
 	 * @param {Function} rangeCalculator
 	 * @param {Function} startDateCalculator
+	 * @param {Function} descriptionCalculator
 	 */
 	class PositionSummaryFrame extends Enum {
-		constructor(code, description, rangeCalculator, startDateCalculator) {
+		constructor(code, description, rangeCalculator, startDateCalculator, descriptionCalculator) {
 			super(code, description);
 
 			assert.argumentIsRequired(rangeCalculator, 'rangeCalculator', Function);
+			assert.argumentIsRequired(startDateCalculator, 'startDateCalculator', Function);
+			assert.argumentIsRequired(descriptionCalculator, 'descriptionCalculator', Function);
 
 			this._rangeCalculator = rangeCalculator;
 			this._startDateCalculator = startDateCalculator;
+			this._descriptionCalculator = descriptionCalculator;
 		}
 
+		/**
+		 * Returns a human-readable description of the frame, given
+		 * start and end dates.
+		 *
+		 * @public
+		 * @param {Day} startDate
+		 * @param {Day} endDate
+		 * @return {String}
+		 */
+		describeRange(startDate, endDate) {
+			return this._descriptionCalculator(startDate, endDate);
+		}
+
+		/**
+		 * Returns the most recent ranges for the frame.
+		 *
+		 * @public
+		 * @param {Number} periods
+		 * @returns {Array.<PositionSummaryRange>}
+		 */
+		getRecentRanges(periods) {
+			const startDate = this.getStartDate(periods);
+			const transaction = { date: startDate, snapshot: { open: Decimal.ONE } };
+
+			return this.getRanges([ transaction ]);
+		}
+
+		/**
+		 * Returns the ranges for the set of {@link Transaction} objects.
+		 *
+		 * @public
+		 * @param {Array.<Transaction>} transactions
+		 * @returns {Array.<PositionSummaryRange>}
+		 */
 		getRanges(transactions) {
 			assert.argumentIsArray(transactions, 'transactions');
 
 			return this._rangeCalculator(getFilteredTransactions(transactions));
 		}
 
+		/**
+		 * Returns the start date for a frame, a given number of periods ago.
+		 *
+		 * @public
+		 * @param {Number} periods
+		 * @returns {Day}
+		 */
 		getStartDate(periods) {
 			assert.argumentIsRequired(periods, 'periods', Number);
 
@@ -84,10 +130,19 @@ module.exports = (() => {
 		}
 	}
 
-	const yearly = new PositionSummaryFrame('YEARLY', 'year', getYearlyRanges, getYearlyStartDate);
-	const quarterly = new PositionSummaryFrame('QUARTER', 'quarter', getQuarterlyRanges, getQuarterlyStartDate);
-	const monthly = new PositionSummaryFrame('MONTH', 'month', getMonthlyRanges, getMonthlyStartDate);
-	const ytd = new PositionSummaryFrame('YTD', 'year-to-date', getYearToDateRanges, getYearToDateStartDate);
+	const yearly = new PositionSummaryFrame('YEARLY', 'year', getYearlyRanges, getYearlyStartDate, getYearlyRangeDescription);
+	const quarterly = new PositionSummaryFrame('QUARTER', 'quarter', getQuarterlyRanges, getQuarterlyStartDate, getQuarterlyRangeDescription);
+	const monthly = new PositionSummaryFrame('MONTH', 'month', getMonthlyRanges, getMonthlyStartDate, getMonthlyRangeDescription);
+	const ytd = new PositionSummaryFrame('YTD', 'year-to-date', getYearToDateRanges, getYearToDateStartDate, getYearToDateRangeDescription);
+
+	/**
+	 * The start and and date for a {@link PositionSummaryFrame}
+	 *
+	 * @typedef PositionSummaryRange
+	 * @type {Object}
+	 * @property {Day} start
+	 * @property {Day} end
+	 */
 
 	function getRange(start, end) {
 		return {
@@ -171,6 +226,22 @@ module.exports = (() => {
 		return null;
 	}
 
+	function getYearlyRangeDescription(startDate, endDate) {
+		return endDate.year.toString();
+	}
+
+	function getQuarterlyRangeDescription(startDate, endDate) {
+		return '';
+	}
+
+	function getMonthlyRangeDescription(startDate, endDate) {
+		return '';
+	}
+
+	function getYearToDateRangeDescription(startDate, endDate) {
+		return '';
+	}
+
 	function getFilteredTransactions(transactions) {
 		return transactions.reduce((filtered, transaction) => {
 			if (!transaction.snapshot.open.getIsZero() || transaction.type.closing) {

package/lib/processing/PositionContainer.js

@@ -6,7 +6,7 @@ const array = require('@barchart/common-js/lang/array'),
 	is = require('@barchart/common-js/lang/is'),
 	Tree = require('@barchart/common-js/collections/Tree');
 
-const InstrumentType = require('./../data/InstrumentType');
+const PositionSummaryFrame = require('./../data/PositionSummaryFrame');
 
 const PositionGroup = require('./PositionGroup'),
 	PositionItem = require('./PositionItem');
@@ -18,10 +18,13 @@ module.exports = (() => {
 	 * @public
 	 */
 	class PositionContainer {
-		constructor(portfolios, positions, summaries, definitions, defaultCurrency) {
+		constructor(portfolios, positions, summaries, definitions, defaultCurrency, summaryFrameType) {
 			this._definitions = definitions;
 			this._defaultCurrency = defaultCurrency || Currency.CAD;
 
+			this._summaryFrame = summaryFrameType || PositionSummaryFrame.YEARLY;
+			this._summaryRanges = this._summaryFrame.getRecentRanges(1);
+
 			this._portfolios = portfolios.reduce((map, portfolio) => {
 				map[portfolio.portfolio] = portfolio;
 
@@ -29,13 +32,19 @@ module.exports = (() => {
 			}, { });
 
 			this._summaries = summaries.reduce((map, summary) => {
-				const key = summary.position;
+				if (this._summaryFrame === summary.frame) {
+					const key = summary.position;
 
-				if (!map.hasOwnProperty(key)) {
-					map[key] = [ ];
-				}
+					if (!map.hasOwnProperty(key)) {
+						map[key] = getSummaryArray(this._summaryRanges);
+					}
 
-				map[key].push(summary);
+					const index = this._summaryRanges.findIndex(r => r.start.getIsEqual(summary.start.date) && r.end.getIsEqual(summary.end.date));
+
+					if (!(index < 0)) {
+						map[key][index] = summary;
+					}
+				}
 
 				return map;
 			}, { });
@@ -44,7 +53,7 @@ module.exports = (() => {
 				const portfolio = this._portfolios[position.portfolio];
 
 				if (position) {
-					const summaries = this._summaries[position.position] || [ ];
+					const summaries = this._summaries[position.position] || getSummaryArray(this._summaryRanges);
 
 					items.push(new PositionItem(portfolio, position, summaries));
 				}
@@ -100,13 +109,13 @@ module.exports = (() => {
 				const populatedGroups = Object.keys(populatedObjects).map(key => populatedObjects[key]).map((items) => {
 					const first = items[0];
 
-					return new PositionGroup(parent, items, currentDefinition.currencySelector(first), currentDefinition.descriptionSelector(first), currentDefinition.single && items.length === 1);
+					return new PositionGroup(this, parent, items, currentDefinition.currencySelector(first), currentDefinition.descriptionSelector(first), currentDefinition.single && items.length === 1);
 				});
 
 				const missingGroups = array.difference(currentDefinition.requiredGroups.map(group => group.description), populatedGroups.map(group => group.description));
 
 				const empty = missingGroups.map((description) => {
-					return new PositionGroup(parent, [ ], currentDefinition.requiredGroups.find(group => group.description === description).currency, description);
+					return new PositionGroup(this, parent, [ ], currentDefinition.requiredGroups.find(group => group.description === description).currency, description);
 				});
 
 				const compositeGroups = populatedGroups.concat(empty);
@@ -177,10 +186,20 @@ module.exports = (() => {
 			}, [ ]);
 		}
 
-		setExchangeRage(symbol, price) {
+		setExchangeRate(symbol, price) {
 
 		}
 
+		startTransaction(executor) {
+			assert.argumentIsRequired(executor, 'executor', Function);
+
+			this._tree.walk(group => group.setSuspended(true), false, false);
+
+			executor(this);
+
+			this._tree.walk(group => group.setSuspended(false), false, false);
+		}
+
 		getGroup(keys) {
 			const node = keys.reduce((tree, key) => {
 				tree = tree.findChild(group => group.description === key);
@@ -206,5 +225,9 @@ module.exports = (() => {
 		}
 	}
 
+	function getSummaryArray(ranges) {
+		return ranges.map(range => null);
+	}
+
 	return PositionContainer;
 })();

package/lib/processing/PositionGroup.js

@@ -11,7 +11,8 @@ module.exports = (() => {
 	 * @public
 	 */
 	class PositionGroup {
-		constructor(parent, items, currency, description, single) {
+		constructor(container, parent, items, currency, description, single) {
+			this._container = container;
 			this._parent = parent || null;
 
 			this._items = items;
@@ -21,24 +22,37 @@ module.exports = (() => {
 
 			this._single = is.boolean(single) && single;
 
+			this._excluded = false;
+			this._suspended = false;
+
 			this._dataFormat = { };
 			this._dataActual = { };
 			
 			this._dataFormat.description = this._description;
-
+			
 			this._dataActual.currentPrice = null;
 			this._dataActual.previousPrice = null;
 			this._dataActual.basis = null;
+			this._dataActual.realized = null;
+			this._dataActual.income = null;
 			this._dataActual.market = null;
 			this._dataActual.marketPercent = null;
 			this._dataActual.unrealizedToday = null;
+			this._dataActual.total = null;
+			this._dataActual.summaryOneTotal = null;
+			this._dataActual.summaryTwoTotal = null;
 
 			this._dataFormat.currentPrice = null;
 			this._dataFormat.previousPrice = null;
 			this._dataFormat.basis = null;
+			this._dataFormat.realized = null;
+			this._dataFormat.income = null;
 			this._dataFormat.market = null;
 			this._dataFormat.marketPercent = null;
 			this._dataFormat.unrealizedToday = null;
+			this._dataFormat.total = null;
+			this._dataFormat.summaryOneTotal = null;
+			this._dataFormat.summaryTwoTotal = null;
 
 			this._dataFormat.unrealizedTodayNegative = false;
 
@@ -52,12 +66,11 @@ module.exports = (() => {
 						this._dataFormat.currentPrice = null;
 					}
 
-					calculatePriceData(this, sender);
+					calculatePriceData(this, sender, false);
 				});
 			});
 
-			calculateStaticData(this);
-			calculatePriceData(this);
+			this.refresh();
 		}
 
 		get items() {
@@ -80,6 +93,41 @@ module.exports = (() => {
 			return this._single;
 		}
 
+		get suspended() {
+			return this._suspended;
+		}
+
+		get excluded() {
+			return this._excluded;
+		}
+
+		setExcluded(value) {
+			assert.argumentIsRequired(value, 'value', Boolean);
+
+			if (this._excluded !== value) {
+				this._container.startTransaction(() => {
+					this._items.forEach((item) => {
+						item.setExcluded(value);
+					});
+				});
+			}
+		}
+
+		setSuspended(value) {
+			assert.argumentIsRequired(value, 'value', Boolean);
+
+			if (this._suspended !== value) {
+				if (this._suspended = value) {
+					this.refresh();
+				}
+			}
+		}
+
+		refresh() {
+			calculateStaticData(this);
+			calculatePriceData(this, null, true);
+		}
+
 		toString() {
 			return '[PositionGroup]';
 		}
@@ -106,6 +154,10 @@ module.exports = (() => {
 	}
 
 	function calculateStaticData(group) {
+		if (group.suspended) {
+			return;
+		}
+
 		const actual = group._dataActual;
 		const format = group._dataFormat;
 
@@ -115,18 +167,38 @@ module.exports = (() => {
 
 		let updates = items.reduce((updates, item) => {
 			updates.basis = updates.basis.add(item.data.basis);
+			updates.realized = updates.realized.add(item.data.realized);
+			updates.income = updates.income.add(item.data.income);
+			updates.summaryOneTotal = updates.summaryOneTotal.add(item.data.summaryOneTotal);
+			updates.summaryTwoTotal = updates.summaryTwoTotal.add(item.data.summaryTwoTotal);
 
 			return updates;
 		}, {
-			basis: Decimal.ZERO
+			basis: Decimal.ZERO,
+			realized: Decimal.ZERO,
+			income: Decimal.ZERO,
+			summaryOneTotal: Decimal.ZERO,
+			summaryTwoTotal: Decimal.ZERO
 		});
 
 		actual.basis = updates.basis;
-	
-		format.basis = formatCurrency(updates.basis, currency);
+		actual.realized = updates.realized;
+		actual.income = updates.income;
+		actual.summaryOneTotal = updates.summaryOneTotal;
+		actual.summaryTwoTotal = updates.summaryTwoTotal;
+
+		format.basis = formatCurrency(actual.basis, currency);
+		format.realized = formatCurrency(actual.basis, currency);
+		format.income = formatCurrency(actual.income, currency);
+		format.summaryOneTotal = formatCurrency(updates.summaryOneTotal, currency);
+		format.summaryTwoTotal = formatCurrency(updates.summaryTwoTotal, currency);
 	}
 
-	function calculatePriceData(group, item) {
+	function calculatePriceData(group, item, forceRefresh) {
+		if (group.suspended) {
+			return;
+		}
+
 		const parent = group._parent;
 
 		const actual = group._dataActual;
@@ -134,9 +206,11 @@ module.exports = (() => {
 
 		const currency = group.currency;
 
+		const refresh = (is.boolean(forceRefresh) && forceRefresh) || (actual.market === null || actual.unrealizedToday === null || actual.total === null);
+
 		let updates;
 
-		if (actual.market === null || actual.unrealizedToday === null) {
+		if (refresh) {
 			const items = group._items;
 
 			updates = items.reduce((updates, item) => {
@@ -146,6 +220,7 @@ module.exports = (() => {
 				return updates;
 			}, {
 				market: Decimal.ZERO,
+
 				unrealizedToday: Decimal.ZERO
 			});
 		} else {
@@ -166,15 +241,17 @@ module.exports = (() => {
 		} else {
 			updates.marketPercent = null;
 		}
-		
+
 		actual.market = updates.market;
 		actual.marketPercent = updates.marketPercent;
 		actual.unrealizedToday = updates.unrealizedToday;
+		actual.total = updates.unrealizedToday.add(actual.realized).add(actual.income);
 		
-		format.market = formatCurrency(updates.market, currency);
-		format.marketPercent = formatPercent(updates.marketPercent, 2);
-		format.unrealizedToday = formatCurrency(updates.unrealizedToday, currency);
+		format.market = formatCurrency(actual.market, currency);
+		format.marketPercent = formatPercent(actual.marketPercent, 2);
+		format.unrealizedToday = formatCurrency(actual.unrealizedToday, currency);
 		format.unrealizedTodayNegative = actual.unrealizedToday.getIsNegative();
+		format.total = formatCurrency(actual.total, currency);
 	}
 
 	return PositionGroup;

package/lib/processing/PositionItem.js

@@ -30,10 +30,16 @@ module.exports = (() => {
 			this._data.unrealizedToday = null;
 			this._data.unrealizedTodayChange = null;
 
+			this._data.realized = null;
+			this._data.income = null;
+
+			this._excluded = false;
+
 			calculateStaticData(this);
 			calculatePriceData(this, null);
 
 			this._priceChangeEvent = new Event(this);
+			this._excludedChangeEvent = new Event(this);
 		}
 
 		get portfolio() {
@@ -52,7 +58,13 @@ module.exports = (() => {
 			return this._data;
 		}
 
+		get excluded() {
+			return this._excluded;
+		}
+
 		setPrice(price) {
+			assert.argumentIsRequired(price, 'price', Number);
+
 			if (this._data.price !== price) {
 				calculatePriceData(this, this._data.currentPrice = price);
 
@@ -60,12 +72,22 @@ module.exports = (() => {
 			}
 		}
 
-		registerPriceChangeHandler(handler) {
-			assert.argumentIsRequired(handler, 'handler', Function);
+		setExcluded(value) {
+			assert.argumentIsRequired(value, 'value', Boolean);
 
+			if (this._excluded !== value) {
+				this._excludedChangeEvent.fire(this, this._excluded = value);
+			}
+		}
+
+		registerPriceChangeHandler(handler) {
 			this._priceChangeEvent.register(handler);
 		}
 
+		registerExcludedChangeHandler(handler) {
+			this._excludedChangeEvent.register(handler);
+		}
+
 		toString() {
 			return '[PositionItem]';
 		}
@@ -74,6 +96,7 @@ module.exports = (() => {
 	function calculateStaticData(item) {
 		const position = item.position;
 		const snapshot = item.position.snapshot;
+		const summaries = item.summaries;
 
 		const data = item._data;
 
@@ -88,6 +111,26 @@ module.exports = (() => {
 		}
 
 		data.basis = basis;
+
+		data.realized = snapshot.gain;
+		data.income = snapshot.income;
+
+		const getSummaryTotal = (index) => {
+			let summaryTotal;
+
+			if (summaries.length > index && summaries[index] !== null) {
+				const period = summaries[index].period;
+
+				summaryTotal = period.realized.add(period.unrealized).add(period.income);
+			} else {
+				summaryTotal = Decimal.ZERO;
+			}
+
+			return summaryTotal;
+		};
+
+		data.summaryOneTotal = getSummaryTotal(0);
+		data.summaryTwoTotal = getSummaryTotal(1);
 	}
 
 	function calculatePriceData(item, price) {

package/lib/serialization/PortfolioSchema.js

@@ -155,6 +155,7 @@ module.exports = (() => {
 	);
 
 	const update = new PortfolioSchema(SchemaBuilder.withName('update')
+		.withField('portfolio', DataType.STRING)
 		.withField('name', DataType.STRING)
 		.withField('timezone', DataType.forEnum(Timezones, 'Timezone'), true)
 		.withField('defaults.currency', DataType.forEnum(Currency, 'Currency'), true)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.0.68",
+  "version": "1.0.72",
   "description": "Common classes used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",

package/test/SpecRunner.js

@@ -93,6 +93,7 @@ module.exports = (() => {
 const array = require('@barchart/common-js/lang/array'),
 	assert = require('@barchart/common-js/lang/assert'),
 	Day = require('@barchart/common-js/lang/Day'),
+	Decimal = require('@barchart/common-js/lang/Decimal'),
 	Enum = require('@barchart/common-js/lang/Enum'),
 	is = require('@barchart/common-js/lang/is');
 
@@ -108,23 +109,68 @@ module.exports = (() => {
 	 * @param {String} description
 	 * @param {Function} rangeCalculator
 	 * @param {Function} startDateCalculator
+	 * @param {Function} descriptionCalculator
 	 */
 	class PositionSummaryFrame extends Enum {
-		constructor(code, description, rangeCalculator, startDateCalculator) {
+		constructor(code, description, rangeCalculator, startDateCalculator, descriptionCalculator) {
 			super(code, description);
 
 			assert.argumentIsRequired(rangeCalculator, 'rangeCalculator', Function);
+			assert.argumentIsRequired(startDateCalculator, 'startDateCalculator', Function);
+			assert.argumentIsRequired(descriptionCalculator, 'descriptionCalculator', Function);
 
 			this._rangeCalculator = rangeCalculator;
 			this._startDateCalculator = startDateCalculator;
+			this._descriptionCalculator = descriptionCalculator;
+		}
+
+		/**
+		 * Returns a human-readable description of the frame, given
+		 * start and end dates.
+		 *
+		 * @public
+		 * @param {Day} startDate
+		 * @param {Day} endDate
+		 * @return {String}
+		 */
+		describeRange(startDate, endDate) {
+			return this._descriptionCalculator(startDate, endDate);
 		}
 
+		/**
+		 * Returns the most recent ranges for the frame.
+		 *
+		 * @public
+		 * @param {Number} periods
+		 * @returns {Array.<PositionSummaryRange>}
+		 */
+		getRecentRanges(periods) {
+			const startDate = this.getStartDate(periods);
+			const transaction = { date: startDate, snapshot: { open: Decimal.ONE } };
+
+			return this.getRanges([ transaction ]);
+		}
+
+		/**
+		 * Returns the ranges for the set of {@link Transaction} objects.
+		 *
+		 * @public
+		 * @param {Array.<Transaction>} transactions
+		 * @returns {Array.<PositionSummaryRange>}
+		 */
 		getRanges(transactions) {
 			assert.argumentIsArray(transactions, 'transactions');
 
 			return this._rangeCalculator(getFilteredTransactions(transactions));
 		}
 
+		/**
+		 * Returns the start date for a frame, a given number of periods ago.
+		 *
+		 * @public
+		 * @param {Number} periods
+		 * @returns {Day}
+		 */
 		getStartDate(periods) {
 			assert.argumentIsRequired(periods, 'periods', Number);
 
@@ -176,10 +222,19 @@ module.exports = (() => {
 		}
 	}
 
-	const yearly = new PositionSummaryFrame('YEARLY', 'year', getYearlyRanges, getYearlyStartDate);
-	const quarterly = new PositionSummaryFrame('QUARTER', 'quarter', getQuarterlyRanges, getQuarterlyStartDate);
-	const monthly = new PositionSummaryFrame('MONTH', 'month', getMonthlyRanges, getMonthlyStartDate);
-	const ytd = new PositionSummaryFrame('YTD', 'year-to-date', getYearToDateRanges, getYearToDateStartDate);
+	const yearly = new PositionSummaryFrame('YEARLY', 'year', getYearlyRanges, getYearlyStartDate, getYearlyRangeDescription);
+	const quarterly = new PositionSummaryFrame('QUARTER', 'quarter', getQuarterlyRanges, getQuarterlyStartDate, getQuarterlyRangeDescription);
+	const monthly = new PositionSummaryFrame('MONTH', 'month', getMonthlyRanges, getMonthlyStartDate, getMonthlyRangeDescription);
+	const ytd = new PositionSummaryFrame('YTD', 'year-to-date', getYearToDateRanges, getYearToDateStartDate, getYearToDateRangeDescription);
+
+	/**
+	 * The start and and date for a {@link PositionSummaryFrame}
+	 *
+	 * @typedef PositionSummaryRange
+	 * @type {Object}
+	 * @property {Day} start
+	 * @property {Day} end
+	 */
 
 	function getRange(start, end) {
 		return {
@@ -263,6 +318,22 @@ module.exports = (() => {
 		return null;
 	}
 
+	function getYearlyRangeDescription(startDate, endDate) {
+		return endDate.year.toString();
+	}
+
+	function getQuarterlyRangeDescription(startDate, endDate) {
+		return '';
+	}
+
+	function getMonthlyRangeDescription(startDate, endDate) {
+		return '';
+	}
+
+	function getYearToDateRangeDescription(startDate, endDate) {
+		return '';
+	}
+
 	function getFilteredTransactions(transactions) {
 		return transactions.reduce((filtered, transaction) => {
 			if (!transaction.snapshot.open.getIsZero() || transaction.type.closing) {
@@ -276,7 +347,7 @@ module.exports = (() => {
 	return PositionSummaryFrame;
 })();
 
-},{"@barchart/common-js/lang/Day":12,"@barchart/common-js/lang/Enum":15,"@barchart/common-js/lang/array":16,"@barchart/common-js/lang/assert":17,"@barchart/common-js/lang/is":19}],3:[function(require,module,exports){
+},{"@barchart/common-js/lang/Day":12,"@barchart/common-js/lang/Decimal":13,"@barchart/common-js/lang/Enum":15,"@barchart/common-js/lang/array":16,"@barchart/common-js/lang/assert":17,"@barchart/common-js/lang/is":19}],3:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
 	Enum = require('@barchart/common-js/lang/Enum');
 
@@ -612,7 +683,7 @@ const array = require('@barchart/common-js/lang/array'),
 	is = require('@barchart/common-js/lang/is'),
 	Tree = require('@barchart/common-js/collections/Tree');
 
-const InstrumentType = require('./../data/InstrumentType');
+const PositionSummaryFrame = require('./../data/PositionSummaryFrame');
 
 const PositionGroup = require('./PositionGroup'),
 	PositionItem = require('./PositionItem');
@@ -624,10 +695,13 @@ module.exports = (() => {
 	 * @public
 	 */
 	class PositionContainer {
-		constructor(portfolios, positions, summaries, definitions, defaultCurrency) {
+		constructor(portfolios, positions, summaries, definitions, defaultCurrency, summaryFrameType) {
 			this._definitions = definitions;
 			this._defaultCurrency = defaultCurrency || Currency.CAD;
 
+			this._summaryFrame = summaryFrameType || PositionSummaryFrame.YEARLY;
+			this._summaryRanges = this._summaryFrame.getRecentRanges(1);
+
 			this._portfolios = portfolios.reduce((map, portfolio) => {
 				map[portfolio.portfolio] = portfolio;
 
@@ -635,13 +709,19 @@ module.exports = (() => {
 			}, { });
 
 			this._summaries = summaries.reduce((map, summary) => {
-				const key = summary.position;
+				if (this._summaryFrame === summary.frame) {
+					const key = summary.position;
 
-				if (!map.hasOwnProperty(key)) {
-					map[key] = [ ];
-				}
+					if (!map.hasOwnProperty(key)) {
+						map[key] = getSummaryArray(this._summaryRanges);
+					}
 
-				map[key].push(summary);
+					const index = this._summaryRanges.findIndex(r => r.start.getIsEqual(summary.start.date) && r.end.getIsEqual(summary.end.date));
+
+					if (!(index < 0)) {
+						map[key][index] = summary;
+					}
+				}
 
 				return map;
 			}, { });
@@ -650,7 +730,7 @@ module.exports = (() => {
 				const portfolio = this._portfolios[position.portfolio];
 
 				if (position) {
-					const summaries = this._summaries[position.position] || [ ];
+					const summaries = this._summaries[position.position] || getSummaryArray(this._summaryRanges);
 
 					items.push(new PositionItem(portfolio, position, summaries));
 				}
@@ -706,13 +786,13 @@ module.exports = (() => {
 				const populatedGroups = Object.keys(populatedObjects).map(key => populatedObjects[key]).map((items) => {
 					const first = items[0];
 
-					return new PositionGroup(parent, items, currentDefinition.currencySelector(first), currentDefinition.descriptionSelector(first), currentDefinition.single && items.length === 1);
+					return new PositionGroup(this, parent, items, currentDefinition.currencySelector(first), currentDefinition.descriptionSelector(first), currentDefinition.single && items.length === 1);
 				});
 
 				const missingGroups = array.difference(currentDefinition.requiredGroups.map(group => group.description), populatedGroups.map(group => group.description));
 
 				const empty = missingGroups.map((description) => {
-					return new PositionGroup(parent, [ ], currentDefinition.requiredGroups.find(group => group.description === description).currency, description);
+					return new PositionGroup(this, parent, [ ], currentDefinition.requiredGroups.find(group => group.description === description).currency, description);
 				});
 
 				const compositeGroups = populatedGroups.concat(empty);
@@ -783,8 +863,18 @@ module.exports = (() => {
 			}, [ ]);
 		}
 
-		setExchangeRage(symbol, price) {
+		setExchangeRate(symbol, price) {
+
+		}
+
+		startTransaction(executor) {
+			assert.argumentIsRequired(executor, 'executor', Function);
 
+			this._tree.walk(group => group.setSuspended(true), false, false);
+
+			executor(this);
+
+			this._tree.walk(group => group.setSuspended(false), false, false);
 		}
 
 		getGroup(keys) {
@@ -812,10 +902,14 @@ module.exports = (() => {
 		}
 	}
 
+	function getSummaryArray(ranges) {
+		return ranges.map(range => null);
+	}
+
 	return PositionContainer;
 })();
 
-},{"./../data/InstrumentType":1,"./PositionGroup":5,"./PositionItem":7,"@barchart/common-js/collections/Tree":8,"@barchart/common-js/collections/sorting/ComparatorBuilder":9,"@barchart/common-js/collections/sorting/comparators":10,"@barchart/common-js/lang/Currency":11,"@barchart/common-js/lang/array":16,"@barchart/common-js/lang/assert":17,"@barchart/common-js/lang/is":19}],5:[function(require,module,exports){
+},{"./../data/PositionSummaryFrame":2,"./PositionGroup":5,"./PositionItem":7,"@barchart/common-js/collections/Tree":8,"@barchart/common-js/collections/sorting/ComparatorBuilder":9,"@barchart/common-js/collections/sorting/comparators":10,"@barchart/common-js/lang/Currency":11,"@barchart/common-js/lang/array":16,"@barchart/common-js/lang/assert":17,"@barchart/common-js/lang/is":19}],5:[function(require,module,exports){
 const assert = require('@barchart/common-js/lang/assert'),
 	Currency = require('@barchart/common-js/lang/Currency'),
 	Decimal = require('@barchart/common-js/lang/Decimal'),
@@ -829,7 +923,8 @@ module.exports = (() => {
 	 * @public
 	 */
 	class PositionGroup {
-		constructor(parent, items, currency, description, single) {
+		constructor(container, parent, items, currency, description, single) {
+			this._container = container;
 			this._parent = parent || null;
 
 			this._items = items;
@@ -839,24 +934,37 @@ module.exports = (() => {
 
 			this._single = is.boolean(single) && single;
 
+			this._excluded = false;
+			this._suspended = false;
+
 			this._dataFormat = { };
 			this._dataActual = { };
 			
 			this._dataFormat.description = this._description;
-
+			
 			this._dataActual.currentPrice = null;
 			this._dataActual.previousPrice = null;
 			this._dataActual.basis = null;
+			this._dataActual.realized = null;
+			this._dataActual.income = null;
 			this._dataActual.market = null;
 			this._dataActual.marketPercent = null;
 			this._dataActual.unrealizedToday = null;
+			this._dataActual.total = null;
+			this._dataActual.summaryOneTotal = null;
+			this._dataActual.summaryTwoTotal = null;
 
 			this._dataFormat.currentPrice = null;
 			this._dataFormat.previousPrice = null;
 			this._dataFormat.basis = null;
+			this._dataFormat.realized = null;
+			this._dataFormat.income = null;
 			this._dataFormat.market = null;
 			this._dataFormat.marketPercent = null;
 			this._dataFormat.unrealizedToday = null;
+			this._dataFormat.total = null;
+			this._dataFormat.summaryOneTotal = null;
+			this._dataFormat.summaryTwoTotal = null;
 
 			this._dataFormat.unrealizedTodayNegative = false;
 
@@ -870,12 +978,11 @@ module.exports = (() => {
 						this._dataFormat.currentPrice = null;
 					}
 
-					calculatePriceData(this, sender);
+					calculatePriceData(this, sender, false);
 				});
 			});
 
-			calculateStaticData(this);
-			calculatePriceData(this);
+			this.refresh();
 		}
 
 		get items() {
@@ -898,6 +1005,41 @@ module.exports = (() => {
 			return this._single;
 		}
 
+		get suspended() {
+			return this._suspended;
+		}
+
+		get excluded() {
+			return this._excluded;
+		}
+
+		setExcluded(value) {
+			assert.argumentIsRequired(value, 'value', Boolean);
+
+			if (this._excluded !== value) {
+				this._container.startTransaction(() => {
+					this._items.forEach((item) => {
+						item.setExcluded(value);
+					});
+				});
+			}
+		}
+
+		setSuspended(value) {
+			assert.argumentIsRequired(value, 'value', Boolean);
+
+			if (this._suspended !== value) {
+				if (this._suspended = value) {
+					this.refresh();
+				}
+			}
+		}
+
+		refresh() {
+			calculateStaticData(this);
+			calculatePriceData(this, null, true);
+		}
+
 		toString() {
 			return '[PositionGroup]';
 		}
@@ -924,6 +1066,10 @@ module.exports = (() => {
 	}
 
 	function calculateStaticData(group) {
+		if (group.suspended) {
+			return;
+		}
+
 		const actual = group._dataActual;
 		const format = group._dataFormat;
 
@@ -933,18 +1079,38 @@ module.exports = (() => {
 
 		let updates = items.reduce((updates, item) => {
 			updates.basis = updates.basis.add(item.data.basis);
+			updates.realized = updates.realized.add(item.data.realized);
+			updates.income = updates.income.add(item.data.income);
+			updates.summaryOneTotal = updates.summaryOneTotal.add(item.data.summaryOneTotal);
+			updates.summaryTwoTotal = updates.summaryTwoTotal.add(item.data.summaryTwoTotal);
 
 			return updates;
 		}, {
-			basis: Decimal.ZERO
+			basis: Decimal.ZERO,
+			realized: Decimal.ZERO,
+			income: Decimal.ZERO,
+			summaryOneTotal: Decimal.ZERO,
+			summaryTwoTotal: Decimal.ZERO
 		});
 
 		actual.basis = updates.basis;
-	
-		format.basis = formatCurrency(updates.basis, currency);
+		actual.realized = updates.realized;
+		actual.income = updates.income;
+		actual.summaryOneTotal = updates.summaryOneTotal;
+		actual.summaryTwoTotal = updates.summaryTwoTotal;
+
+		format.basis = formatCurrency(actual.basis, currency);
+		format.realized = formatCurrency(actual.basis, currency);
+		format.income = formatCurrency(actual.income, currency);
+		format.summaryOneTotal = formatCurrency(updates.summaryOneTotal, currency);
+		format.summaryTwoTotal = formatCurrency(updates.summaryTwoTotal, currency);
 	}
 
-	function calculatePriceData(group, item) {
+	function calculatePriceData(group, item, forceRefresh) {
+		if (group.suspended) {
+			return;
+		}
+
 		const parent = group._parent;
 
 		const actual = group._dataActual;
@@ -952,9 +1118,11 @@ module.exports = (() => {
 
 		const currency = group.currency;
 
+		const refresh = (is.boolean(forceRefresh) && forceRefresh) || (actual.market === null || actual.unrealizedToday === null || actual.total === null);
+
 		let updates;
 
-		if (actual.market === null || actual.unrealizedToday === null) {
+		if (refresh) {
 			const items = group._items;
 
 			updates = items.reduce((updates, item) => {
@@ -964,6 +1132,7 @@ module.exports = (() => {
 				return updates;
 			}, {
 				market: Decimal.ZERO,
+
 				unrealizedToday: Decimal.ZERO
 			});
 		} else {
@@ -984,15 +1153,17 @@ module.exports = (() => {
 		} else {
 			updates.marketPercent = null;
 		}
-		
+
 		actual.market = updates.market;
 		actual.marketPercent = updates.marketPercent;
 		actual.unrealizedToday = updates.unrealizedToday;
+		actual.total = updates.unrealizedToday.add(actual.realized).add(actual.income);
 		
-		format.market = formatCurrency(updates.market, currency);
-		format.marketPercent = formatPercent(updates.marketPercent, 2);
-		format.unrealizedToday = formatCurrency(updates.unrealizedToday, currency);
+		format.market = formatCurrency(actual.market, currency);
+		format.marketPercent = formatPercent(actual.marketPercent, 2);
+		format.unrealizedToday = formatCurrency(actual.unrealizedToday, currency);
 		format.unrealizedTodayNegative = actual.unrealizedToday.getIsNegative();
+		format.total = formatCurrency(actual.total, currency);
 	}
 
 	return PositionGroup;
@@ -1081,10 +1252,16 @@ module.exports = (() => {
 			this._data.unrealizedToday = null;
 			this._data.unrealizedTodayChange = null;
 
+			this._data.realized = null;
+			this._data.income = null;
+
+			this._excluded = false;
+
 			calculateStaticData(this);
 			calculatePriceData(this, null);
 
 			this._priceChangeEvent = new Event(this);
+			this._excludedChangeEvent = new Event(this);
 		}
 
 		get portfolio() {
@@ -1103,7 +1280,13 @@ module.exports = (() => {
 			return this._data;
 		}
 
+		get excluded() {
+			return this._excluded;
+		}
+
 		setPrice(price) {
+			assert.argumentIsRequired(price, 'price', Number);
+
 			if (this._data.price !== price) {
 				calculatePriceData(this, this._data.currentPrice = price);
 
@@ -1111,12 +1294,22 @@ module.exports = (() => {
 			}
 		}
 
-		registerPriceChangeHandler(handler) {
-			assert.argumentIsRequired(handler, 'handler', Function);
+		setExcluded(value) {
+			assert.argumentIsRequired(value, 'value', Boolean);
+
+			if (this._excluded !== value) {
+				this._excludedChangeEvent.fire(this, this._excluded = value);
+			}
+		}
 
+		registerPriceChangeHandler(handler) {
 			this._priceChangeEvent.register(handler);
 		}
 
+		registerExcludedChangeHandler(handler) {
+			this._excludedChangeEvent.register(handler);
+		}
+
 		toString() {
 			return '[PositionItem]';
 		}
@@ -1125,6 +1318,7 @@ module.exports = (() => {
 	function calculateStaticData(item) {
 		const position = item.position;
 		const snapshot = item.position.snapshot;
+		const summaries = item.summaries;
 
 		const data = item._data;
 
@@ -1139,6 +1333,26 @@ module.exports = (() => {
 		}
 
 		data.basis = basis;
+
+		data.realized = snapshot.gain;
+		data.income = snapshot.income;
+
+		const getSummaryTotal = (index) => {
+			let summaryTotal;
+
+			if (summaries.length > index && summaries[index] !== null) {
+				const period = summaries[index].period;
+
+				summaryTotal = period.realized.add(period.unrealized).add(period.income);
+			} else {
+				summaryTotal = Decimal.ZERO;
+			}
+
+			return summaryTotal;
+		};
+
+		data.summaryOneTotal = getSummaryTotal(0);
+		data.summaryTwoTotal = getSummaryTotal(1);
 	}
 
 	function calculatePriceData(item, price) {
@@ -5605,7 +5819,9 @@ describe('When a position container data is gathered', () => {
 			snapshot: {
 				basis: new Decimal(123),
 				value: new Decimal(456),
-				open: new Decimal(1)
+				open: new Decimal(1),
+				income: new Decimal(0),
+				gain: new Decimal(0)
 			}
 		}
 	}

package/test/specs/processing/PositionContainerSpec.js

@@ -25,7 +25,9 @@ describe('When a position container data is gathered', () => {
 			snapshot: {
 				basis: new Decimal(123),
 				value: new Decimal(456),
-				open: new Decimal(1)
+				open: new Decimal(1),
+				income: new Decimal(0),
+				gain: new Decimal(0)
 			}
 		}
 	}