net.finmath.smartcontract.product.xml.SDCXMLParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of finmath-smart-derivative-contract Show documentation
Project to support the implementation a of smart derivative contract.
There is a newer version: 1.0.6
Show newest version
package net.finmath.smartcontract.product.xml;

import jakarta.xml.bind.JAXBContext;
import jakarta.xml.bind.JAXBException;
import jakarta.xml.bind.Marshaller;
import jakarta.xml.bind.Unmarshaller;
import net.finmath.smartcontract.model.ExceptionId;
import net.finmath.smartcontract.model.SDCException;
import net.finmath.smartcontract.product.SmartDerivativeContractDescriptor;
import net.finmath.smartcontract.valuation.marketdata.curvecalibration.CalibrationDataItem;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;

import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.StringReader;
import java.io.StringWriter;
import java.math.BigDecimal;
import java.nio.charset.StandardCharsets;
import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * A lean XML parser for the SDC XML format. See smartderivativecontract.xsd
 *
 * @author Christian Fries
 */
public class SDCXMLParser {

	private static final Logger logger = LoggerFactory.getLogger(SDCXMLParser.class);

	private SDCXMLParser() {
	}

	public static SmartDerivativeContractDescriptor parse(String sdcxml) throws ParserConfigurationException, IOException, SAXException {

		Smartderivativecontract sdc = unmarshalXml(sdcxml, Smartderivativecontract.class);

		LocalDateTime settlementDateInitial = LocalDateTime.parse(sdc.getSettlement().settlementDateInitial.trim());

		String uniqueTradeIdentifier = sdc.getUniqueTradeIdentifier().trim();
		String dltAddress = sdc.getDltAddress() == null ? "" : sdc.getDltAddress().trim();
		String dltTradeId = sdc.getDltTradeId() == null ? "" : sdc.getDltTradeId().trim();

		/*
		Market Data
		 */
		List marketdataItems = new ArrayList<>();
		for (Smartderivativecontract.Settlement.Marketdata.Marketdataitems.Item item : sdc.getSettlement().getMarketdata().getMarketdataitems().getItem()) {
			String symbol = item.getSymbol().get(0).trim();
			String curve = item.getCurve().get(0).trim();
			String type = item.getType().get(0).trim();
			String tenor = item.getTenor().get(0).trim();
			CalibrationDataItem.Spec spec = new CalibrationDataItem.Spec(symbol, curve, type, tenor);
			marketdataItems.add(spec);
		}

		/*
		 * Counterparties
		 */
		List parties = new ArrayList<>();
		Map marginAccountInitialByPartyID = new HashMap<>();
		Map penaltyFeeInitialByPartyID = new HashMap<>();

		for (Smartderivativecontract.Parties.Party p : sdc.getParties().getParty()) {
			SmartDerivativeContractDescriptor.Party party = new SmartDerivativeContractDescriptor.Party(
					p.getId().trim(),
					p.getName().trim(),
					null,
					p.getAddress().trim()
			);
			parties.add(party);
			marginAccountInitialByPartyID.put(party.getId(), p.getMarginAccount().getValue());
			penaltyFeeInitialByPartyID.put(party.getId(), p.getPenaltyFee().getValue());
		}

		// Receiver party ID
		String receiverPartyID = sdc.getReceiverPartyID().trim();

		// TODO The parser needs to check that the field receiverPartyID of the SDC matched the field  in the FPML

		// TODO Support multiple underlyings

		Document document = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(new ByteArrayInputStream(sdcxml.getBytes(StandardCharsets.UTF_8)));
		document.getDocumentElement().normalize();

		Node underlying = document
				.getElementsByTagName("underlying")
				.item(0)
				.getFirstChild();
		if (!underlying.getNodeName().contains("dataDocument")) {
			underlying = underlying.getNextSibling();
		}

		String currency = sdc.getSettlementCurrency();

		String marketDataProvider = sdc.getSettlement().getMarketdata().getProvider().trim();

		String tradeType = sdc.getTradeType();
		String initialSettlementDate = sdc.getSettlement().getSettlementDateInitial().trim();

		return new SmartDerivativeContractDescriptor(dltTradeId, dltAddress, uniqueTradeIdentifier, settlementDateInitial, parties, marginAccountInitialByPartyID, penaltyFeeInitialByPartyID, receiverPartyID, underlying, marketdataItems, currency, marketDataProvider, tradeType, initialSettlementDate);
	}

	public static  T unmarshalXml(String xml, Class t) {
		try {
			StringReader reader = new StringReader(xml);
			JAXBContext jaxbContext = JAXBContext.newInstance(t, BigDecimal.class);
			Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
			return (T) unmarshaller.unmarshal(reader);
		} catch (JAXBException e) {
			logger.error("unmarshalXml: jaxb error, ", e);
			throw new SDCException(ExceptionId.SDC_JAXB_ERROR, e.getMessage(), 400);
		}
	}

	/**
	 * Generic object-to-XML-string converter for all annotated classes
	 * @param t object to be converted to an XML string
	 * @return XML formatted String
	 * @param  generic Type, which has the correct XML bind annotations
	 */
	public static  String marshalClassToXMLString(T t) {
		try {
			JAXBContext jaxbContextSettlement = JAXBContext.newInstance(t.getClass());
			Marshaller jaxbMarshaller = jaxbContextSettlement.createMarshaller();
			if (t instanceof Smartderivativecontract)
				jaxbMarshaller.setProperty(Marshaller.JAXB_SCHEMA_LOCATION, "uri:sdc smartderivativecontract.xsd");
			StringWriter writer = new StringWriter();
			jaxbMarshaller.marshal(t, writer);
			return writer.toString();
		} catch (JAXBException e) {
			logger.error("marshalClassToXMLString: jaxb error, ", e);
			throw new SDCException(ExceptionId.SDC_JAXB_ERROR, e.getMessage(), 400);
		}
	}

	/**
	 * this version of an SDC-object-to-XML-string conversion includes text replacements to get rid of XML namespace tags like "fpml:dataDocument"
	 * @param smartderivativecontract SDC product data object which will be transformed into an XML string
	 * @return formatted xml string
	 */
	public static String marshalSDCToXMLString(Smartderivativecontract smartderivativecontract) {
		//TODO took over an old implementation, please review
		return marshalClassToXMLString(smartderivativecontract)
				.replaceAll("", "")
				.replaceAll("fpml:", "");
	}
}