blob: bd56675aee37b94b20cf35971ab5b67e3bffb618 [file] [log] [blame]
/*******************************************************************************
* 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.ofbiz.widget.model;
import java.util.List;
import org.apache.ofbiz.base.util.Debug;
import org.apache.ofbiz.base.util.UtilXml;
import org.apache.ofbiz.entity.model.ModelReader;
import org.apache.ofbiz.service.DispatchContext;
import org.w3c.dom.Element;
/**
* Models the <form> element.
*
* @see <code>widget-form.xsd</code>
*/
@SuppressWarnings("serial")
public class ModelSingleForm extends ModelForm {
/*
* ----------------------------------------------------------------------- *
* DEVELOPERS PLEASE READ
* ----------------------------------------------------------------------- *
*
* This model is intended to be a read-only data structure that represents
* an XML element. Outside of object construction, the class should not
* have any behaviors. All behavior should be contained in model visitors.
*
* Instances of this class will be shared by multiple threads - therefore
* it is immutable. DO NOT CHANGE THE OBJECT'S STATE AT RUN TIME!
*
*/
public static final String module = ModelSingleForm.class.getName();
/** XML Constructor */
public ModelSingleForm(Element formElement, String formLocation, ModelReader entityModelReader,
DispatchContext dispatchContext) {
super(formElement, formLocation, entityModelReader, dispatchContext, "single");
}
@Override
public void accept(ModelWidgetVisitor visitor) throws Exception {
visitor.visit(this);
}
protected ModelForm getParentModel(Element formElement, ModelReader entityModelReader, DispatchContext dispatchContext) {
ModelForm parent = null;
String parentResource = formElement.getAttribute("extends-resource");
String parentForm = formElement.getAttribute("extends");
if (!parentForm.isEmpty()) {
// check if we have a resource name
if (!parentResource.isEmpty()) {
try {
parent = FormFactory.getFormFromLocation(parentResource, parentForm, entityModelReader, dispatchContext);
} catch (Exception e) {
Debug.logError(e, "Failed to load parent form definition '" + parentForm + "' at resource '" + parentResource
+ "'", module);
}
} else if (!parentForm.equals(formElement.getAttribute("name"))) {
// try to find a form definition in the same file
Element rootElement = formElement.getOwnerDocument().getDocumentElement();
List<? extends Element> formElements = UtilXml.childElementList(rootElement, "form");
//Uncomment below to add support for abstract forms
//formElements.addAll(UtilXml.childElementList(rootElement, "abstract-form"));
for (Element parentElement : formElements) {
if (parentElement.getAttribute("name").equals(parentForm)) {
parent = FormFactory.createModelForm(parentElement, entityModelReader, dispatchContext, parentResource,
parentForm);
break;
}
}
if (parent == null) {
Debug.logError("Failed to find parent form definition '" + parentForm + "' in same document.", module);
}
} else {
Debug.logError("Recursive form definition found for '" + formElement.getAttribute("name") + ".'", module);
}
}
return parent;
}
}