/*
 * JBoss, Home of Professional Open Source.
 *
 * See the LEGAL.txt file distributed with this work for information regarding copyright ownership and licensing.
 *
 * See the AUTHORS.txt file distributed with this work for a full listing of individual contributors.
 */
package org.teiid.designer.metamodels.xml.aspects.validation;

import org.eclipse.emf.ecore.EObject;
import org.teiid.core.designer.util.CoreArgCheck;
import org.teiid.core.designer.util.CoreStringUtil;
import org.teiid.designer.core.ValidationDescriptor;
import org.teiid.designer.core.ValidationPreferences;
import org.teiid.designer.core.metamodel.aspect.MetamodelEntity;
import org.teiid.designer.core.validation.ValidationContext;
import org.teiid.designer.metamodels.xml.XmlContainerNode;
import org.teiid.designer.metamodels.xml.XmlDocumentNode;



/** 
 * @since 8.0
 */
public abstract class AbstractXmlNodeAspect extends AbstractXmlAspect {

    /** 
     * @param entity
     * @since 4.2
     */
    public AbstractXmlNodeAspect(MetamodelEntity entity) {
        super(entity);
    }

    /** 
     * @see org.teiid.designer.core.metamodel.aspect.ValidationAspect#shouldValidate(org.eclipse.emf.ecore.EObject)
     * @since 4.2
     */
    @Override
    public boolean shouldValidate(EObject eObject, final ValidationContext context) {
        CoreArgCheck.isNotNull(eObject);
        String validationPref = context.getPreferenceValue(ValidationPreferences.XML_ELEMENT_VALIDATE_EXCLUDED);
        
        // If we are not validating excluded elements then return false for all EObjects
        // that are marked as excluded in the document
        if (CoreStringUtil.isEmpty(validationPref) || validationPref.equals(ValidationDescriptor.FALSE)) {
	        if(!context.shouldIgnore(eObject)) {
	            // check if the eObject is excluded
	            if(isExcluded(eObject, context)) {
	                return false;
	            }
	            // check if any of the parents of the EObject are excluded
	            EObject container = eObject.eContainer();
	            while(container != null) {
	                if(isExcluded(container, context)) {
	                    return false;
	                }
	                container = container.eContainer();
	            }
	            // neither Eobject nor its parents are excluded
	            // so validate
		        return true;
	        }
	        // already ignored do not validate
	        return false;	        
        }
        // preferences say validate
        return true;
    }

    /**
     * Check if the documentNode is excluded and add itseld and its children to the context to
     * be ignored during validation.
     * @since 4.2
     */
    private boolean isExcluded(final EObject eObject, final ValidationContext context) {
        if(eObject != null) {
            boolean excluded = false;
	        if(eObject instanceof XmlDocumentNode) {
	            excluded = ((XmlDocumentNode)eObject).isExcludeFromDocument();
	        } else if(eObject instanceof XmlContainerNode) {
	            excluded = ((XmlContainerNode)eObject).isExcludeFromDocument();
	        }
	        if(excluded) {
	            context.addObjectToIgnore(eObject, true);
	            return true;   
	        }
    	}
        return false;
    }    
}