QueueDefinitionItem.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.common.instance.helper;

import java.util.ArrayList;
import java.util.List;

import javax.xml.namespace.QName;

import eu.esdihumboldt.hale.common.schema.model.ChildDefinition;

/**
 * Objects of these Class are used by the {@link PropertyResolver} in a Queue
 * for traversing the instance-definition-tree.
 * 
 * @author Sebastian Reinhardt
 */
public class QueueDefinitionItem {

	private ChildDefinition<?> def;
	private final List<QName> qnames;
	private final List<List<QName>> loops;

	/**
	 * Create a definition item.
	 * 
	 * @param def the child definition
	 * @param qname the child name
	 */
	public QueueDefinitionItem(ChildDefinition<?> def, QName qname) {
		this.def = def;
		this.qnames = new ArrayList<QName>();
		this.loops = new ArrayList<List<QName>>();
		qnames.add(qname);
	}

	/**
	 * @return the propDef returns the instance definition in this item
	 */
	public ChildDefinition<?> getDefinition() {
		return def;
	}

	/**
	 * @param propDef sets the instance definition in this item
	 */
	public void setDef(ChildDefinition<?> propDef) {
		this.def = propDef;
	}

	/**
	 * @return the qnames from the path of the definition inside the
	 *         instance-definition-tree
	 */
	public List<QName> getQnames() {
		return qnames;
	}

	/**
	 * Adds a single QName to the path
	 * 
	 * @param qname the QName to be add
	 */
	public void addQname(QName qname) {
		this.qnames.add(0, qname);
	}

	/**
	 * Adds multiple QNames to the path
	 * 
	 * @param qnames the QName sto be add
	 */
	public void addQnames(List<QName> qnames) {
		int i = 0;
		for (QName name : qnames) {
			this.qnames.add(i, name);
			i++;
		}
	}

	/**
	 * adds known loop paths which appear in the path of the
	 * instance-definition-tree on the way to the definition of this item
	 * 
	 * @param loopQNames the loop paths to add
	 */
	public void addLoopQNames(List<QName> loopQNames) {
		loops.add(loopQNames);
	}

	/**
	 * returns the known loop paths wich appear in the path of the
	 * instance-definition-tree on the way to the definition of this item
	 * 
	 * @return the known loop-paths
	 */
	public List<List<QName>> getLoopQNames() {
		return loops;
	}

	/**
	 * returns the path of the definition of this item in the
	 * instance-definition-tree as a String
	 * 
	 * @return the string representation of the path
	 */
	public String qNamesToString() {
		String result = "";
		for (int i = 0; i < qnames.size(); i++) {
			if (result.equals("")) {
				result = qnames.get(i).toString();
			}
			else {
				result = result.concat("." + qnames.get(i));
			}
		}

		return result;
	}
}