/**************************************************************************
 * AssignItemToSlot
 *
 * $Workfile$
 * $Revision: 1.8 $
 * $Date: 2004/10/21 08:02:19 $
 *
 * Copyright (C) 2001 CERN - European Organization for Nuclear Research
 * All rights reserved.
 **************************************************************************/

package com.c2kernel.lifecycle.instance.predefined;


import java.util.Arrays;

import com.c2kernel.collection.Aggregation;
import com.c2kernel.common.InvalidDataException;
import com.c2kernel.common.ObjectNotFoundException;
import com.c2kernel.entity.C2KLocalObject;
import com.c2kernel.lookup.AgentPath;
import com.c2kernel.lookup.ItemPath;
import com.c2kernel.persistency.ClusterStorage;
import com.c2kernel.persistency.ClusterStorageException;
import com.c2kernel.process.Gateway;
import com.c2kernel.property.PropertyDescription;
import com.c2kernel.property.PropertyDescriptionList;
import com.c2kernel.property.PropertyUtility;
import com.c2kernel.utils.CastorHashMap;
import com.c2kernel.utils.Logger;

/**************************************************************************
 *
 * @author $Author: abranson $ $Date: 2004/10/21 08:02:19 $
 * @version $Revision: 1.8 $
 **************************************************************************/
public class AddNewSlot extends PredefinedStep
{
    /**************************************************************************
    * Constructor for Castor
    **************************************************************************/
    public AddNewSlot()
    {
        super();
    }


    /**
     * Creates a new slot in the given aggregation, that holds instances of the given item description
     * 
     * Params:
     * <ol><li>Collection name</li>
     * <li>Item Description key (optional)</li>
     * <li>Item Description version (optional)</li>
     * </ol>
     */
    @Override
	protected String runActivityLogic(AgentPath agent, ItemPath item,
			int transitionID, String requestData) throws InvalidDataException {
    	
        String collName;
        ItemPath descKey = null;
        String descVer = "last";
        Aggregation agg;

        // extract parameters
        String[] params = getDataList(requestData);
        if (Logger.doLog(3)) Logger.msg(3, "AddNewSlot: called by "+agent+" on "+item+" with parameters "+Arrays.toString(params));

        // resolve desc item path and version
        try {
            collName = params[0];
            if (params.length > 1 && params[1].length() > 0) descKey = new ItemPath(params[1]);
            if (params.length > 2 && params[2].length() > 0) descVer = params[2];
        } catch (Exception e) {
            throw new InvalidDataException("AddNewSlot: Invalid parameters "+Arrays.toString(params), "");
        }

        // load collection
    	C2KLocalObject collObj;
		try {
			collObj = Gateway.getStorage().get(item, ClusterStorage.COLLECTION+"/"+collName+"/last", null);
		} catch (ObjectNotFoundException ex) {
			throw new InvalidDataException("AddNewSlot: Collection '"+collName+"' not found in this Item", "");
		} catch (ClusterStorageException ex) {
			Logger.error(ex);
			throw new InvalidDataException("AddNewSlot: Error loading collection '\"+collName+\"': "+ex.getMessage(), "");
		}
    	if (!(collObj instanceof Aggregation)) throw new InvalidDataException("AddNewSlot: AddNewSlot operates on Aggregation collections only.", "");
        agg = (Aggregation)collObj;

        // get props
        CastorHashMap props = new CastorHashMap();
        StringBuffer classProps = new StringBuffer();
        if (descKey != null) {
        	PropertyDescriptionList propList;
			try {
				propList = PropertyUtility.getPropertyDescriptionOutcome(descKey, descVer);
			} catch (ObjectNotFoundException e) {
				throw new InvalidDataException("AddNewSlot: Item "+descKey+" does not contain a PropertyDescription outcome to define a slot", "");
			}
            for (PropertyDescription pd : propList.list) {
				props.put(pd.getName(), pd.getDefaultValue());
				if (pd.getIsClassIdentifier())
					classProps.append((classProps.length()>0?",":"")).append(pd.getName());
			}
        }
        
        agg.addSlot(props, classProps.toString());

		try {
            Gateway.getStorage().put(item, agg, null);
        } catch (ClusterStorageException e) {
            Logger.error(e);
            throw new InvalidDataException("AddNewSlot: Error storing collection", "");
        }

        return requestData;
    }
}