/*
* RatioStatisticParser.java
*
* Copyright (c) 2002-2015 Alexei Drummond, Andrew Rambaut and Marc Suchard
*
* This file is part of BEAST.
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership and licensing.
*
* BEAST is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* BEAST 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with BEAST; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301 USA
*/
package dr.inferencexml.model;
import dr.inference.model.RatioStatistic;
import dr.inference.model.Statistic;
import dr.xml.*;
/**
*/
public class RatioStatisticParser extends AbstractXMLObjectParser {
public static String RATIO_STATISTIC = "ratioStatistic";
public static String RATIO = "ratio";
public String[] getParserNames() { return new String[] { getParserName(), RATIO}; }
public String getParserName() { return RATIO_STATISTIC; }
public Object parseXMLObject(XMLObject xo) throws XMLParseException {
Statistic numerator = (Statistic)xo.getChild(0);
Statistic denominator = (Statistic)xo.getChild(1);
RatioStatistic ratioStatistic;
try {
ratioStatistic = new RatioStatistic(RATIO_STATISTIC, numerator, denominator);
} catch (IllegalArgumentException iae) {
throw new XMLParseException("Error parsing " + getParserName() + " the numerator and denominator statistics " +
"should be of the same dimension or of dimension 1");
}
return ratioStatistic;
}
//************************************************************************
// AbstractXMLObjectParser implementation
//************************************************************************
public String getParserDescription() {
return "This element returns a statistic that is the ratio of the 2 child statistics.";
}
public Class getReturnType() { return RatioStatistic.class; }
public XMLSyntaxRule[] getSyntaxRules() { return rules; }
private final XMLSyntaxRule[] rules = {
new ElementRule(Statistic.class, "The two operand statistics", 2, 2)
};
}