/*
 * Copyright 2013 Skynav, Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY SKYNAV, INC. AND ITS CONTRIBUTORS “AS IS” AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL SKYNAV, INC. OR ITS CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.skynav.ttv.verifier;

import org.w3c.dom.Node;

import org.xml.sax.Locator;

public interface SemanticsVerifier {

    /**
     * Find binding content element associated with infoset
     * node, starting at root binding content element.
     * @param root root binding content element
     * @param node infoset node for which search is being made
     * @return the binding object associated with node or null if not found
     */
    Object findBindingElement(Object root, Node node);

    /**
     * Verify semantics of content object.
     * @param root the root JAXB content object
     * @param context verifier context
     * @return true if validation succeeds without error
     */
    boolean verify(Object root, VerifierContext context);

    /**
     * Verify semantics of other element.
     * @param content a JAXB content object
     * @param locator location of content
     * @param context verifier context
     * @return true if validation succeeds without error
     */
    boolean verifyOtherElement(Object content, Locator locator, VerifierContext context);

    /**
     * Verify semantics of other attributes.
     * @param content a JAXB content object
     * @param locator location of content
     * @param context verifier context
     * @return true if validation succeeds without error
     */
    boolean verifyOtherAttributes(Object content, Locator locator, VerifierContext context);

    /**
     * Verify post transformation semantics.
     * @param content a JAXB content object
     * @param contentTransformed a transformed content object
     * @param context verifier context
     * @return true if validation succeeds without error
     */
    boolean verifyPostTransform(Object content, Object contentTransformed, VerifierContext context);

}