/*******************************************************************************
* Copyright (c) 2007 Oracle Corporation.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Cameron Bateman/Oracle - initial API and implementation
*
********************************************************************************/
package org.eclipse.jst.jsf.validation.internal.appconfig;
import java.util.Iterator;
import java.util.List;
import org.eclipse.core.resources.IFile;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.jst.jsf.core.IJSFCoreConstants;
import org.eclipse.jst.jsf.facesconfig.emf.DefaultLocaleType;
import org.eclipse.jst.jsf.facesconfig.emf.FacesConfigPackage;
import org.eclipse.jst.jsf.facesconfig.emf.FacesConfigType;
import org.eclipse.jst.jsf.facesconfig.emf.LocaleConfigType;
import org.eclipse.jst.jsf.facesconfig.emf.SupportedLocaleType;
/**
* Validator the <application> node of the app config model
* @author cbateman
*
*/
public class ApplicationValidationVisitor extends EObjectValidationVisitor
{
/**
* Default constructure
* @param version
*/
public ApplicationValidationVisitor(String version)
{
super(FacesConfigPackage.eINSTANCE.getFacesConfigType_Application(), version);
}
protected void doValidate(EObject object, List messages, IFile file) {
// nothing to validate
}
protected EObjectValidationVisitor[] getChildNodeValidators() {
return new EObjectValidationVisitor[]
{
// TODO: validate message and resource bundles
// TODO: validate default render kit id
new ActionListenerValidationVisitor(getVersion()),
new NavigationHandlerValidationVisitor(getVersion()),
new ViewHandlerValidationVisitor(getVersion()),
new StateManagerValidationVisitior(getVersion()),
new PropertyResolverValidationVisitor(getVersion()),
new VariableResolverValidationVisitor(getVersion()),
new ELResolverValidationVisitor(getVersion()),
new LocaleConfigValidationVisitor(getVersion()),
// new PartialTraversalValidationVisitor(getVersion()),
new ResourceHandlerValidationVisitor(getVersion()),
new SystemEventListenerTypeValidationVisitor(getVersion()),
new DefaultValidatorsValidationVisitor(getVersion())
};
}
/**
* @param facesConfig
* @param messages
* @param file
*/
protected void validateManagedBeanNames(FacesConfigType facesConfig, List messages, IFile file)
{
// final Map foundBeans = new HashMap();
// final List firstCollisionInstance = new ArrayList();
//
// for (final Iterator it = facesConfig.getManagedBean().iterator(); it.hasNext();)
// {
// final ManagedBeanType managedBean = (ManagedBeanType) it.next();
//
// if (managedBean.getManagedBeanName() == null
// || managedBean.getManagedBeanName().getTextContent() == null
// || "".equals(managedBean.getManagedBeanName().getTextContent()))
// {
//
// }
// if (!foundBeans.containsKey(managedBean.getManagedBeanName()))
// }
}
private static class LocaleConfigValidationVisitor extends EObjectValidationVisitor
{
/**
* @param version
*/
public LocaleConfigValidationVisitor(String version)
{
super(FacesConfigPackage.eINSTANCE.getApplicationType_LocaleConfig()
, version);
}
protected void doValidate(EObject object, List messages, IFile file)
{
final LocaleConfigType localeConfig = (LocaleConfigType) object;
DefaultLocaleType defaultLocale = localeConfig.getDefaultLocale();
if (defaultLocale != null)
{
addMessageInfo(
messages,
AppConfigValidationUtil
.validateLocaleType(defaultLocale.getTextContent())
, defaultLocale, file);
}
for (final Iterator it = localeConfig.getSupportedLocale().iterator(); it.hasNext();)
{
final SupportedLocaleType supportedLocale =
(SupportedLocaleType) it.next();
addMessageInfo(
messages,
AppConfigValidationUtil
.validateLocaleType(supportedLocale.getTextContent())
, supportedLocale, file);
}
}
protected EObjectValidationVisitor[] getChildNodeValidators() {
// there are children, but we're going to validate in doValidate
return NO_CHILDREN;
}
}
private static class ActionListenerValidationVisitor extends ApplicationClassNameBasedValidationVisitor
{
/**
* @param version
*/
public ActionListenerValidationVisitor(final String version) {
super(FacesConfigPackage.eINSTANCE.getApplicationType_ActionListener(),
version,"javax.faces.event.ActionListener", true); //$NON-NLS-1$
}
}
private static class NavigationHandlerValidationVisitor extends ApplicationClassNameBasedValidationVisitor
{
/**
* @param version
*/
public NavigationHandlerValidationVisitor(final String version) {
super(FacesConfigPackage.eINSTANCE.getApplicationType_NavigationHandler(),
version,"javax.faces.application.NavigationHandler", true); //$NON-NLS-1$
}
}
private static class ViewHandlerValidationVisitor extends ApplicationClassNameBasedValidationVisitor
{
ViewHandlerValidationVisitor(final String version)
{
super(FacesConfigPackage.eINSTANCE.getApplicationType_ViewHandler(),
version,"javax.faces.application.ViewHandler", true); //$NON-NLS-1$
}
}
private static class StateManagerValidationVisitior extends ApplicationClassNameBasedValidationVisitor
{
StateManagerValidationVisitior(final String version)
{
// must a concrete class with a zero arg constructor:
// JSF1.1_3.2.3.2 and JSF1.2_3.2.4.2
super(FacesConfigPackage.eINSTANCE.getApplicationType_StateManager(),
version,"javax.faces.application.StateManager", true); //$NON-NLS-1$
}
}
private static class PropertyResolverValidationVisitor extends ApplicationClassNameBasedValidationVisitor
{
PropertyResolverValidationVisitor(final String version)
{
super(FacesConfigPackage.eINSTANCE.getApplicationType_PropertyResolver(),
version,"javax.faces.el.PropertyResolver", true); //$NON-NLS-1$
}
protected void doValidate(EObject object, List messages, IFile file) {
super.doValidate(object, messages, file);
// if this version greater than 1.1 then property resolvers are
// deprecated in favour of el-resolvers
final String version = getVersion();
if (!IJSFCoreConstants.FACET_VERSION_1_0.equals(version) && !IJSFCoreConstants.FACET_VERSION_1_1.equals(version))
{
addMessageInfo(messages,
DiagnosticFactory.create_API_DEPRECATED_AFTER_VERSION_ID
("property-resolver", IJSFCoreConstants.FACET_VERSION_1_1, "el-resolver") //$NON-NLS-1$ //$NON-NLS-2$
, object, file);
}
}
}
private static class VariableResolverValidationVisitor extends ApplicationClassNameBasedValidationVisitor
{
VariableResolverValidationVisitor(final String version)
{
super(FacesConfigPackage.eINSTANCE.getApplicationType_VariableResolver(),
version, "javax.faces.el.VariableResolver", true); //$NON-NLS-1$
}
protected void doValidate(EObject object, List messages, IFile file) {
super.doValidate(object, messages, file);
// if this version greater than 1.1 then property resolvers are
// deprecated in favour of el-resolvers
final String version = getVersion();
if (!IJSFCoreConstants.JSF_VERSION_1_0.equals(version) && !IJSFCoreConstants.JSF_VERSION_1_1.equals(version))
{
addMessageInfo(messages,
DiagnosticFactory.create_API_DEPRECATED_AFTER_VERSION_ID
("variable-resolver", IJSFCoreConstants.JSF_VERSION_1_1, "el-resolver") //$NON-NLS-1$ //$NON-NLS-2$
, object, file);
}
}
}
private static class ELResolverValidationVisitor extends ApplicationClassNameBasedValidationVisitor
{
ELResolverValidationVisitor(final String version)
{
// must be a class and have zero-arg constructor
// JSF1.2_5.6.1.4
super(FacesConfigPackage.eINSTANCE.getApplicationType_ELResolver(),
version, "javax.el.ELResolver", true); //$NON-NLS-1$
}
protected void doValidate(EObject object, List messages, IFile file) {
// if this version less than 1.2 then property resolvers are
// deprecated in favour of el-resolvers
final String version = getVersion();
if (IJSFCoreConstants.JSF_VERSION_1_0.equals(version) || IJSFCoreConstants.JSF_VERSION_1_1.equals(version))
{
addMessageInfo(messages,
DiagnosticFactory.create_API_NOT_AVAILABLE_BEFORE_VERSION
("el-resolver", IJSFCoreConstants.JSF_VERSION_1_2, "variable-resolver or property-resolver") //$NON-NLS-1$ //$NON-NLS-2$
, object, file);
}
else
{
super.doValidate(object, messages, file);
}
}
}
private abstract static class ApplicationClassNameBasedValidationVisitor extends ClassNameEObjectValidationVisitor
{
private final String _instanceOf;
private final boolean _mustBeClass;
/**
* @param feature
* @param version
* @param instanceOf
* @param mustBeClass
*/
protected ApplicationClassNameBasedValidationVisitor(EStructuralFeature feature,
final String version, final String instanceOf, final boolean mustBeClass)
{
super(feature, version);
_instanceOf = instanceOf;
_mustBeClass = mustBeClass;
}
protected String getFullyQualifiedName(EObject eobj)
{
EStructuralFeature feature = eobj.eClass().getEStructuralFeature("textContent"); //$NON-NLS-1$
if (feature != null)
{
return (String)eobj.eGet(feature);
}
return null;
}
@Override
protected boolean mustBeClass() {
return _mustBeClass;
}
protected EObjectValidationVisitor[] getChildNodeValidators() {
// no children
return NO_CHILDREN;
}
protected String getInstanceOf() {
return _instanceOf;
}
}
// private static class PartialTraversalValidationVisitor extends ApplicationClassNameBasedValidationVisitor
// {
// PartialTraversalValidationVisitor(final String version)
// {
// super(FacesConfigPackage.eINSTANCE.getApplicationType_PartialTraversal(),
// version,"javax.faces.application.PartialTraversal", true); //$NON-NLS-1$
// }
// }
private static class ResourceHandlerValidationVisitor extends ApplicationClassNameBasedValidationVisitor
{
ResourceHandlerValidationVisitor(final String version)
{
super(FacesConfigPackage.eINSTANCE.getApplicationType_ResourceHandler(),
version,"javax.faces.application.ResourceHandler", true); //$NON-NLS-1$
}
}
// private static class PartialTraversalValidationVisitor extends ApplicationClassNameBasedValidationVisitor
// {
// PartialTraversalValidationVisitor(final String version)
// {
// super(FacesConfigPackage.eINSTANCE.getApplicationType_PartialTraversal(),
// version,"javax.faces.application.PartialTraversal", true); //$NON-NLS-1$
// }
// }
private static class SystemEventListenerTypeValidationVisitor extends EObjectValidationVisitor
{
SystemEventListenerTypeValidationVisitor(final String version)
{
super(FacesConfigPackage.eINSTANCE.getApplicationType_SystemEventListener(),
version);
}
@Override
protected void doValidate(final EObject eObject, final List messages, final IFile file) {
//validation takes place with childNodeValidators
}
@Override
protected EObjectValidationVisitor[] getChildNodeValidators() {
return new EObjectValidationVisitor[]{
new SystemEventListenerValidationVisitor(getVersion()),
new SystemEventListenerClassValidationVisitor(getVersion()),
new SystemEventListenerSourceClassValidationVisitor(getVersion())
};
}
}
private static class DefaultValidatorsValidationVisitor extends EObjectValidationVisitor
{
DefaultValidatorsValidationVisitor(final String version)
{
super(FacesConfigPackage.eINSTANCE.getApplicationType_DefaultValidators(),
version);
}
@Override
protected void doValidate(final EObject eObject, final List messages, final IFile file) {
//do nothing here... we should validate the ValidateIDType below
}
@Override
protected EObjectValidationVisitor[] getChildNodeValidators() {
//TODO - validate the ValidateIDTypes
return NO_CHILDREN;
}
}
private static class SystemEventListenerValidationVisitor extends ApplicationClassNameBasedValidationVisitor {
SystemEventListenerValidationVisitor(final String version)
{
super(FacesConfigPackage.eINSTANCE.getSystemEventListenerType_SystemEventListenerClass(),
version,"javax.faces.event.SystemEventListener", true); //$NON-NLS-1$
}
}
private static class SystemEventListenerClassValidationVisitor extends ApplicationClassNameBasedValidationVisitor {
SystemEventListenerClassValidationVisitor(final String version)
{
super(FacesConfigPackage.eINSTANCE.getSystemEventListenerType_SystemEventClass(),
version,"javax.faces.event.SystemEvent", true); //$NON-NLS-1$
}
}
private static class SystemEventListenerSourceClassValidationVisitor extends ApplicationClassNameBasedValidationVisitor {
SystemEventListenerSourceClassValidationVisitor(final String version)
{
super(FacesConfigPackage.eINSTANCE.getSystemEventListenerType_SourceClass(),
version,"java.lang.Object", true); //$NON-NLS-1$
}
}
}