XmlTypeDefinition.java

/*
 * Copyright (c) 2012 Data Harmonisation Panel
 * 
 * All rights reserved. This program and the accompanying materials are made
 * available 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.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution. If not, see <http://www.gnu.org/licenses/>.
 * 
 * Contributors:
 *     HUMBOLDT EU Integrated Project #030962
 *     Data Harmonisation Panel <http://www.dhpanel.eu>
 */

package eu.esdihumboldt.hale.io.xsd.reader.internal;

import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Map.Entry;

import javax.xml.namespace.QName;

import eu.esdihumboldt.hale.common.schema.model.ChildDefinition;
import eu.esdihumboldt.hale.common.schema.model.constraint.type.HasValueFlag;
import eu.esdihumboldt.hale.common.schema.model.impl.DefaultTypeDefinition;
import eu.esdihumboldt.hale.io.xsd.constraint.RestrictionFlag;
import eu.esdihumboldt.hale.io.xsd.constraint.XmlAttributeFlag;
import eu.esdihumboldt.hale.io.xsd.constraint.XmlElements;
import eu.esdihumboldt.hale.io.xsd.model.XmlElement;

/**
 * XML type definition
 * 
 * @author Simon Templer
 */
public class XmlTypeDefinition extends DefaultTypeDefinition {

	/**
	 * @see DefaultTypeDefinition#DefaultTypeDefinition(QName)
	 */
	public XmlTypeDefinition(QName name) {
		super(name);
	}

	/**
	 * @see DefaultTypeDefinition#getChildren()
	 */
	@Override
	public Collection<? extends ChildDefinition<?>> getChildren() {
		if (getConstraint(RestrictionFlag.class).isEnabled()) {
			if (!getConstraint(HasValueFlag.class).isEnabled()) {
				// restriction on complex type

				// declared children
				Map<QName, ChildDefinition<?>> declaredChildren = new LinkedHashMap<QName, ChildDefinition<?>>();
				for (ChildDefinition<?> def : getDeclaredChildren()) {
					declaredChildren.put(def.getName(), def);
				}

				// inherited children
				Map<QName, ChildDefinition<?>> inheritedChildren = new LinkedHashMap<QName, ChildDefinition<?>>(
						getInheritedChildren());
				Iterator<Entry<QName, ChildDefinition<?>>> it = inheritedChildren.entrySet()
						.iterator();
				while (it.hasNext()) {
					Entry<QName, ChildDefinition<?>> entry = it.next();

					boolean isAttribute = entry.getValue().asProperty() != null
							&& entry.getValue().asProperty().getConstraint(XmlAttributeFlag.class)
									.isEnabled();

					if (!isAttribute) {
						/*
						 * XXX For restrictions (on complex types) assume that
						 * all elements are redefined if needed.
						 * 
						 * For attributes though, it seems that they don't have
						 * to be redefined. (Or is this only for mandatory
						 * attributes?)
						 */
						// remove element
						it.remove();
					}
				}

				// build result
				inheritedChildren.putAll(declaredChildren);
				return inheritedChildren.values();
			}
			else {
				// restriction on simple type
				Collection<? extends ChildDefinition<?>> declaredChildren = getDeclaredChildren();
				if (declaredChildren.isEmpty()) {
					return super.getChildren();
				}

				// if there are declared children, they may override the
				// inherited children
				Map<QName, ChildDefinition<?>> children = new HashMap<QName, ChildDefinition<?>>(
						getInheritedChildren());
				for (ChildDefinition<?> child : declaredChildren) {
					children.put(child.getName(), child);
				}

				// order doesn't matter as children may only be attributes
				return children.values();
			}
		}

		return super.getChildren();
	}

	@Override
	public String getDescription() {
		String desc = super.getDescription();
		if (desc != null && !desc.isEmpty()) {
			return desc;
		}

		// if no description is present, try the description of the associated
		// element
		XmlElements elements = getConstraint(XmlElements.class);
		if (elements.getElements().size() == 1) {
			// only use element description if it's unique
			XmlElement element = elements.getElements().iterator().next();
			return element.getDescription();
		}

		return desc;
	}

}