/**
 * Copyright (C) 2012-2013 Selventa, Inc.
 *
 * This file is part of the OpenBEL Framework.
 *
 * This program 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 3 of the License, or
 * (at your option) any later version.
 *
 * The OpenBEL Framework 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 the OpenBEL Framework. If not, see <http://www.gnu.org/licenses/>.
 *
 * Additional Terms under LGPL v3:
 *
 * This license does not authorize you and you are prohibited from using the
 * name, trademarks, service marks, logos or similar indicia of Selventa, Inc.,
 * or, in the discretion of other licensors or authors of the program, the
 * name, trademarks, service marks, logos or similar indicia of such authors or
 * licensors, in any marketing or advertising materials relating to your
 * distribution of the program or any covered product. This restriction does
 * not waive or limit your obligation to keep intact all copyright notices set
 * forth in the program as delivered to you.
 *
 * If you distribute the program in whole or in part, or any modified version
 * of the program, and you assume contractual liability to the recipient with
 * respect to the program or modified version, then you will indemnify the
 * authors and licensors of the program for any liabilities that these
 * contractual assumptions directly impose on those licensors and authors.
 */
package org.openbel.framework.core;

import java.io.File;
import java.util.List;

import org.openbel.framework.core.compiler.ValidationError;

/**
 * Validates XBEL documents against the XBEL schema.
 */
public interface XBELValidatorService {

    // TODO Push this service into ValidationService, use ValidationResults

    /**
     * Returns {@code true} if the provided string is a valid XBEL document,
     * {@code false} otherwise.
     *
     * @param s XBEL XML string
     * @return boolean
     */
    public boolean isValid(String s);

    /**
     * Returns {@code true} if the provided file is a valid XBEL document,
     * {@code false} otherwise.
     *
     * @param f XBEL XML file
     * @return boolean
     */
    public boolean isValid(File f);

    /**
     * Validates the provided string as a XBEL document.
     *
     * @param s XBEL XML string
     * @throws ValidationError Thrown to indicate the provided string fails
     * validation. If the string contains one or more errors, only the first
     * error will cause an exception.
     * @see #validateWithErrors(String)
     */
    public void validate(String s) throws ValidationError;

    /**
     * Validates the provided string as a XBEL document, returning any and all
     * validation errors.
     *
     * @param s XBEL XML string
     * @return A non-null list of validation errors for the XML string
     */
    public List<ValidationError> validateWithErrors(String s);

    /**
     * Validates the provided file as a XBEL document.
     *
     * @param f XBEL XML file
     * @throws ValidationError Thrown to indicate the provided file fails
     * validation. If the file contains one or more errors, only the first error
     * will cause an exception.
     */
    public void validate(File f) throws ValidationError;

    /**
     * Validates the provided file as a XBEL document, returning any and all
     * validation errors.
     *
     * @param f XBEL XML file
     * @return A non-null list of validation errors for the XML file
     */
    public List<ValidationError> validateWithErrors(File f);

}