TableModelUtils.java

/*
 * Copyright 2004 original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.extremecomponents.table.core;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Locale;

import org.apache.commons.beanutils.PropertyUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.extremecomponents.table.bean.Column;

import org.extremecomponents.table.callback.RetrieveRowsCallback;
import org.extremecomponents.table.cell.Cell;
import org.extremecomponents.table.context.Context;
import org.extremecomponents.table.limit.Sort;
import org.extremecomponents.util.ExtremeUtils;

/**
 * Helpful utilities directly related to the TableModel.
 * 
 * @author Jeff Johnston
 */
public final class TableModelUtils {
    private static Log logger = LogFactory.getLog(TableModelUtils.class);

    private TableModelUtils() {
    }

    static Collection retrieveRows(TableModel model,Collection rows)
            throws Exception {
        RetrieveRowsCallback retrieveRowsCallback = TableCache.getInstance().getRetrieveRowsCallback(model);

        return retrieveRowsCallback.retrieveRows(model,rows);
    }

    public static boolean isSorted(TableModel model, String alias) {
        Sort sort = model.getLimit().getSort();

        if (sort.isSorted() && alias.equals(sort.getAlias())) {
            return true;
        }

        return false;
    }

    /**
     * Determine whether or not this is a resource bundle key. It is a resource
     * bundle key if the value has a '.' character in it.
     * 
     * @param value The value that will be inspected to find out if resource key
     * @return True if this is a resource bundle key
     */
    public static boolean isResourceBundleProperty(String value) {
        if (StringUtils.contains(value, ".")) {
            return true;
        }

        return false;
    }

    public static Locale getLocale(Context context, Preferences preferences, String locale) {
        if (StringUtils.isEmpty(locale)) {
            locale = preferences.getPreference(PreferencesConstants.TABLE_LOCALE);
        }

        if (StringUtils.isBlank(locale)) {
            return context.getLocale();
        }

        Locale result = null;

        String parts[] = StringUtils.split(locale, "_");
        String language = parts[0];
        if (parts.length == 2) {
            String country = parts[1];
            result = new Locale(language, country);
        } else {
            result = new Locale(language, "");
        }

        return result;
    }

    public static String getPreferencesLocation(Context context) {
        String result = (String) context.getApplicationInitParameter(TableConstants.PREFERENCES_LOCATION);
        if (StringUtils.isNotBlank(result)) {
            return result;
        }

        if (logger.isDebugEnabled()) {
            logger.debug("There are no custom preferences defined. You need to include the context-param "
                    + "extremecomponentsPreferencesLocation in the web.xml to include custom preferences.");
        }

        return null;
    }

    public static String getMessagesLocation(Context context) {
        String result = (String) context.getApplicationInitParameter(TableConstants.MESSAGES_LOCATION);
        if (StringUtils.isNotBlank(result)) {
            return result;
        }

        if (logger.isDebugEnabled()) {
            logger.debug("There are no custom messages defined. You need to include the context-param "
                    + "extremecomponentsMessagesLocation in the web.xml to include custom messages.");
        }

        return null;
    }

    public static Cell getCell(Column column) {
        Cell cell = TableCache.getInstance().getCell(column.getCell());
        return cell;
    }

    public static Cell getFilterCell(Column column, Object value) {
        Cell cell = TableCache.getInstance().getCell(column.getFilterCell());
        column.setValue(value);
        return cell;
    }

    public static Cell getHeaderCell(Column column, Object value) {
        Cell cell = TableCache.getInstance().getCell(column.getHeaderCell());
        column.setValue(value);
        return cell;
    }

    public static String getInterceptColumnPreference(TableModel model, String intercept) {
        return getInterceptPreference(model, intercept, PreferencesConstants.COLUMN_INTERCEPTOR);
    }

    public static String getInterceptRowPreference(TableModel model, String intercept) {
        return getInterceptPreference(model, intercept, PreferencesConstants.ROW_INTERCEPTOR);
    }

    public static String getInterceptPreference(TableModel model, String intercept, String interceptPreference) {
        String result;

        if (StringUtils.isNotBlank(intercept)) {
            result = model.getPreferences().getPreference(interceptPreference + intercept);
            if (StringUtils.isBlank(result)) {
                result = intercept;
            }
        } else {
            result = model.getPreferences().getPreference(interceptPreference + TableConstants.DEFAULT_INTERCEPT);
        }

        return result;
    }

    public static String getAlias(String alias, String property) {
        if (StringUtils.isBlank(alias) && StringUtils.isNotBlank(property)) {
            return property;
        }

        return alias;
    }

    public static Object getColumnPropertyValue(Object bean, String property) {
        Object result = null;

        try {
            if (ExtremeUtils.isBeanPropertyReadable(bean, property)) {
                result = PropertyUtils.getProperty(bean, property);
            }
        } catch (Exception e) {
            if (logger.isDebugEnabled()) {
                logger.debug("Could not find the property [" + property + "]. Either the bean or property is null");
            }
        }

        return result;
    }

    public static String getAutoGenerateColumnsPreference(TableModel model, String autoGenerateColumns) {
        String result = autoGenerateColumns;

        if (StringUtils.isNotBlank(autoGenerateColumns)) {
            result = model.getPreferences().getPreference(
                    PreferencesConstants.COLUMNS_AUTO_GENERATE_COLUMNS + autoGenerateColumns);
            if (StringUtils.isBlank(result)) {
                result = autoGenerateColumns;
            }
        }

        return result;
    }
    
    public static Messages getMessages(TableModel model) {
        String messages = model.getPreferences().getPreference(PreferencesConstants.MESSAGES);
        try {
            Class classDefinition = Class.forName(messages);
            return (Messages) classDefinition.newInstance();

        } catch (Exception e) {
            String msg = "Could not create the messages [" + messages + "]. The class was not found or does not exist.";
            logger.error(msg, e);
            throw new IllegalStateException(msg);
        }
    }

    /**
     * The value needs to be a String[]. A String, Null, or List will be
     * converted to a String[]. In addition it will attempt to do a String
     * conversion for other object types.
     * 
     * @param value The value to convert to an String[]
     * @return A String[] value.
     */
    public static String[] getValueAsArray(Object value) {
        if (value == null) {
            return new String[] {}; // put in a placeholder
        }

        if (value instanceof String[]) {
            return (String[]) value;
        } else if (value instanceof List) {
            List valueList = (List) value;
            return (String[]) valueList.toArray(new String[valueList.size()]);
        }

        return new String[] { value.toString() };
    }
}