org.cristalise.kernel.collection.DependencyDescription Maven / Gradle / Ivy

Go to download
/**
 * This file is part of the CRISTAL-iSE kernel.
 * Copyright (c) 2001-2015 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.collection;

import org.cristalise.kernel.common.InvalidCollectionModification;
import org.cristalise.kernel.common.ObjectAlreadyExistsException;
import org.cristalise.kernel.common.ObjectNotFoundException;
import org.cristalise.kernel.lookup.ItemPath;
import org.cristalise.kernel.property.PropertyDescriptionList;
import org.cristalise.kernel.property.PropertyUtility;
import org.cristalise.kernel.utils.CastorHashMap;
import org.cristalise.kernel.utils.Logger;

public class DependencyDescription extends Dependency implements CollectionDescription {

    public DependencyDescription() {
        setName("DependencyDescription");
    }

    public DependencyDescription(String name) {
        setName(name);
    }

    public DependencyDescription(String name, Integer version) {
        setName(name);
        setVersion(version);
    }

    @Override
    public Collection newInstance() throws ObjectNotFoundException {
        // HACK: Knock the special 'prime' off the end for the case of descriptions of descriptions
        String depName = getName().replaceFirst("\'$", ""); 

        Dependency newDep = new Dependency(depName);

        // constrain the members based on the property description
        if (mMembers.list.size() == 1) {
            DependencyMember mem = mMembers.list.get(0);
            String descVer = getDescVer(mem);

            PropertyDescriptionList pdList = PropertyUtility.getPropertyDescriptionOutcome(mem.getItemPath(), descVer, null);

            if (pdList != null) {
                newDep.setProperties(PropertyUtility.convertTransitiveProperties(pdList));
                newDep.setClassProps(pdList.getClassProps());
            }
            else
                Logger.warning("DependencyDescription.newInstance("+getName()+") - No PropertyDesc was found. Dependency cannot check member type.");

            if (mProperties != null) newDep.getProperties().merge(mProperties);
        }
        else
            Logger.warning("DependencyDescription.newInstance("+getName()+") - No PropertyDesc was found. Dependency cannot check member type.");

        return newDep;
    }

    @Override
    public DependencyMember addMember(ItemPath itemPath) throws InvalidCollectionModification, ObjectAlreadyExistsException {
        checkMembership();
        return super.addMember(itemPath);
    }

    @Override
    public DependencyMember addMember(ItemPath itemPath, CastorHashMap props, String classProps) throws InvalidCollectionModification,
            ObjectAlreadyExistsException {
        checkMembership();
        return super.addMember(itemPath, props, classProps);
    }

    public void checkMembership() throws InvalidCollectionModification {
        if (mMembers.list.size() > 0)
            throw new InvalidCollectionModification("Dependency descriptions may not have more than one member.");
    }
}