Security.java

/*
 * Security.java
 * StockPlay - Effecten object.
 *
 * Copyright (c) 2010 StockPlay development team
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package com.kapti.client.finance;

import com.kapti.exceptions.StockPlayException;
import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeSupport;
import java.util.HashMap;
import org.apache.log4j.Logger;

/**
 *
 * \brief   Effecten object.
 *
 */

public class Security implements Cloneable {

    private static Logger logger = Logger.getLogger(Security.class);

    public static enum Fields {

        ISIN, SYMBOL, NAME, EXCHANGE, VISIBLE, SUSPENDED
    }

    public Security(String isin, String symbol, Exchange exchange, String name, boolean visible, boolean suspended) {
        this.ISIN = isin;
        this.symbol = symbol;
        this.exchange = exchange;
        this.name = name;
        this.visible = visible;
        this.suspended = suspended;
    }

    public Security(String isin, String symbol, Exchange exchange) {
        this.ISIN = isin;
        this.symbol = symbol;
        this.exchange = exchange;
    }
    /**
     * Deze variabele geeft aan of de waarden van het object werden gewijzigd
     */
    private boolean dirty = false;

    boolean isDirty() {
        return dirty;
    }

    void setDirty(boolean dirty) {
        this.dirty = dirty;
    }
    protected String ISIN;

    /**
     * Get the value of ISIN
     *
     * @return the value of ISIN
     */
    public String getISIN() {
        return ISIN;
    }
    protected String symbol;

    /**
     * Get the value of symbol
     *
     * @return the value of symbol
     */
    public String getSymbol() {
        return symbol;
    }
    protected Exchange exchange;

    /**
     * Get the value of exchange
     *
     * @return the value of exchange
     */
    public Exchange getExchange() {
        return exchange;
    }

    public void setExchange(Exchange exchange) {
        this.exchange = exchange;
    }
    protected String name;
    public static final String PROP_NAME = "name";

    /**
     * Get the value of name
     *
     * @return the value of name
     */
    public String getName() {
        return name;
    }

    /**
     * Set the value of name
     *
     * @param name new value of name
     */
    public void setName(String name) {
        String oldName = this.name;
        this.name = name;
        propertyChangeSupport.firePropertyChange(PROP_NAME, oldName, name);
        dirty = true;
    }
    private PropertyChangeSupport propertyChangeSupport = new PropertyChangeSupport(this);

    /**
     * Add PropertyChangeListener.
     *
     * @param listener
     */
    public void addPropertyChangeListener(PropertyChangeListener listener) {
        propertyChangeSupport.addPropertyChangeListener(listener);
    }

    /**
     * Remove PropertyChangeListener.
     *
     * @param listener
     */
    public void removePropertyChangeListener(PropertyChangeListener listener) {
        propertyChangeSupport.removePropertyChangeListener(listener);
    }
    protected boolean visible;
    public static final String PROP_VISIBLE = "visible";

    /**
     * Get the value of visible
     *
     * @return the value of visible
     */
    public boolean isVisible() {
        return visible;
    }

    /**
     * Set the value of visible
     *
     * @param visible new value of visible
     */
    public void setVisible(boolean visible) {
        boolean oldVisible = this.visible;
        this.visible = visible;
        propertyChangeSupport.firePropertyChange(PROP_VISIBLE, oldVisible, visible);
        dirty = true;
    }
    protected boolean suspended;
    public static final String PROP_SUSPENDED = "suspended";

    /**
     * Get the value of suspended
     *
     * @return the value of suspended
     */
    public boolean isSuspended() {
        return suspended;
    }

    /**
     * Set the value of suspended
     *
     * @param suspended new value of suspended
     */
    public void setSuspended(boolean suspended) {
        boolean oldSuspended = this.suspended;
        this.suspended = suspended;
        propertyChangeSupport.firePropertyChange(PROP_SUSPENDED, oldSuspended, suspended);
        dirty = true;
    }

//    public enum SecurityType {
//
//        Stock,
//        Fund,
//        Tracker;
//
//        @Override
//        public String toString() {
//            return super.toString();
//        }
//    }
//    protected SecurityType type = SecurityType.Stock;
//    public static final String PROP_TYPE = "type";
//
//    /**
//     * Get the value of type
//     *
//     * @return the value of type
//     */
//    public SecurityType getType() {
//        return type;
//    }
//
//    /**
//     * Set the value of type
//     *
//     * @param type new value of type
//     */
//    public void setType(SecurityType type) {
//        SecurityType oldType = this.type;
//        this.type = type;
//        propertyChangeSupport.firePropertyChange(PROP_TYPE, oldType, type);
//        dirty = true;
//    }

    @Override
    public boolean equals(Object obj) {
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final Security other = (Security) obj;
        if ((this.ISIN == null) ? (other.ISIN != null) : !this.ISIN.equals(other.ISIN)) {
            return false;
        }
        return true;
    }

    @Override
    public int hashCode() {
        int hash = 7;
        hash = 41 * hash + (this.ISIN != null ? this.ISIN.hashCode() : 0);
        return hash;
    }

    @Override
    public Object clone() throws CloneNotSupportedException {
        return super.clone();
    }

    public static Security fromStruct(HashMap h) {
        Exchange exch = null;
        try {
            exch = FinanceFactory.getInstance().getExchange((String)h.get(Fields.EXCHANGE.toString()));
        }catch(StockPlayException ex){
            logger.error(ex);
        }

        return new Security(
                (String) h.get(Security.Fields.ISIN.toString()),
                (String) h.get(Security.Fields.SYMBOL.toString()),
                exch,
                (String) h.get(Security.Fields.NAME.toString()),
                (Boolean) h.get(Security.Fields.VISIBLE.toString()),
                (Boolean) h.get(Security.Fields.SUSPENDED.toString()));
    }

    public HashMap toStruct(){

        HashMap h = new HashMap();
        h.put(Fields.ISIN.toString(), getISIN());
        h.put(Fields.EXCHANGE.toString(), getExchange().getSymbol());
        h.put(Fields.NAME.toString(), getName());
        h.put(Fields.SYMBOL.toString(), getSymbol());
        h.put(Fields.SUSPENDED.toString(), isSuspended());
        h.put(Fields.VISIBLE.toString(), isVisible());
        return h;


    }
}