taglibs-rdc/src/main/java/org/apache/taglibs/rdc/core/ComponentModel.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.taglibs.rdc.core;

import java.io.Serializable;
import java.util.Map;
import java.util.LinkedHashMap;
import javax.servlet.jsp.JspContext;

import org.apache.taglibs.rdc.RDCUtils;
/**
 * <p>This is the base class for component models
 * of composite RDCs.</p>
 * 
 * @author Abhishek Verma
 * @author Rahul Akolkar
 */
public class ComponentModel extends BaseModel 
implements Serializable{
    // Serial Version UID
    private static final long serialVersionUID = 1L;
    // The map of datamodel of child RDCs; keyed by id 
    protected Map localMap;
    // The map of non-default configs of child RDCs; keyed by id 
    protected Map configMap;
    // The map of datamodel of child RDCs; keyed by id 
    protected String config;
    // The map of datamodel of child RDCs; keyed by id 
    protected JspContext context;
    
    public ComponentModel() {
        super();
        this.localMap = new LinkedHashMap();
        this.configMap = new LinkedHashMap();
    } // ComponentModel constructor
   
    
    /** 
     * Get the map of child RDC datamodels
     * 
     * @return the map of child RDC datamodels
     */
    public Map getLocalMap() {
        return localMap;
    }
    
    /**
     * Set the map of child RDC datamodels
     * 
     * @param localMap The map of child RDC datamodels
     */
    public void setLocalMap(Map localMap) {
        this.localMap = localMap;
    }
    

    /**
     * Get the map of configuration file URIs
     *  
     * @return the map of configuration file URI of child RDCs
     */
    public Map getConfigMap() {
        return configMap;
    }
    
    /**
     * Set the map of configuration file URI of child RDCs
     * 
     * @param configMap The map of configuration file URI of child RDCs
     */
    public void setConfigMap(Map configMap) {
        this.configMap = configMap;
    }
    
    /**
     * Set the context in which this component is executing
     * 
     * @param ctx The JspContext
     */
    public void setContext(JspContext ctx) {
        this.context = ctx;
    }

    /**
     * Set the configuration URI
     * 
     * @param newConfig The new configuration file URI
     */    
    public void setConfig(String newConfig) {
        if (!RDCUtils.isStringEmpty(newConfig)) {
            this.config = newConfig;
            configHandler();
        }
    }

    /**
     * Hook for subclasses to interpret the config attribute
     */        
    protected void configHandler() {
        // hook for subclasses
    }

    
}