Package org.isda.cdm
Class Lineage
- java.lang.Object
-
- com.rosetta.model.lib.RosettaModelObject
-
- org.isda.cdm.Lineage
-
@RosettaClass public class Lineage extends com.rosetta.model.lib.RosettaModelObject
A class to provide lineage information across lifecycle events through a pointer or set of pointers into the event(s), contract(s) and, possibly, payout components that the event is dependent on or relates to. As an example, if an inception event is corrected, the correction event will have a lineage into the initial event, which takes the form of a rosettaKey into that initial inception event. Two referencing mechanisms are provided as part of the CDM: either the rosettaKey, which corresponds to the hash value of the CDM class which is referred to, or a reference qualifier which is meant to provide support for the ingestion of xml documents with id/href mechanisms. The CDM recommends the use of the rosettaKey and provides a default implementation which is accessible in the generated code through org.isda.cdm.rosettakey.RosettaKeyValueHashFunction. If implementers want to use an alternative hashing mechanism, the API in which they need to plug it is com.rosetta.model.lib.HashFunction.- Version:
- 2.5.4
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Lineage.LineageBuilder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Lineage.LineageBuilder
builder()
boolean
equals(java.lang.Object o)
java.util.List<ReferenceWithMetaCashflow>
getCashflowReference()
The reference to the instantiation of a Cashflow payout component object.java.util.List<ReferenceWithMetaContract>
getContractReference()
The reference to the instantiation of a Contract object.java.util.List<ReferenceWithMetaCreditDefaultPayout>
getCreditDefaultPayoutReference()
The reference to the instantiation of a CreditdefaultPayout component object.java.util.List<ReferenceWithMetaEquityPayout>
getEquityPayoutReference()
The reference to the instantiation of a EquityPayout object.java.util.List<ReferenceWithMetaEvent>
getEventReference()
The reference to the instantiation of an Event object, either through a rosettaKey or an xml-derived id/href mechanism.java.util.List<ReferenceWithMetaExecution>
getExecutionReference()
The reference to the instantiation of a Execution object.java.util.List<ReferenceWithMetaInterestRatePayout>
getInterestRatePayoutReference()
The reference to the instantiation of a InterestRatePayout component object.java.util.List<ReferenceWithMetaLegalAgreement>
getLegalAgreement()
The reference to the instantiation of a Legal Agreement object.java.util.List<ReferenceWithMetaOptionPayout>
getOptionPayoutReference()
The reference to the instantiation of a OptionPayout component object.java.util.List<ReferenceWithMetaPortfolioState>
getPortfolioStateReference()
The refence to the previous state of a Portfolio, in a chain of Events leading up to a build of that Portfolio as the holding of Product(s) in specific Quantity(ies).java.util.List<ReferenceWithMetaTransferPrimitive>
getTransferReference()
The reference to the instantiation of a TransferPrimitive object.int
hashCode()
com.rosetta.model.lib.meta.RosettaMetaData<? extends Lineage>
metaData()
void
process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
Lineage.LineageBuilder
toBuilder()
java.lang.String
toString()
-
-
-
Method Detail
-
getCashflowReference
@RosettaSynonym(value="cashflowReference", source="Rosetta_Workbench") public final java.util.List<ReferenceWithMetaCashflow> getCashflowReference()
The reference to the instantiation of a Cashflow payout component object. An expected typical usage is to provide lineage for the payment of, say, the option premium or the swap initial fee. The definition associated to the Lineage class provides more details with respect to those referencing approaches, their expected usage and available implementation.
-
getContractReference
@RosettaSynonym(value="contractReference", source="Rosetta_Workbench") public final java.util.List<ReferenceWithMetaContract> getContractReference()
The reference to the instantiation of a Contract object. The definition associated to the Lineage class provides more details with respect to those referencing approaches, their expected usage and available implementation.
-
getCreditDefaultPayoutReference
@RosettaSynonym(value="creditDefaultReference", source="Rosetta_Workbench") public final java.util.List<ReferenceWithMetaCreditDefaultPayout> getCreditDefaultPayoutReference()
The reference to the instantiation of a CreditdefaultPayout component object. The definition associated to the Lineage class provides more details with respect to those referencing approaches, their expected usage and available implementation.
-
getEquityPayoutReference
@RosettaSynonym(value="equityPayoutReference", source="Rosetta_Workbench") public final java.util.List<ReferenceWithMetaEquityPayout> getEquityPayoutReference()
The reference to the instantiation of a EquityPayout object. An expected typical usage is to provide lineage for the payment of, say, an equity dividend. The definition associated to the Lineage class provides more details with respect to those referencing approaches, their expected usage and available implementation.
-
getEventReference
@RosettaSynonym(value="eventReference", source="Rosetta_Workbench") public final java.util.List<ReferenceWithMetaEvent> getEventReference()
The reference to the instantiation of an Event object, either through a rosettaKey or an xml-derived id/href mechanism. The definition associated to the Lineage class provides more details with respect to those referencing approaches, their expected usage and available implementation.
-
getExecutionReference
@RosettaSynonym(value="executionReference", source="Rosetta_Workbench") public final java.util.List<ReferenceWithMetaExecution> getExecutionReference()
The reference to the instantiation of a Execution object. The definition associated to the Lineage class provides more details with respect to those referencing approaches, their expected usage and available implementation.
-
getInterestRatePayoutReference
@RosettaSynonym(value="interestRatePayoutReference", source="Rosetta_Workbench") public final java.util.List<ReferenceWithMetaInterestRatePayout> getInterestRatePayoutReference()
The reference to the instantiation of a InterestRatePayout component object. An expected typical usage is to provide lineage for the payment of, say, an interest rate swap reset, with the ability to relate the gross cashflow amounts to the respective payout components. The definition associated to the Lineage class provides more details with respect to those referencing approaches, their expected usage and available implementation.
-
getLegalAgreement
public final java.util.List<ReferenceWithMetaLegalAgreement> getLegalAgreement()
The reference to the instantiation of a Legal Agreement object. The definition associated to the Lineage class provides more details with respect to those referencing approaches, their expected usage and available implementation.
-
getOptionPayoutReference
@RosettaSynonym(value="optionPayoutReference", source="Rosetta_Workbench") public final java.util.List<ReferenceWithMetaOptionPayout> getOptionPayoutReference()
The reference to the instantiation of a OptionPayout component object. The definition associated to the Lineage class provides more details with respect to those referencing approaches, their expected usage and available implementation.
-
getPortfolioStateReference
public final java.util.List<ReferenceWithMetaPortfolioState> getPortfolioStateReference()
The refence to the previous state of a Portfolio, in a chain of Events leading up to a build of that Portfolio as the holding of Product(s) in specific Quantity(ies). As part of the PortfolioState object, a pointer to the previous PortfolioState is provided through a Lineage object, together with pointer(s) to the Event or set of Events leading up to the current (new) state.
-
getTransferReference
@RosettaSynonym(value="transferReference", source="Rosetta_Workbench") public final java.util.List<ReferenceWithMetaTransferPrimitive> getTransferReference()
The reference to the instantiation of a TransferPrimitive object.
-
metaData
public com.rosetta.model.lib.meta.RosettaMetaData<? extends Lineage> metaData()
- Specified by:
metaData
in classcom.rosetta.model.lib.RosettaModelObject
-
toBuilder
public Lineage.LineageBuilder toBuilder()
- Specified by:
toBuilder
in classcom.rosetta.model.lib.RosettaModelObject
-
builder
public static Lineage.LineageBuilder builder()
-
process
public void process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
- Specified by:
process
in classcom.rosetta.model.lib.RosettaModelObject
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-