Panel.java

/*
 * IzPack - Copyright 2001-2008 Julien Ponge, All Rights Reserved.
 * 
 * http://izpack.org/
 * http://izpack.codehaus.org/
 * 
 * Copyright 2004 Jan Blok
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 *     
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.izforge.izpack;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.izforge.izpack.adaptator.IXMLElement;
import com.izforge.izpack.installer.PanelActionConfiguration;
import com.izforge.izpack.util.Debug;
import com.izforge.izpack.util.OsConstraint;

/**
 * @author Jan Blok
 * @author Dennis Reil, <Dennis.Reil@reddot.de>
 */
public class Panel implements Serializable
{

    static final long serialVersionUID = 8886445274940938809L;

    /**
     * The panel classname.
     */
    public String className;

    /**
     * The target operation system of this panel
     */
    public List<OsConstraint> osConstraints = null;

    /**
     * the unique id of this panel
     */
    protected String panelid;

    /**
     * condition for this panel
     */
    private String condition = null;

    /**
     * The validator for this panel
     */
    private String validator = null;
    
    /**
     * list of all pre panel construction actions
     */
    private List<String> preConstructionActions = null;

    /**
     * list of all pre panel activation actions
     */
    private List<String> preActivationActions = null;

    /**
     * list of all pre panel validation actions
     */
    private List<String> preValidationActions = null;

    /**
     * list of all post panel validation actions
     */
    private List<String> postValidationActions = null;
    
    private HashMap<String,PanelActionConfiguration> actionConfiguration = null;


    /**
     * A HashMap for URLs to Helpfiles, key should be iso3-code
     */
    private HashMap<String, String> helps = null;

    public String getClassName()
    {
        return this.className;
    }

    public void setClassName(String className)
    {
        this.className = className;
    }

    public List<OsConstraint> getOsConstraints()
    {
        return this.osConstraints;
    }

    public void setOsConstraints(List<OsConstraint> osConstraints)
    {
        this.osConstraints = osConstraints;
    }

    public String getPanelid()
    {
        if (this.panelid == null)
        {
            this.panelid = "UNKNOWN (" + className + ")";
        }
        return this.panelid;
    }

    public void setPanelid(String panelid)
    {
        this.panelid = panelid;
    }

    /**
     * @return the condition
     */
    public String getCondition()
    {
        return this.condition;
    }

    /**
     * @param condition the condition to set
     */
    public void setCondition(String condition)
    {
        this.condition = condition;
    }

    public boolean hasCondition()
    {
        return this.condition != null;
    }

    public String getValidator()
    {
        return validator;
    }

    public void setValidator(String validator)
    {
        this.validator = validator;
    }

    public void addHelp(String isoCode, String url)
    {
        if (this.helps == null)
        {
            this.helps = new HashMap<String, String>();
        }
        this.helps.put(isoCode, url);
    }

    public HashMap<String, String> getHelpsMap()
    {
        return this.helps;
    }
    
    public List<String> getPreConstructionActions()
    {
        return preConstructionActions;
    }

    public void addPreConstructionActions(String preConstructionAction)
    {
        if (this.preConstructionActions == null)
        {
            this.preConstructionActions = new ArrayList<String>();
        }
        this.preConstructionActions.add(preConstructionAction);
    }

    public List<String> getPreActivationActions()
    {
        return preActivationActions;
    }

    public void addPreActivationAction(String preActivationAction)
    {
        if (this.preActivationActions == null)
        {
            this.preActivationActions = new ArrayList<String>();
        }
        this.preActivationActions.add(preActivationAction);
    }

    public List<String> getPreValidationActions()
    {
        return preValidationActions;
    }

    public void addPreValidationAction(String preValidationAction)
    {
        if (this.preValidationActions == null)
        {
            this.preValidationActions = new ArrayList<String>();
        }
        this.preValidationActions.add(preValidationAction);
    }

    public List<String> getPostValidationActions()
    {
        return postValidationActions;
    }

    public void addPostValidationAction(String postValidationAction)
    {
        if (this.postValidationActions == null)
        {
            this.postValidationActions = new ArrayList<String>();
        }
        this.postValidationActions.add(postValidationAction);
     }
    
    public void putPanelActionConfiguration(String panelActionClassName, PanelActionConfiguration configuration){
        if (this.actionConfiguration == null){
            this.actionConfiguration = new HashMap<String, PanelActionConfiguration>();
        }                
        this.actionConfiguration.put(panelActionClassName, configuration);
    }
    
    public PanelActionConfiguration getPanelActionConfiguration(String panelActionClassName){
        PanelActionConfiguration result = null;
        if (this.actionConfiguration != null){
            result = this.actionConfiguration.get(panelActionClassName);
        }
        return result;
    }
}