/*
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* This program 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.
*
* Copyright (c) 2006 - 2013 Pentaho Corporation.. All rights reserved.
*/
package org.pentaho.reporting.engine.classic.core.testsupport.base;
import java.util.ArrayList;
import java.util.Locale;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.pentaho.reporting.engine.classic.core.function.Expression;
import org.pentaho.reporting.engine.classic.core.metadata.ExpressionMetaData;
import org.pentaho.reporting.engine.classic.core.metadata.ExpressionPropertyMetaData;
import org.pentaho.reporting.engine.classic.core.metadata.ExpressionRegistry;
public class ExpressionTestHelper
{
private static final Log logger = LogFactory.getLog(ExpressionTestHelper.class);
private ExpressionTestHelper()
{
}
public static boolean validateElementMetaData(Class<? extends Expression> elementType)
{
ExpressionMetaData metaData = ExpressionRegistry.getInstance().getExpressionMetaData(elementType.getName());
if (metaData == null)
{
logger.warn("No Metadata defined");
return false;
}
if (validateCanInstantiate(metaData))
{
return false;
}
final String typeName = metaData.getName();
logger.debug("Processing " + typeName);
ArrayList<String> missingProperties = new ArrayList<String>();
validateCoreMetaData(metaData, missingProperties);
validatePropertyMetaData(metaData, missingProperties);
flushSystemErr();
for (String property : missingProperties)
{
System.out.println(property);
}
return missingProperties.isEmpty();
}
private static void flushSystemErr()
{
System.err.flush();
try
{
Thread.sleep(25);
}
catch (InterruptedException e)
{
// wait for system.error to print. it makes the logging cleaner
}
}
private static boolean validateCanInstantiate(final ExpressionMetaData metaData)
{
final Object type = metaData.create();
if (type == null)
{
return true;
}
return false;
}
private static void validateCoreMetaData(final ExpressionMetaData metaData,
final ArrayList<String> missingProperties)
{
final Locale locale = Locale.getDefault();
final String typeName = metaData.getName();
final String displayName = metaData.getDisplayName(locale);
if (isValid(displayName, metaData.getName(), missingProperties) == false)
{
logger.warn("ExpressionMetaData '" + typeName + ": No valid display name");
}
if (metaData.isDeprecated())
{
final String deprecateMessage = metaData.getDeprecationMessage(locale);
if (isValid(deprecateMessage, "Property", missingProperties) == false)
{
logger.warn("ExpressionMetaData '" + typeName + ": No valid deprecate message");
}
}
final String grouping = metaData.getGrouping(locale);
if (isValid(grouping, "User-Defined", missingProperties) == false)
{
logger.warn("ExpressionMetaData '" + typeName + ": No valid grouping message");
}
}
private static void validatePropertyMetaData(final ExpressionMetaData metaData,
final ArrayList<String> missingProperties)
{
final Locale locale = Locale.getDefault();
final String typeName = metaData.getName();
final ExpressionPropertyMetaData[] styleMetaDatas = metaData.getPropertyDescriptions();
for (int j = 0; j < styleMetaDatas.length; j++)
{
final ExpressionPropertyMetaData propertyMetaData = styleMetaDatas[j];
final String propertyDisplayName = propertyMetaData.getDisplayName(locale);
if (isValid(propertyDisplayName, propertyMetaData.getName(), missingProperties) == false)
{
logger.warn("ExpressionMetaData '" + typeName + ": Property " + propertyMetaData.getName() + ": No DisplayName");
}
final String propertyGrouping = propertyMetaData.getGrouping(locale);
if (isValid(propertyGrouping, "Required", missingProperties) == false)
{
logger.warn("ExpressionMetaData '" + typeName + ": Property " + propertyMetaData.getName() + ": Grouping is not valid");
}
if (propertyMetaData.isDeprecated())
{
final String deprecateMessage = propertyMetaData.getDeprecationMessage(locale);
if (isValid(deprecateMessage, "Deprecated", missingProperties) == false)
{
logger.warn(
"ExpressionMetaData '" + typeName + ": Property " + propertyMetaData.getName() + ": No valid deprecate message");
}
}
}
}
private static boolean isValid(String translation, String displayName, ArrayList<String> missingProperties)
{
if (translation == null)
{
return false;
}
if (translation.length() > 2 &&
translation.charAt(0) == '!' &&
translation.charAt(translation.length() - 1) == '!')
{
final String retval = translation.substring(1, translation.length() - 1);
missingProperties.add(retval + "=" + displayName);
return false;
}
return true;
}
}