summaryrefslogtreecommitdiff
path: root/src/main/java/org/cristalise/kernel/lifecycle/instance/predefined/AddNewSlot.java
blob: 0088091e85a9a0d9dfe994b3042c937cdbd1b70c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/**
 * This file is part of the CRISTAL-iSE kernel.
 * Copyright (c) 2001-2014 The CRISTAL Consortium. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * http://www.fsf.org/licensing/licenses/lgpl.html
 */
package org.cristalise.kernel.lifecycle.instance.predefined;


import java.util.Arrays;

import org.cristalise.kernel.collection.Aggregation;
import org.cristalise.kernel.common.InvalidDataException;
import org.cristalise.kernel.common.ObjectNotFoundException;
import org.cristalise.kernel.common.PersistencyException;
import org.cristalise.kernel.entity.C2KLocalObject;
import org.cristalise.kernel.lookup.AgentPath;
import org.cristalise.kernel.lookup.DomainPath;
import org.cristalise.kernel.lookup.InvalidItemPathException;
import org.cristalise.kernel.lookup.ItemPath;
import org.cristalise.kernel.persistency.ClusterStorage;
import org.cristalise.kernel.process.Gateway;
import org.cristalise.kernel.property.PropertyDescription;
import org.cristalise.kernel.property.PropertyDescriptionList;
import org.cristalise.kernel.property.PropertyUtility;
import org.cristalise.kernel.utils.CastorHashMap;
import org.cristalise.kernel.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>
     * 
     * @throws InvalidDataException Then the parameters were incorrect
     * @throws PersistencyException There was a problem loading or saving the collection from persistency
     * @throws ObjectNotFoundException A required object, such as the collection or a PropertyDescription outcome, wasn't found
     */
    @Override
	protected String runActivityLogic(AgentPath agent, ItemPath item,
			int transitionID, String requestData) throws InvalidDataException, PersistencyException, ObjectNotFoundException {
    	
        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) {
            	try {
            		descKey = new ItemPath(params[1]);
            	} catch (InvalidItemPathException e) {
            		descKey = new DomainPath(params[1]).getItemPath();
            	}
            }
            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 (PersistencyException ex) {
			Logger.error(ex);
			throw new PersistencyException("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;
			propList = PropertyUtility.getPropertyDescriptionOutcome(descKey, descVer);
            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 (PersistencyException e) {
            Logger.error(e);
            throw new PersistencyException("AddNewSlot: Error saving collection '"+collName+"': "+e.getMessage());
        }

        return requestData;
    }
}