/* $Id: VariableListHandler.java,v 1.12 2007/02/25 20:05:34 m31 Exp $
 *
 * This file is part of the project "Hilbert II" - http://www.qedeq.org
 *
 * Copyright 2000-2007,  Michael Meyling <mime@qedeq.org>.
 *
 * "Hilbert II" is free software; you can redistribute
 * it and/or modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 */

package org.qedeq.kernel.xml.handler.module;

import org.qedeq.kernel.dto.module.VariableListVo;
import org.qedeq.kernel.xml.handler.list.ElementHandler;
import org.qedeq.kernel.xml.parser.AbstractSimpleHandler;
import org.qedeq.kernel.xml.parser.SimpleAttributes;
import org.qedeq.kernel.xml.parser.SyntaxException;


/**
 * Parse variables.
 *
 * @version $Revision: 1.12 $
 * @author  Michael Meyling
 */
public final class VariableListHandler extends AbstractSimpleHandler {

    /** Value object: list of variables for formulas and terms. */
    private VariableListVo variables;

    /** Handles the element parsing. */
    private final ElementHandler elementHandler;


    /**
     * Handles variables list of definitions.
     *
     * @param   handler Parent handler.
     */
    public VariableListHandler(final AbstractSimpleHandler handler) {
        super(handler, "VARLIST");
        elementHandler = new ElementHandler(this);
    }

    public final void init() {
        variables = null;
    }

    /**
     * Get parsed result.
     *
     * @return  List of parsed variables.
     */
    public final VariableListVo getVariables() {
        return variables;
    }

    public final void startElement(final String name, final SimpleAttributes attributes)
            throws SyntaxException {
        if (getStartTag().equals(name)) {
            variables = new VariableListVo();
        } else if (getLevel() > 1) {
            changeHandler(elementHandler, name, attributes);
        } else {
            throw SyntaxException.createUnexpectedTagException(name);
        }
    }

    public final void endElement(final String name) throws SyntaxException {
        if (getStartTag().equals(name)) {
            // nothing to do
        } else if (getLevel() > 1) {
            variables.add(elementHandler.getElement());
        } else {
            throw SyntaxException.createUnexpectedTagException(name);
        }
    }
}