package com.sourceforge.jpatterns.core.configuration.model;

 import com.sourceforge.jpatterns.schema.CastorNameScopePriorityType;

 import com.sourceforge.jpatterns.schema.CastorSectionType;

 import com.zmicer.utils.InputArgumentUtils;

 import com.zmicer.utils.ObjectStateUtils;

 import com.zmicer.utils.model.ICheckable;

 import org.apache.log4j.Logger;

 import java.util.ArrayList;

 import java.util.HashMap;

 import java.util.List;

 import java.util.Map;

 /**

  * This base class defines the fields are necessary for the defining the context of one/any combination of <code>JPatternsConfig</code>

  * castor objects. Also it contains the utility methods could be used for the forming this fields (all of them are collections) with the

  * appropriate information.

  * <br/>

  * Currently there are two types of the storages: sections and business items. Both of them are necessary for us as they could be use for

  * the differenty purposes. E.g. A. the logically separate global configuration item (we would use the business items storage) and

  * B. factory configuration is represented as storage - in this case for the retrieving the "factory" pattern we would find the appropriate

  * section based castor object, and then the concrete implementation of the factory would retrieve the business items.

  * <br/>

  * The fields are introduced here could be extended (or modified) in the case the structure of the <code>JPatternsConfig</code> castor

  * object would be changed (and we would need another storages for the configuration).

  * <p/>

  * note [zmicer]: be noticed some additional infrustructure methods may be required here.

  * note [zmicer]: class is not done as abstract to allow the convenient testing. Also there is possibility it could be used as is somewhere.

  *

  * $Author:: zmicer             $<br/>

  * $Rev:: 67                    $<br/>

  * $Date:: 2007-08-28 21:37:07 #$<br/>

  */

 public class JPatternsConfigBaseBean implements ICheckable

 {

     /**

      * Logger instance.

      */

     final public static Logger LOG = Logger.getLogger(JPatternsConfigBaseBean.class);

     /**

      * The structure is necessary for the fast access to the necessary business items using the path. This path is as follows:

      * Section Scope ID/ Section ID/ Item Scope ID/ Item Name

      * <br/>

      * 1st key is the scope of the section<br/>

      * 2nd key is the name of the section castor object <br/>

      * 3rd key is the scope of the appropriate CastorNameScopePriorityType object

      * 4rd key is the name of the appropriate CastorNameScopePriorityType object

      */

     private Map<String, Map<String, Map<String, Map<String, CastorNameScopePriorityType>>>> m_businessItems =

         new HashMap<String, Map<String, Map<String, Map<String, CastorNameScopePriorityType>>>>();

     /**

      * This structure stores the configuration related to the "section based" castor objects used at the JPatterns framework (these types

      * base on the <code>CastorSectionType</code> base castor type).

      * <br/>

      * This structure allows us to access the appropriate <code>CastorSectionType</code> object using two keys:<br/>

      * 1st key is the scope name,<br/>

      * 2nd kays is the name of the appropriate section

      */

     private Map<String, Map<String, CastorSectionType>> m_sectionItems =

         new HashMap<String, Map<String, CastorSectionType>>();

     /**

      * Default public constructor.

      * <br/>

      * Is tested at the setup method

      */

     public JPatternsConfigBaseBean()

     {

         super();

     }

     /**

      * Set the new value for the business items.

      * <br/>

      * Tested here <code>com.sourceforge.jpatterns.core.configuration.model.JPatternsConfigBaseBeanTest#testSetGetBusinessItems()</code>

      *

      * @param businessItems the new value for the business items storage.

      *                      Can not be null (otherwise <code>IllegalArgumentException</code> would appear).

      */

     public void setBusinessItems(Map<String, Map<String, Map<String, Map<String, CastorNameScopePriorityType>>>> businessItems)

     {

         InputArgumentUtils.checkObjects(businessItems);

         m_businessItems = businessItems;

     }

     /**

      * Tested here <code>com.sourceforge.jpatterns.core.configuration.model.JPatternsConfigBaseBeanTest#testSetGetBusinessItems()</code>

      *

      * @return the business items storage

      */

     public Map<String, Map<String, Map<String, Map<String, CastorNameScopePriorityType>>>> getBusinessItems()

     {

         return m_businessItems;

     }

     /**

      * Set the new value for the section items

      * <br/>

      * Tested here: com.sourceforge.jpatterns.core.configuration.model.JPatternsConfigBaseBeanTest#testSetGetSectionItems()

      *

      * @param sectionItems the section items storage

      *                     Can not be null (otherwise <code>IllegalArgumentException</code> would appear).

      */

     public void setSectionItems(Map<String, Map<String, CastorSectionType>> sectionItems)

     {

         InputArgumentUtils.checkObjects(sectionItems);

         m_sectionItems = sectionItems;

     }

     /**

      * Tested here: com.sourceforge.jpatterns.core.configuration.model.JPatternsConfigBaseBeanTest#testSetGetSectionItems()

      *

      * @return the section items storage

      */

     public Map<String, Map<String, CastorSectionType>> getSectionItems()

     {

         return m_sectionItems;

     }

     /**

      * @return another representation of the section items - the List of the <code>CastorSectionType</code> objects.

      */

     public List<CastorSectionType> getListOfSectionItems()

     {

         final List<CastorSectionType> result = new ArrayList<CastorSectionType>();

         for (String scope : m_sectionItems.keySet())

         {

             for (String sectionName : m_sectionItems.get(scope).keySet())

             {

                 result.add(m_sectionItems.get(scope).get(sectionName));

             }

         }

         return result;

     }

     /**

      * @see com.zmicer.utils.model.ICheckable#check()

      */

     public boolean check()

     {

         return (null != m_businessItems && null != m_sectionItems);

     }

     /**

      * Get the business item - the instance of the CastorNameScopePriorityType class.

      * <br/>

      * Tested here: com.sourceforge.jpatterns.core.configuration.model.JPatternsConfigBaseBeanTest#testSetGetBusinessItem()

      *

      * @param sectionScope section scope id. Can not be null (otherwise <code>IllegalArgumentException</code> would appear).

      * @param sectionName  section name. Can not be null (otherwise <code>IllegalArgumentException</code> would appear).

      * @param itemScope    item scope. Can not be null (otherwise <code>IllegalArgumentException</code> would appear).

      * @param itemName     business item name. Can not be null (otherwise <code>IllegalArgumentException</code> would appear).

      *

      * @return the appropriate <code>CastorNameScopePriorityType</code> castor object or the <code>null</code> in the case

      *         the provided path (these three keys) do not point to the real castor object.

      */

     public CastorNameScopePriorityType getBusinessItem(final String sectionScope, final String sectionName, final String itemScope,

         final String itemName)

     {

         InputArgumentUtils.checkStrings(true, sectionScope, sectionName, itemScope, itemName);

         ObjectStateUtils.strongCheck(this);

         try

         {

             return m_businessItems.get(sectionScope).get(sectionName).get(itemScope).get(itemName);

         }

         catch (NullPointerException npe)

         {

             // just catch

         }

         return null;

     }

     /**

      * Set the provided business item using the provided path. In the case some parts of the path are not constructed yet - they would be

      * constructed (new maps would be created). In the case another business items has been already stored under the same path -

      * it would be replaced by this one.

      * <br/>

      * tested here:com.sourceforge.jpatterns.core.configuration.model.JPatternsConfigBaseBeanTest#testSetGetBusinessItem()

      *

      * @param sectionScope sectionScope name. Can not be null (otherwise <code>IllegalArgumentException</code> would appear).

      * @param sectionName  section name. Can not be null (otherwise <code>IllegalArgumentException</code> would appear).

      * @param item         the castor object to be stored. Can not be null (otherwise <code>IllegalArgumentException</code> would appear).

      *                     The item name would be get from this bean too, so <code>item.getName()</code> should not return null or empty

      *                     String (<code>IllegalArgumentException</code> would appear in this wrong case)

      */

     public void setBusinessItem(final String sectionScope, final String sectionName, final CastorNameScopePriorityType item)

     {

         InputArgumentUtils.checkObjects(item);

         InputArgumentUtils.checkStrings(true, sectionScope, sectionName, item.getName(), item.getScope());

         ObjectStateUtils.strongCheck(this);

         if (null == m_businessItems.get(sectionScope))

         {

             m_businessItems.put(sectionScope, new HashMap<String, Map<String, Map<String, CastorNameScopePriorityType>>>());

         }

         if (null == m_businessItems.get(sectionScope).get(sectionName))

         {

             m_businessItems.get(sectionScope).put(sectionName, new HashMap<String, Map<String, CastorNameScopePriorityType>>());

         }

         if (null == m_businessItems.get(sectionScope).get(sectionName).get(item.getScope()))

         {

             m_businessItems.get(sectionScope).get(sectionName).put(item.getScope(), new HashMap<String, CastorNameScopePriorityType>());

         }

         m_businessItems.get(sectionScope).get(sectionName).get(item.getScope()).put(item.getName(), item);

     }

     /**

      * Get the section type castor object by the pointed path (basing on the scope/section name string)

      *

      * @param scope       the scope name. Can not be null (otherwise <code>IllegalArgumentException</code> would appear).

      * @param sectionName the section name. Can not be null (otherwise <code>IllegalArgumentException</code> would appear).

      *

      * @return the <code>CastorSectionType</code> castor object in the case of success or <code>null</code> otherwise..

      */

     public CastorSectionType getSection(final String scope, final String sectionName)

     {

         InputArgumentUtils.checkStrings(true, scope, sectionName);

         ObjectStateUtils.strongCheck(this);

         if (null != m_sectionItems.get(scope))

         {

             return m_sectionItems.get(scope).get(sectionName);

         }

         return null;

     }

     /**

      * Set the pointed section <code>CastorSectionType</code> castor object to the map is used for this purposes.

      *

      * @param scope   the name of the scope the provided CastorSectionType castor object should belong.

      *                Can not be null (otherwise <code>IllegalArgumentException</code> would appear).

      * @param section <code>CastorSectionType</code> castor object which is based for all the "section based" JPatterns configurations items

      */

     public void setSection(final String scope, final CastorSectionType section)

     {

         InputArgumentUtils.checkObjects(section);

         InputArgumentUtils.checkStrings(true, scope, section.getName());

         ObjectStateUtils.strongCheck(this);

         if (null == m_sectionItems.get(scope))

         {

             m_sectionItems.put(scope, new HashMap<String, CastorSectionType>());

         }

         m_sectionItems.get(scope).put(section.getName(), section);

     }

 }