org.springmodules.cache.provider.ReflectionCacheModelEditor.java Source code

Introduction

Here is the source code for org.springmodules.cache.provider.ReflectionCacheModelEditor.java

Source

/* 
 * Created on Sep 9, 2005
 *
 * 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.
 *
 * Copyright @2005 the original author or authors.
 */
package org.springmodules.cache.provider;

import java.beans.PropertyEditor;
import java.beans.PropertyEditorSupport;
import java.util.Iterator;
import java.util.Map;
import java.util.Properties;

import org.springframework.beans.BeanWrapper;
import org.springframework.beans.BeanWrapperImpl;

import org.springmodules.cache.CachingModel;
import org.springmodules.cache.util.SemicolonSeparatedPropertiesParser;

/**
 * <p>
 * Creates a new instance of <code>{@link CachingModel}</code> by parsing a
 * String of the form
 * <code>propertyName1=propertyValue1;propertyName2=propertyValue2;propertyNameN=propertyValueN</code>.
 * </p>
 * 
 * @author Alex Ruiz
 */
public class ReflectionCacheModelEditor extends PropertyEditorSupport {

    /**
     * The class of the <code>{@link CachingModel}</code> to create.
     */
    private Class cacheModelClass;

    /**
     * <code>PropertyEditor</code>s for the properties of the cache model to
     * create. Each <code>PropertyEditor</code> is stored using the name of the
     * property (a String) as key.
     */
    private Map cacheModelPropertyEditors;

    /**
     * @return the class of the caching model to create
     */
    public final Class getCacheModelClass() {
        return cacheModelClass;
    }

    /**
     * @return the <code>PropertyEditor</code>s for the properties of the cache
     *         model to create. Each <code>PropertyEditor</code> is stored using
     *         the name of the property (a String) as key
     */
    public final Map getCacheModelPropertyEditors() {
        return cacheModelPropertyEditors;
    }

    /**
     * @throws IllegalStateException
     *           if the class of the cache model to create has not been set.
     * @see SemicolonSeparatedPropertiesParser#parseProperties(String)
     * @see PropertyEditor#setAsText(String)
     * @see org.springframework.beans.PropertyAccessor#setPropertyValue(String,
     *      Object)
     */
    public final void setAsText(String text) {
        if (cacheModelClass == null) {
            throw new IllegalStateException("cacheModelClass should not be null");
        }

        Properties properties = SemicolonSeparatedPropertiesParser.parseProperties(text);

        BeanWrapper beanWrapper = new BeanWrapperImpl(cacheModelClass);

        if (properties != null) {
            for (Iterator i = properties.keySet().iterator(); i.hasNext();) {
                String propertyName = (String) i.next();
                String textProperty = properties.getProperty(propertyName);

                Object propertyValue = null;

                PropertyEditor propertyEditor = getPropertyEditor(propertyName);
                if (propertyEditor != null) {
                    propertyEditor.setAsText(textProperty);
                    propertyValue = propertyEditor.getValue();
                } else {
                    propertyValue = textProperty;
                }
                beanWrapper.setPropertyValue(propertyName, propertyValue);
            }
        }

        setValue(beanWrapper.getWrappedInstance());
    }

    /**
     * Sets the class of the caching model to create
     * 
     * @param newCacheModelClass
     *          the new class
     */
    public final void setCacheModelClass(Class newCacheModelClass) {
        cacheModelClass = newCacheModelClass;
    }

    /**
     * Sets the <code>PropertyEditor</code>s for the properties of the cache
     * model to create. Each <code>PropertyEditor</code> is stored using the
     * name of the property (a String) as key.
     * 
     * @param newCacheModelPropertyEditors
     *          the new <code>PropertyEditor</code>s
     */
    public final void setCacheModelPropertyEditors(Map newCacheModelPropertyEditors) {
        cacheModelPropertyEditors = newCacheModelPropertyEditors;
    }

    private PropertyEditor getPropertyEditor(String propertyName) {
        return cacheModelPropertyEditors == null ? null
                : (PropertyEditor) cacheModelPropertyEditors.get(propertyName);
    }
}