com.izforge.izpack.panels.userinput.UserInputPanelAutomationHelper Maven / Gradle / Ivy
/*
* IzPack - Copyright 2001-2008 Julien Ponge, All Rights Reserved.
*
* http://izpack.org/
* http://izpack.codehaus.org/
*
* Copyright 2003 Jonathan Halliday
* Copyright 2002 Elmar Grom
*
* 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.panels.userinput;
import com.izforge.izpack.api.adaptator.IXMLElement;
import com.izforge.izpack.api.adaptator.impl.XMLElementImpl;
import com.izforge.izpack.api.data.InstallData;
import com.izforge.izpack.api.data.Overrides;
import com.izforge.izpack.api.data.Variables;
import com.izforge.izpack.api.exception.InstallerException;
import com.izforge.izpack.installer.automation.PanelAutomation;
import com.izforge.izpack.panels.userinput.field.AbstractFieldView;
import com.izforge.izpack.panels.userinput.field.FieldView;
import com.izforge.izpack.panels.userinput.field.custom.CustomFieldType;
import java.util.*;
import java.util.logging.Logger;
/**
* Functions to support automated usage of the UserInputPanel
*
* @author Jonathan Halliday
* @author Elmar Grom
*/
public class UserInputPanelAutomationHelper implements PanelAutomation
{
private static final Logger logger = Logger.getLogger(UserInputPanelAutomationHelper.class.getName());
// ------------------------------------------------------
// automatic script section keys
// ------------------------------------------------------
private static final String AUTO_KEY_ENTRY = "entry";
// ------------------------------------------------------
// automatic script keys attributes
// ------------------------------------------------------
private static final String AUTO_ATTRIBUTE_KEY = "key";
private static final String AUTO_ATTRIBUTE_VALUE = "value";
private List views;
/**
* Default constructor, used during automated installation.
*/
public UserInputPanelAutomationHelper()
{
}
/**
* Creates an {@link UserInputPanelAutomationHelper}
*
* @param views AbstractFieldView
*/
public UserInputPanelAutomationHelper(List views)
{
this.views = views;
}
/**
* Serialize state to XML and insert under panelRoot.
*
* @param installData The installation installData GUI.
* @param rootElement The XML root element of the panels blackbox tree.
*/
@Override
public void createInstallationRecord(InstallData installData, IXMLElement rootElement)
{
HashSet omitFromAutoSet = new HashSet();
Map entries = generateEntries(installData, views, omitFromAutoSet);
IXMLElement dataElement;
for (String key : entries.keySet())
{
dataElement = new XMLElementImpl(AUTO_KEY_ENTRY, rootElement);
dataElement.setAttribute(AUTO_ATTRIBUTE_KEY, key);
String value = (omitFromAutoSet.contains(key) ? "" : entries.get(key));
dataElement.setAttribute(AUTO_ATTRIBUTE_VALUE, value);
rootElement.addChild(dataElement);
}
}
private Map generateEntries(InstallData installData,
List views,
HashSet omitFromAutoSet)
{
Map entries = new HashMap();
for (FieldView view : views)
{
if (view.isDisplayed())
{
String variable = view.getField().getVariable();
if (variable != null)
{
String entry = installData.getVariable(variable);
if (view.getField().getOmitFromAuto())
{
omitFromAutoSet.add(variable);
}
entries.put(variable, entry);
}
// Grab all the variables contained within the custom field
List namedVariables = new ArrayList();
if (view instanceof CustomFieldType)
{
CustomFieldType customField = (CustomFieldType) view;
namedVariables = customField.getVariables();
}
for (String numberedVariable : namedVariables)
{
entries.put(numberedVariable, installData.getVariable(numberedVariable));
}
}
}
return entries;
}
/**
* Deserialize state from panelRoot and set installData variables accordingly.
*
* @param idata The installation installDataGUI.
* @param panelRoot The XML root element of the panels blackbox tree.
* @throws InstallerException if some elements are missing.
*/
@Override
public void runAutomated(InstallData idata, IXMLElement panelRoot) throws InstallerException
{
String variable;
String value;
List userEntries = panelRoot.getChildrenNamed(AUTO_KEY_ENTRY);
HashSet blockedVariablesList = new HashSet();
// ----------------------------------------------------
// retieve each entry and substitute the associated
// variable
// ----------------------------------------------------
Variables variables = idata.getVariables();
for (IXMLElement dataElement : userEntries)
{
variable = dataElement.getAttribute(AUTO_ATTRIBUTE_KEY);
// Substitute variable used in the 'value' field
value = dataElement.getAttribute(AUTO_ATTRIBUTE_VALUE);
value = variables.replace(value);
logger.fine("Setting variable " + variable + " to " + value);
idata.setVariable(variable, value);
blockedVariablesList.add(variable);
}
idata.getVariables().registerBlockedVariableNames(blockedVariablesList, panelRoot.getName());
}
@Override
public void processOptions(InstallData installData, Overrides overrides) {}
}