/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.cocoon.forms.formmodel;
import java.util.Iterator;
import java.util.Locale;
import org.apache.avalon.framework.service.ServiceSelector;
import org.apache.cocoon.forms.FormsConstants;
import org.apache.cocoon.forms.FormsException;
import org.apache.cocoon.forms.datatype.Datatype;
import org.apache.cocoon.forms.datatype.SelectionList;
import org.apache.cocoon.forms.datatype.SelectionListBuilder;
import org.apache.cocoon.forms.datatype.convertor.ConversionResult;
import org.apache.cocoon.forms.event.ValueChangedListener;
import org.apache.cocoon.forms.util.DomHelper;
import org.apache.cocoon.i18n.I18nUtils;
import org.w3c.dom.Element;
/**
* Abstract base class for WidgetDefinitionBuilders that build widgets that have datatypes/selection lists.
*
* @version $Id: AbstractDatatypeWidgetDefinitionBuilder.java 449149 2006-09-23 03:58:05Z crossley $
*/
public abstract class AbstractDatatypeWidgetDefinitionBuilder extends AbstractWidgetDefinitionBuilder {
protected void setupDefinition(Element widgetElement,
AbstractDatatypeWidgetDefinition definition)
throws Exception {
setupDefinition(widgetElement, definition, false);
}
protected void setupDefinition(Element widgetElement,
AbstractDatatypeWidgetDefinition definition,
boolean isArrayType)
throws Exception {
super.setupDefinition(widgetElement, definition);
// parse "label", "hint", etc.
setDisplayData(widgetElement, definition);
// parse "on-value-changed"
Iterator i = buildEventListeners(widgetElement, "on-value-changed", ValueChangedListener.class).iterator();
while (i.hasNext()) {
definition.addValueChangedListener((ValueChangedListener)i.next());
}
//---- parse "datatype"
Element datatypeElement = DomHelper.getChildElement(widgetElement, FormsConstants.DEFINITION_NS, "datatype");
if (datatypeElement != null) {
Datatype datatype = datatypeManager.createDatatype(datatypeElement, isArrayType);
// ---- parse "initial-value"
Object initialValue = null;
Element initialValueElement = DomHelper.getChildElement(widgetElement, FormsConstants.DEFINITION_NS, "initial-value", false);
if (initialValueElement != null) {
String localeValue = DomHelper.getAttribute(initialValueElement, "locale", null);
Locale locale = localeValue == null ? Locale.getDefault() : I18nUtils.parseLocale(localeValue);
String value = DomHelper.getElementText(initialValueElement);
ConversionResult result = datatype.convertFromString(value, locale);
if (!result.isSuccessful()) {
throw new FormsException("Cannot parse initial value '" + value + "'.",
DomHelper.getLocationObject(initialValueElement));
}
initialValue = result.getResult();
}
definition.setDatatype(datatype, initialValue);
}
//---- parse "selection-list"
// FIXME: pass the manager to the definition as a side effect. Should be removed
// when definition are managed like components.
definition.service(this.serviceManager);
SelectionList list = buildSelectionList(widgetElement, definition, "selection-list");
if (list != null) {
definition.setSelectionList(list);
}
}
protected SelectionList buildSelectionList(Element widgetElement,
AbstractDatatypeWidgetDefinition definition,
String name)
throws Exception {
Element selectionListElement = DomHelper.getChildElement(widgetElement, FormsConstants.DEFINITION_NS, name);
if (selectionListElement != null && definition.getDatatype() == null) {
throw new FormsException("A widget with a selection list requires a datatype.",
DomHelper.getLocationObject(widgetElement));
}
if (selectionListElement == null) {
return null;
}
// Get an appropriate list builder
ServiceSelector builderSelector = (ServiceSelector) this.serviceManager.lookup(SelectionListBuilder.ROLE + "Selector");
SelectionListBuilder builder = null;
try {
// listType can be null, meaning we will use the default selection list
String listType = selectionListElement.getAttribute("type");
if ("".equals(listType)) {
listType = null;
}
builder = (SelectionListBuilder)builderSelector.select(listType);
return builder.build(selectionListElement, definition.getDatatype());
} finally {
if (builder != null) {
builderSelector.release(builder);
}
this.serviceManager.release(builderSelector);
}
}
}