/**
 * 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 com.c2kernel.lifecycle;

import java.util.Vector;

import com.c2kernel.common.InvalidDataException;
import com.c2kernel.common.ObjectNotFoundException;
import com.c2kernel.graph.model.GraphableVertex;
import com.c2kernel.lifecycle.instance.WfVertex;
import com.c2kernel.utils.KeyValuePair;

/**
 * @version $Revision: 1.22 $ $Date: 2005/11/15 15:56:38 $
 * @author  $Author: abranson $
 */
public abstract class WfVertexDef extends GraphableVertex
{
    public Vector<String> mErrors;

    protected boolean loopTested;

    /**
     * @see java.lang.Object#Object()
     */
    /** @label wf */
    public WfVertexDef()
    {
        mErrors = new Vector<String>(0, 1);
        setIsLayoutable(true);
    }

    public abstract WfVertex instantiate() throws ObjectNotFoundException, InvalidDataException;

    public void configureInstance(WfVertex newVertex) {
		KeyValuePair[] k = getProperties().getKeyValuePairs();
		for (KeyValuePair element : k)
			newVertex.getProperties().put(element.getKey(), element.getValue(), element.isAbstract());
    	newVertex.setID(getID());
    	if (getIsLayoutable()) {
        	newVertex.setInEdgeIds(getInEdgeIds());
        	newVertex.setOutEdgeIds(getOutEdgeIds());
    		newVertex.setCentrePoint(getCentrePoint());
    		newVertex.setOutlinePoints(getOutlinePoints());
    	}
    }

    /**
     * Method verify.
     *
     * @return boolean
     */
    public abstract boolean verify();

    /**
     * Method getErrors.
     *
     * @return String
     */
    public String getErrors()
    {
        if (mErrors.size() == 0)
            return "No error";
        else if (mErrors.size() == 1)
        	return mErrors.elementAt(0);
        else {
        	StringBuffer errorBuffer = new StringBuffer();
        	for (String error : mErrors) {
        		if (errorBuffer.length() > 0) errorBuffer.append("\n");
				errorBuffer.append(error);
			}
            return errorBuffer.toString();
        }
    }

    /**
     * Method loop.
     *
     * @return boolean
     */
    public boolean loop()
    {
        boolean loop2 = false;
        if (!loopTested)
        {
            loopTested = true;
            if (getOutGraphables().length != 0)
                loop2 = ((WfVertexDef) getOutGraphables()[0]).loop();
        }
        loopTested = false;
        return loop2;
    }
}