IndexHandler.java

/*
 * 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.backend.api.finance;

import com.kapti.backend.api.MethodClass;
import com.kapti.data.Index;
import com.kapti.data.persistence.GenericDAO;
import com.kapti.exceptions.StockPlayException;
import com.kapti.filter.Filter;
import com.kapti.filter.parsing.Parser;
import java.util.Collection;
import java.util.HashMap;
import java.util.Vector;

/**
 * \brief   Handler van de Finance.Index subklasse.
 *
 * Deze klasse is de handler van de Finance.Index subklasse. Ze staat in
 * voor de verwerking van aanroepen van functies die zich in deze klasse
 * bevinden, lokaal de correcte aanvragen uit te voeren, en het resultaat
 * op conforme wijze terug te sturen.
 */
public class IndexHandler extends MethodClass {
    //
    // Methodes
    //

    public Vector<HashMap<String, Object>> List() throws StockPlayException {
        // Get DAO reference
        GenericDAO<com.kapti.data.Index, String> exDAO = getDAO().getIndexDAO();

        // Fetch and convert all exchanges
        Collection<com.kapti.data.Index> tExchanges = exDAO.findAll();
        Vector<HashMap<String, Object>> oVector = new Vector<HashMap<String, Object>>();
        for (com.kapti.data.Index tExchange : tExchanges) {
            oVector.add(tExchange.toStruct(
                    com.kapti.data.Index.Fields.ISIN,
                    com.kapti.data.Index.Fields.NAME,
                    com.kapti.data.Index.Fields.SYMBOL,
                    com.kapti.data.Index.Fields.EXCHANGE));
        }

        return oVector;
    }
    
    public Vector<HashMap<String, Object>> List(String iFilter) throws StockPlayException {
        // Get DAO reference
        GenericDAO<com.kapti.data.Index, String> tIndexDAO = getDAO().getIndexDAO();

        Parser parser = Parser.getInstance();
        Filter filter = parser.parse(iFilter);

        // Fetch and convert all exchanges
        Collection<com.kapti.data.Index> tIndexes = tIndexDAO.findByFilter(filter);
        Vector<HashMap<String, Object>> oVector = new Vector<HashMap<String, Object>>();
        for (com.kapti.data.Index tIndex : tIndexes) {
            oVector.add(tIndex.toStruct(
                    com.kapti.data.Index.Fields.ISIN,
                    com.kapti.data.Index.Fields.SYMBOL,
                    com.kapti.data.Index.Fields.NAME,
                    com.kapti.data.Index.Fields.EXCHANGE));
        }

        return oVector;
    }

    public int Modify(String iFilter, HashMap<String, Object> iDetails) throws StockPlayException {
        // Get DAO reference
        GenericDAO<com.kapti.data.Index, String> tIndexDAO = getDAO().getIndexDAO();

        // Get the Indexs we need to modify
        Collection<com.kapti.data.Index> tIndexs = tIndexDAO.findAll();

        // Now apply the new properties
        for (com.kapti.data.Index tIndex : tIndexs) {
            tIndex.applyStruct(iDetails);
            tIndexDAO.update(tIndex);
        }

        return 1;
    }

    public int Create(HashMap<String, Object> iDetails) throws StockPlayException {
        // Get DAO reference
        GenericDAO<com.kapti.data.Index, String> tIndexDAO = getDAO().getIndexDAO();

        // Instantiate a new index
        Index tIndex = Index.fromStruct(iDetails);

        tIndex.applyStruct(iDetails);
        return tIndexDAO.create(tIndex);

    }

    /*
     * TODO: een IndexSecurity klasse, die aan de gebruiker IndexSecurities
     * teruggeeft (cfr de Portfolio bij UserSecurities).
     *
     * Mogelijkheden
     * 1) XML-RPC geeft IndexSecurities terug, client doet dan nieuwe request
     * voor effectieve securities
     *
     * 2) Backend gaat automatisch de securities teruggeven. Minder requests,
     * maar minder flexibel (wat normaal 1 filter is moet nu opgesplitst worden
     * in verschillende functies, zoals ListSecurities(filter die index select)
     * en ListIndexes(filter die securities select).
     */
}