UPI.java

package uk.ac.cam.cstibhotel.otcanalyser.trade;

/* 
 * This is a class to represent the UPI/taxonomy of a trade.
 * 
 * These have the format:
 * [Asset class]:[Base product]:[Sub-product]:[Transaction type]:[Settlement type]
 * 
 * Not every class of asset with have all of these fields filled - see the associated unit test
 * for more information
 */

public class UPI {
	
	private String fullTaxonomy;
	private AssetClass assetClass;
	private String baseProduct;
	private String subProduct;
	private String transactionType;
	private String settlementType;
	
	/*
	 * Splits a string containing a full taxonomy into its component parts to allow
	 * for easier access.
	 */	
	public UPI(String taxonomy) throws InvalidTaxonomyException, EmptyTaxonomyException {
		fullTaxonomy = taxonomy;
		
		taxonomy = taxonomy.replace(" ", "");
		
		if(taxonomy.equals("")) {
			throw new EmptyTaxonomyException();
		}
		
		String[] splitTaxonomy = taxonomy.split(":");
		
		int taxonomyLength = splitTaxonomy.length;
		
		try {
			// If the taxonomy splits into > 5 parts or < 2 parts, we can't treat it as valid
			if (taxonomyLength > 5 || taxonomyLength < 2) {
				throw new InvalidTaxonomyException(taxonomy);
			}
			
			// Set the fields dependent on asset class
			switch (splitTaxonomy[0]) {
			case "Commodity":
				assetClass = AssetClass.COMMODITY;
				baseProduct = splitTaxonomy[1];
				if (baseProduct.equals("Index") || baseProduct.equals("Freight")){
					if(taxonomyLength >= 3){
						transactionType = splitTaxonomy[2];
					}
					if(taxonomyLength >= 4){
						settlementType = splitTaxonomy[3];
					}
				}
				else{
					if(taxonomyLength >= 3){
						subProduct = splitTaxonomy[2];
					}
					if (taxonomyLength >= 4){
						transactionType = splitTaxonomy[3];
					}
					if (taxonomyLength >= 5){
						settlementType = splitTaxonomy[4];
					}
				}
				break;
			case "Credit":
				if (splitTaxonomy.length >= 5) {
					throw new InvalidTaxonomyException(taxonomy);
				}
				assetClass = AssetClass.CREDIT;
				baseProduct = splitTaxonomy[1];
				if (taxonomyLength >= 3){
					subProduct = splitTaxonomy[2];					
				}
				if (taxonomyLength >= 4){
					transactionType = splitTaxonomy[3];					
				}
				break;
			case "Equity":
				if (splitTaxonomy.length >= 5) {
					throw new InvalidTaxonomyException(taxonomy);
				}
				assetClass = AssetClass.EQUITY;
				baseProduct= splitTaxonomy[1];
				if (taxonomyLength >= 3){
					subProduct = splitTaxonomy[2];
					transactionType = splitTaxonomy[3];					
				}
				break;
			case "ForeignExchange":
				if (splitTaxonomy.length >= 4) {
					throw new InvalidTaxonomyException(taxonomy);
				}
				assetClass = AssetClass.FOREX;
				baseProduct= splitTaxonomy[1];
				if (splitTaxonomy.length >= 3) {
					subProduct = splitTaxonomy[2];
				}
				break;
			case "InterestRate":
				if (splitTaxonomy.length >= 4) {
					throw new InvalidTaxonomyException(taxonomy);
				}
				assetClass = AssetClass.RATES;
				baseProduct= splitTaxonomy[1];
				if (splitTaxonomy.length >= 3) {
					subProduct = splitTaxonomy[2];
				}
				break;
			default:
				throw new InvalidTaxonomyException(taxonomy);
			} 
		} catch (ArrayIndexOutOfBoundsException e) {
			throw new InvalidTaxonomyException(taxonomy);
		}
	}

	public String getFullTaxonomy() {
		return fullTaxonomy;
	}

	public void setFullTaxonomy(String fullTaxonomy) {
		this.fullTaxonomy = fullTaxonomy;
	}

	public AssetClass getAssetClass() {
		return assetClass;
	}

	public void setAssetClass(AssetClass assetClass) {
		this.assetClass = assetClass;
	}

	public String getBaseProduct() {
		return baseProduct;
	}

	public void setBaseProduct(String baseProduct) {
		this.baseProduct = baseProduct;
	}

	public String getSubProduct() {
		return subProduct;
	}

	public void setSubProduct(String subProduct) {
		this.subProduct = subProduct;
	}

	public String getTransactionType() {
		return transactionType;
	}

	public void setTransactionType(String transactionType) {
		this.transactionType = transactionType;
	}

	public String getSettlementType() {
		return settlementType;
	}

	public void setSettlementType(String settlementType) {
		this.settlementType = settlementType;
	}
	
}