Add PortfolioItem#withInfo for more easily updating the info/attribut…

…es on a collection of PortfolioItems (#2133)
OpenGamma · Feb 10, 2020 · fd976ae · fd976ae
1 parent b2b0b96
commit fd976ae
Show file tree

Hide file tree

Showing 63 changed files with 178 additions and 105 deletions.
diff --git a/modules/loader/src/test/java/com/opengamma/strata/loader/csv/TradeCsvLoaderTest.java b/modules/loader/src/test/java/com/opengamma/strata/loader/csv/TradeCsvLoaderTest.java
@@ -77,6 +77,7 @@
 import com.opengamma.strata.product.AttributeType;
 import com.opengamma.strata.product.GenericSecurity;
 import com.opengamma.strata.product.GenericSecurityTrade;
+import com.opengamma.strata.product.PortfolioItemInfo;
 import com.opengamma.strata.product.SecurityId;
 import com.opengamma.strata.product.SecurityInfo;
 import com.opengamma.strata.product.SecurityPriceInfo;
@@ -2002,7 +2003,7 @@ public Optional<Trade> parseOtherTrade(String typeUpper, CsvRow row, TradeInfo i
   public void test_load_unknownTypeFixedViaResolver() {
     Trade trade = new Trade() {
       @Override
-      public Trade withInfo(TradeInfo info) {
+      public Trade withInfo(PortfolioItemInfo info) {
         throw new UnsupportedOperationException();
       }
 
@@ -2032,7 +2033,7 @@ public Optional<Trade> parseOtherTrade(String typeUpper, CsvRow row, TradeInfo i
   public void test_load_overrideTypeViaResolver() {
     Trade trade = new Trade() {
       @Override
-      public Trade withInfo(TradeInfo info) {
+      public Trade withInfo(PortfolioItemInfo info) {
         throw new UnsupportedOperationException();
       }
 

diff --git a/modules/market/src/test/java/com/opengamma/strata/market/curve/DummyFraTrade.java b/modules/market/src/test/java/com/opengamma/strata/market/curve/DummyFraTrade.java
@@ -17,6 +17,7 @@
 import org.joda.beans.gen.PropertyDefinition;
 import org.joda.beans.impl.light.LightMetaBean;
 
+import com.opengamma.strata.product.PortfolioItemInfo;
 import com.opengamma.strata.product.ResolvedProduct;
 import com.opengamma.strata.product.ResolvedTrade;
 import com.opengamma.strata.product.Trade;
@@ -45,7 +46,7 @@ public TradeInfo getInfo() {
   }
 
   @Override
-  public Trade withInfo(TradeInfo info) {
+  public Trade withInfo(PortfolioItemInfo info) {
     return this;
   }
 

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/GenericSecurityPosition.java b/modules/product/src/main/java/com/opengamma/strata/product/GenericSecurityPosition.java
@@ -174,8 +174,8 @@ public double getQuantity() {
 
   //-------------------------------------------------------------------------
   @Override
-  public GenericSecurityPosition withInfo(PositionInfo info) {
-    return new GenericSecurityPosition(info, security, longQuantity, shortQuantity);
+  public GenericSecurityPosition withInfo(PortfolioItemInfo info) {
+    return new GenericSecurityPosition(PositionInfo.from(info), security, longQuantity, shortQuantity);
   }
 
   @Override

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/GenericSecurityTrade.java b/modules/product/src/main/java/com/opengamma/strata/product/GenericSecurityTrade.java
@@ -109,8 +109,8 @@ public GenericSecurity getProduct() {
 
   //-------------------------------------------------------------------------
   @Override
-  public GenericSecurityTrade withInfo(TradeInfo info) {
-    return new GenericSecurityTrade(info, security, quantity, price);
+  public GenericSecurityTrade withInfo(PortfolioItemInfo info) {
+    return new GenericSecurityTrade(TradeInfo.from(info), security, quantity, price);
   }
 
   @Override

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/PortfolioItem.java b/modules/product/src/main/java/com/opengamma/strata/product/PortfolioItem.java
@@ -43,6 +43,16 @@ public default Optional<StandardId> getId() {
     return getInfo().getId();
   }
 
+  /**
+   * Returns an instance with the specified info.
+   *
+   * @param info  the new info
+   * @return the instance with the specified info
+   */
+  public default PortfolioItem withInfo(PortfolioItemInfo info) {
+    throw new UnsupportedOperationException();
+  }
+
   /**
    * Summarizes the portfolio item.
    * <p>

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/Position.java b/modules/product/src/main/java/com/opengamma/strata/product/Position.java
@@ -65,7 +65,7 @@ public default PortfolioItemSummary summarize() {
    * @param info  the new info
    * @return the instance with the specified info
    */
-  public abstract Position withInfo(PositionInfo info);
+  public abstract Position withInfo(PortfolioItemInfo info);
 
   /**
    * Returns an instance with the specified quantity.

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/PositionInfo.java b/modules/product/src/main/java/com/opengamma/strata/product/PositionInfo.java
@@ -83,6 +83,16 @@ public static PositionInfo of(StandardId positionId) {
     return new PositionInfo(positionId, ImmutableMap.of());
   }
 
+  /**
+   * Obtains an instance based on the supplied info.
+   *
+   * @param info  the base info
+   * @return the position information
+   */
+  public static PositionInfo from(PortfolioItemInfo info) {
+    return empty().combinedWith(info);
+  }
+
   /**
    * Returns a builder used to create an instance of the bean.
    * 

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/ProductTrade.java b/modules/product/src/main/java/com/opengamma/strata/product/ProductTrade.java
@@ -32,6 +32,6 @@ public interface ProductTrade
    * @return the instance with the specified info
    */
   @Override
-  public abstract ProductTrade withInfo(TradeInfo info);
+  public abstract ProductTrade withInfo(PortfolioItemInfo info);
 
 }
diff --git a/modules/product/src/main/java/com/opengamma/strata/product/ResolvableSecurityPosition.java b/modules/product/src/main/java/com/opengamma/strata/product/ResolvableSecurityPosition.java
@@ -46,7 +46,7 @@ public interface ResolvableSecurityPosition
    * @return the instance with the specified info
    */
   @Override
-  public abstract ResolvableSecurityPosition withInfo(PositionInfo info);
+  public abstract ResolvableSecurityPosition withInfo(PortfolioItemInfo info);
 
   /**
    * Returns an instance with the specified quantity.

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/ResolvableSecurityTrade.java b/modules/product/src/main/java/com/opengamma/strata/product/ResolvableSecurityTrade.java
@@ -56,7 +56,7 @@ public default SecuritizedProductTrade<?> resolveTarget(ReferenceData refData) {
    * @return the instance with the specified info
    */
   @Override
-  public abstract ResolvableSecurityTrade withInfo(TradeInfo info);
+  public abstract ResolvableSecurityTrade withInfo(PortfolioItemInfo info);
 
   /**
    * Returns an instance with the specified quantity.

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/ResolvableTrade.java b/modules/product/src/main/java/com/opengamma/strata/product/ResolvableTrade.java
@@ -48,6 +48,6 @@ public interface ResolvableTrade<T extends ResolvedTrade>
    * @return the instance with the specified info
    */
   @Override
-  public abstract ResolvableTrade<T> withInfo(TradeInfo info);
+  public abstract ResolvableTrade<T> withInfo(PortfolioItemInfo info);
 
 }
diff --git a/modules/product/src/main/java/com/opengamma/strata/product/SecuritizedProductPosition.java b/modules/product/src/main/java/com/opengamma/strata/product/SecuritizedProductPosition.java
@@ -40,7 +40,7 @@ public default SecurityId getSecurityId() {
    * @return the instance with the specified info
    */
   @Override
-  public abstract SecuritizedProductPosition<P> withInfo(PositionInfo info);
+  public abstract SecuritizedProductPosition<P> withInfo(PortfolioItemInfo info);
 
   /**
    * Returns an instance with the specified quantity.

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/SecuritizedProductTrade.java b/modules/product/src/main/java/com/opengamma/strata/product/SecuritizedProductTrade.java
@@ -34,7 +34,7 @@ public interface SecuritizedProductTrade<P extends SecuritizedProduct>
    * @return the instance with the specified info
    */
   @Override
-  public abstract SecuritizedProductTrade<P> withInfo(TradeInfo info);
+  public abstract SecuritizedProductTrade<P> withInfo(PortfolioItemInfo info);
 
   /**
    * Returns an instance with the specified quantity.

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/SecurityPosition.java b/modules/product/src/main/java/com/opengamma/strata/product/SecurityPosition.java
@@ -172,8 +172,8 @@ public double getQuantity() {
 
   //-------------------------------------------------------------------------
   @Override
-  public SecurityPosition withInfo(PositionInfo info) {
-    return new SecurityPosition(info, securityId, longQuantity, shortQuantity);
+  public SecurityPosition withInfo(PortfolioItemInfo info) {
+    return new SecurityPosition(PositionInfo.from(info), securityId, longQuantity, shortQuantity);
   }
 
   @Override

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/SecurityQuantityTrade.java b/modules/product/src/main/java/com/opengamma/strata/product/SecurityQuantityTrade.java
@@ -32,7 +32,7 @@ public interface SecurityQuantityTrade
    * @return the instance with the specified info
    */
   @Override
-  public abstract SecurityQuantityTrade withInfo(TradeInfo info);
+  public abstract SecurityQuantityTrade withInfo(PortfolioItemInfo info);
 
   /**
    * Returns an instance with the specified quantity.

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/SecurityTrade.java b/modules/product/src/main/java/com/opengamma/strata/product/SecurityTrade.java
@@ -103,8 +103,8 @@ public PortfolioItemSummary summarize() {
 
   //-------------------------------------------------------------------------
   @Override
-  public SecurityTrade withInfo(TradeInfo info) {
-    return new SecurityTrade(info, securityId, quantity, price);
+  public SecurityTrade withInfo(PortfolioItemInfo info) {
+    return new SecurityTrade(TradeInfo.from(info), securityId, quantity, price);
   }
 
   @Override

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/Trade.java b/modules/product/src/main/java/com/opengamma/strata/product/Trade.java
@@ -43,6 +43,6 @@ public default PortfolioItemSummary summarize() {
    * @param info  the new info
    * @return the instance with the specified info
    */
-  public abstract Trade withInfo(TradeInfo info);
+  public abstract Trade withInfo(PortfolioItemInfo info);
 
 }
diff --git a/modules/product/src/main/java/com/opengamma/strata/product/TradeInfo.java b/modules/product/src/main/java/com/opengamma/strata/product/TradeInfo.java
@@ -113,6 +113,16 @@ public static TradeInfo of(LocalDate tradeDate) {
     return new TradeInfo(null, null, tradeDate, null, null, null, ImmutableMap.of());
   }
 
+  /**
+   * Obtains an instance based on the supplied info.
+   *
+   * @param info  the base info
+   * @return the trade information
+   */
+  public static TradeInfo from(PortfolioItemInfo info) {
+    return empty().combinedWith(info);
+  }
+
   /**
    * Returns a builder used to create an instance of the bean.
    * 
@@ -202,7 +212,7 @@ public TradeInfo overrideWith(PortfolioItemInfo other) {
 
   /**
    * Returns a builder populated with the values of this instance.
-   * 
+   *
    * @return a builder populated with the values of this instance
    */
   public TradeInfoBuilder toBuilder() {

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/bond/BillPosition.java b/modules/product/src/main/java/com/opengamma/strata/product/bond/BillPosition.java
@@ -27,6 +27,7 @@
 import com.opengamma.strata.basics.Resolvable;
 import com.opengamma.strata.basics.currency.Currency;
 import com.opengamma.strata.collect.ArgChecker;
+import com.opengamma.strata.product.PortfolioItemInfo;
 import com.opengamma.strata.product.PortfolioItemSummary;
 import com.opengamma.strata.product.PositionInfo;
 import com.opengamma.strata.product.ProductType;
@@ -150,8 +151,8 @@ public double getQuantity() {
 
   //-------------------------------------------------------------------------
   @Override
-  public BillPosition withInfo(PositionInfo info) {
-    return new BillPosition(info, product, longQuantity, shortQuantity);
+  public BillPosition withInfo(PortfolioItemInfo info) {
+    return new BillPosition(PositionInfo.from(info), product, longQuantity, shortQuantity);
   }
 
   @Override

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/bond/BillTrade.java b/modules/product/src/main/java/com/opengamma/strata/product/bond/BillTrade.java
@@ -27,6 +27,7 @@
 import com.opengamma.strata.basics.currency.CurrencyAmount;
 import com.opengamma.strata.basics.currency.Payment;
 import com.opengamma.strata.collect.ArgChecker;
+import com.opengamma.strata.product.PortfolioItemInfo;
 import com.opengamma.strata.product.PortfolioItemSummary;
 import com.opengamma.strata.product.ProductType;
 import com.opengamma.strata.product.ResolvableTrade;
@@ -144,8 +145,8 @@ private LocalDate calculateSettlementDate(ReferenceData refData) {
   }
 
   @Override
-  public BillTrade withInfo(TradeInfo info) {
-    return new BillTrade(info, product, quantity, price);
+  public BillTrade withInfo(PortfolioItemInfo info) {
+    return new BillTrade(TradeInfo.from(info), product, quantity, price);
   }
 
   @Override

diff --git a/...les/product/src/main/java/com/opengamma/strata/product/bond/BondFutureOptionPosition.java b/...les/product/src/main/java/com/opengamma/strata/product/bond/BondFutureOptionPosition.java
@@ -27,6 +27,7 @@
 import com.opengamma.strata.basics.Resolvable;
 import com.opengamma.strata.basics.currency.Currency;
 import com.opengamma.strata.collect.ArgChecker;
+import com.opengamma.strata.product.PortfolioItemInfo;
 import com.opengamma.strata.product.PortfolioItemSummary;
 import com.opengamma.strata.product.PositionInfo;
 import com.opengamma.strata.product.ProductType;
@@ -150,8 +151,8 @@ public double getQuantity() {
 
   //-------------------------------------------------------------------------
   @Override
-  public BondFutureOptionPosition withInfo(PositionInfo info) {
-    return new BondFutureOptionPosition(info, product, longQuantity, shortQuantity);
+  public BondFutureOptionPosition withInfo(PortfolioItemInfo info) {
+    return new BondFutureOptionPosition(PositionInfo.from(info), product, longQuantity, shortQuantity);
   }
 
   @Override

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/bond/BondFutureOptionTrade.java b/modules/product/src/main/java/com/opengamma/strata/product/bond/BondFutureOptionTrade.java
@@ -24,6 +24,7 @@
 
 import com.opengamma.strata.basics.ReferenceData;
 import com.opengamma.strata.collect.ArgChecker;
+import com.opengamma.strata.product.PortfolioItemInfo;
 import com.opengamma.strata.product.PortfolioItemSummary;
 import com.opengamma.strata.product.ProductType;
 import com.opengamma.strata.product.ResolvableTrade;
@@ -87,8 +88,8 @@ private static void applyDefaults(Builder builder) {
 
   //-------------------------------------------------------------------------
   @Override
-  public BondFutureOptionTrade withInfo(TradeInfo info) {
-    return new BondFutureOptionTrade(info, product, quantity, price);
+  public BondFutureOptionTrade withInfo(PortfolioItemInfo info) {
+    return new BondFutureOptionTrade(TradeInfo.from(info), product, quantity, price);
   }
 
   @Override

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/bond/BondFuturePosition.java b/modules/product/src/main/java/com/opengamma/strata/product/bond/BondFuturePosition.java
@@ -27,6 +27,7 @@
 import com.opengamma.strata.basics.Resolvable;
 import com.opengamma.strata.basics.currency.Currency;
 import com.opengamma.strata.collect.ArgChecker;
+import com.opengamma.strata.product.PortfolioItemInfo;
 import com.opengamma.strata.product.PortfolioItemSummary;
 import com.opengamma.strata.product.PositionInfo;
 import com.opengamma.strata.product.ProductType;
@@ -150,8 +151,8 @@ public double getQuantity() {
 
   //-------------------------------------------------------------------------
   @Override
-  public BondFuturePosition withInfo(PositionInfo info) {
-    return new BondFuturePosition(info, product, longQuantity, shortQuantity);
+  public BondFuturePosition withInfo(PortfolioItemInfo info) {
+    return new BondFuturePosition(PositionInfo.from(info), product, longQuantity, shortQuantity);
   }
 
   @Override

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/bond/BondFutureTrade.java b/modules/product/src/main/java/com/opengamma/strata/product/bond/BondFutureTrade.java
@@ -24,6 +24,7 @@
 
 import com.opengamma.strata.basics.ReferenceData;
 import com.opengamma.strata.collect.ArgChecker;
+import com.opengamma.strata.product.PortfolioItemInfo;
 import com.opengamma.strata.product.PortfolioItemSummary;
 import com.opengamma.strata.product.ProductType;
 import com.opengamma.strata.product.ResolvableTrade;
@@ -85,8 +86,8 @@ private static void applyDefaults(Builder builder) {
 
   //-------------------------------------------------------------------------
   @Override
-  public BondFutureTrade withInfo(TradeInfo info) {
-    return new BondFutureTrade(info, product, quantity, price);
+  public BondFutureTrade withInfo(PortfolioItemInfo info) {
+    return new BondFutureTrade(TradeInfo.from(info), product, quantity, price);
   }
 
   @Override

diff --git a/...s/product/src/main/java/com/opengamma/strata/product/bond/CapitalIndexedBondPosition.java b/...s/product/src/main/java/com/opengamma/strata/product/bond/CapitalIndexedBondPosition.java
@@ -27,6 +27,7 @@
 import com.opengamma.strata.basics.Resolvable;
 import com.opengamma.strata.basics.currency.Currency;
 import com.opengamma.strata.collect.ArgChecker;
+import com.opengamma.strata.product.PortfolioItemInfo;
 import com.opengamma.strata.product.PortfolioItemSummary;
 import com.opengamma.strata.product.PositionInfo;
 import com.opengamma.strata.product.ProductType;
@@ -150,8 +151,8 @@ public double getQuantity() {
 
   //-------------------------------------------------------------------------
   @Override
-  public CapitalIndexedBondPosition withInfo(PositionInfo info) {
-    return new CapitalIndexedBondPosition(info, product, longQuantity, shortQuantity);
+  public CapitalIndexedBondPosition withInfo(PortfolioItemInfo info) {
+    return new CapitalIndexedBondPosition(PositionInfo.from(info), product, longQuantity, shortQuantity);
   }
 
   @Override

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/bond/CapitalIndexedBondTrade.java b/modules/product/src/main/java/com/opengamma/strata/product/bond/CapitalIndexedBondTrade.java
@@ -27,6 +27,7 @@
 import com.opengamma.strata.basics.currency.Payment;
 import com.opengamma.strata.basics.schedule.SchedulePeriod;
 import com.opengamma.strata.collect.ArgChecker;
+import com.opengamma.strata.product.PortfolioItemInfo;
 import com.opengamma.strata.product.PortfolioItemSummary;
 import com.opengamma.strata.product.ProductType;
 import com.opengamma.strata.product.ResolvableTrade;
@@ -90,8 +91,8 @@ private static void applyDefaults(Builder builder) {
 
   //-------------------------------------------------------------------------
   @Override
-  public CapitalIndexedBondTrade withInfo(TradeInfo info) {
-    return new CapitalIndexedBondTrade(info, product, quantity, price);
+  public CapitalIndexedBondTrade withInfo(PortfolioItemInfo info) {
+    return new CapitalIndexedBondTrade(TradeInfo.from(info), product, quantity, price);
   }
 
   @Override

diff --git a/modules/product/src/main/java/com/opengamma/strata/product/bond/FixedCouponBondPosition.java b/modules/product/src/main/java/com/opengamma/strata/product/bond/FixedCouponBondPosition.java
@@ -27,6 +27,7 @@
 import com.opengamma.strata.basics.Resolvable;
 import com.opengamma.strata.basics.currency.Currency;
 import com.opengamma.strata.collect.ArgChecker;
+import com.opengamma.strata.product.PortfolioItemInfo;
 import com.opengamma.strata.product.PortfolioItemSummary;
 import com.opengamma.strata.product.PositionInfo;
 import com.opengamma.strata.product.ProductType;
@@ -150,8 +151,8 @@ public double getQuantity() {
 
   //-------------------------------------------------------------------------
   @Override
-  public FixedCouponBondPosition withInfo(PositionInfo info) {
-    return new FixedCouponBondPosition(info, product, longQuantity, shortQuantity);
+  public FixedCouponBondPosition withInfo(PortfolioItemInfo info) {
+    return new FixedCouponBondPosition(PositionInfo.from(info), product, longQuantity, shortQuantity);
   }
 
   @Override