Catalog.java

/*
 * Copyright 2010-2011 Ning, Inc.
 *
 * Ning licenses this file to you under the Apache License, version 2.0
 * (the "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at:
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package com.ning.billing.catalog;

import java.net.URI;
import java.util.Collection;
import java.util.Date;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
import javax.xml.bind.annotation.XmlRootElement;

import com.ning.billing.catalog.api.ActionPolicy;
import com.ning.billing.catalog.api.BillingAlignment;
import com.ning.billing.catalog.api.BillingPeriod;
import com.ning.billing.catalog.api.Currency;
import com.ning.billing.catalog.api.ICatalog;
import com.ning.billing.catalog.api.IProduct;
import com.ning.billing.catalog.api.IllegalPlanChange;
import com.ning.billing.catalog.api.PlanAlignmentChange;
import com.ning.billing.catalog.api.PlanAlignmentCreate;
import com.ning.billing.catalog.api.PlanPhaseSpecifier;
import com.ning.billing.catalog.api.PlanSpecifier;
import com.ning.billing.catalog.rules.PlanRules;
import com.ning.billing.util.config.ValidatingConfig;
import com.ning.billing.util.config.ValidationError;
import com.ning.billing.util.config.ValidationErrors;
import com.ning.billing.catalog.api.PlanChangeResult;

@XmlRootElement
@XmlAccessorType(XmlAccessType.NONE)
public class Catalog extends ValidatingConfig<Catalog> implements ICatalog {
	@XmlElement(required=true)
	private Date effectiveDate;

	@XmlElement(required=true)
	private String catalogName;

	private URI catalogURI;

	@XmlElementWrapper(name="currencies", required=true)
	@XmlElement(name="currency", required=true)
	private Currency[] supportedCurrencies;

	@XmlElementWrapper(name="products", required=true)
	@XmlElement(name="product", required=true)
	private Product[] products;

	@XmlElement(name="rules", required=true)
	private PlanRules planRules;

	@XmlElementWrapper(name="plans", required=true)
	@XmlElement(name="plan", required=true)
	private Plan[] plans;

	@XmlElement(name="priceLists", required=true)
	private PriceListSet priceLists;

	public Catalog() {}

	protected Catalog (Date effectiveDate) {
		this.effectiveDate = effectiveDate;
	}

	/* (non-Javadoc)
	 * @see com.ning.billing.catalog.ICatalog#getCalalogName()
	 */
	@Override
	public String getCalalogName() {
		return catalogName;
	}

	/* (non-Javadoc)
	 * @see com.ning.billing.catalog.ICatalog#getProducts()
	 */
	@Override
	public Product[] getProducts() {
		return products;
	}

	/* (non-Javadoc)
	 * @see com.ning.billing.catalog.ICatalog#getPlan(java.lang.String, java.lang.String)
	 */
	@Override
	public Plan getPlan(String productName, BillingPeriod period, String priceListName) {
		IProduct product = getProductFromName(productName);
		return priceLists.getPlanListFrom(priceListName, product, period);
	}

	@Override
	public Currency[] getSupportedCurrencies() {
		return supportedCurrencies;
	}

	@Override
	public Plan[] getPlans() {
		return plans;
	}
	@Override
	public ActionPolicy getPlanChangePolicy(PlanPhaseSpecifier from, PlanSpecifier to) {
		return planRules.getPlanChangePolicy(from, to, this);
	}

	@Override
	public PlanAlignmentChange getPlanChangeAlignment(PlanPhaseSpecifier from, PlanSpecifier to) {
		return planRules.getPlanChangeAlignment(from, to, this);
	}

	@Override
	public ActionPolicy getPlanCancelPolicy(PlanPhaseSpecifier planPhase) {
		return planRules.getPlanCancelPolicy(planPhase, this);
	}

	@Override
	public PlanAlignmentCreate getPlanCreateAlignment(PlanSpecifier specifier) {
		return planRules.getPlanCreateAlignment(specifier, this);
	}

	@Override
	public BillingAlignment getBillingAlignment(PlanPhaseSpecifier planPhase) {
		return planRules.getBillingAlignment(planPhase, this);
	}


	@Override
	public Plan getPlanFromName(String name) {
		if (name == null) {
			return null;
		}
		for(Plan p : plans) {
			if(p.getName().equals(name)) {
				return p;
			}
		}
		return null;
	}

	@Override
	public IProduct getProductFromName(String name) {
		for(Product p : products) {
			if (p.getName().equals(name)) {
				return p;
			}
		}
		return null;
	}


	@Override
	public PlanPhase getPhaseFromName(String name) {

		if (name == null) {
			return null;
		}
		for(Plan p : plans) {

			if(p.getFinalPhase().getName().equals(name)) {
				return p.getFinalPhase();
			}
			if (p.getInitialPhases() != null) {
				for(PlanPhase pp : p.getInitialPhases()) {
					if(pp.getName().equals(name)) {
						return pp;
					}
				}
			}
		}

		return null;
	}

	@Override
	public Date getEffectiveDate() {
		return effectiveDate;
	}

	public void setEffectiveDate(Date effectiveDate) {
		this.effectiveDate = effectiveDate;
	}

	public URI getCatalogURI() {
		return catalogURI;
	}

	public PlanRules getPlanRules() { 
		return planRules;
	}

	public void setPlanRules(PlanRules planRules) {
		this.planRules = planRules;
	}

	@Override
	public PlanPhase getPhaseFor(String name, Date date) {
		if(getEffectiveDate().getTime() >= date.getTime()){
			return getPhaseFromName(name);
		}
		return null;
	}

	public void setPriceLists(PriceListSet priceLists) {
		this.priceLists = priceLists;
	}

	public PriceListSet getPriceLists() {
		return this.priceLists;
	}

	@Override
	public void configureEffectiveDate(Date date) {
		// Nothing to do here this is a method that is only inplemented on VersionedCatalog

	}

	public PriceList getPriceListFromName(String priceListName) {
		return priceLists.findPriceListFrom(priceListName);
	}

	@Override
	public PlanChangeResult planChange(PlanPhaseSpecifier from, PlanSpecifier to)
			throws IllegalPlanChange {
		return planRules.planChange(from, to, this);
	}

	@Override
	public ValidationErrors validate(Catalog catalog, ValidationErrors errors) {
		validate(catalog,errors, products);
		validate(catalog,errors, plans);
		priceLists.validate(catalog,errors);
		planRules.validate(catalog, errors);
		return errors;
	}

	private Collection<? extends ValidationError> validate(Catalog catalog,
			ValidationErrors errors, ValidatingConfig<Catalog>[] configs) {
		for(ValidatingConfig<Catalog> config: configs) {

		}
		return null;
	}
	

	@Override
	public void initialize(Catalog catalog, URI sourceURI) {
		catalogURI = sourceURI;
		super.initialize(catalog, sourceURI);
		planRules.initialize(catalog, sourceURI);
		priceLists.initialize(catalog, sourceURI);
		for(Product p : products) {
			p.initialize(catalog, sourceURI);
		}
		for(Plan p : plans) {
			p.initialize(catalog, sourceURI);
		}
	}


	protected Catalog setProducts(Product[] products) {
		this.products = products;
		return this;
	}
	protected Catalog setSupportedCurrencies(Currency[] supportedCurrencies) {
		this.supportedCurrencies = supportedCurrencies;
		return this;
	}

	protected Catalog setPlanChangeRules(PlanRules planChangeRules) {
		this.planRules = planChangeRules;
		return this;
	}

	protected Catalog setPlans(Plan[] plans) {
		this.plans = plans;
		return this;
	}


}