/*
      Copyright 2007 Ivo Limmen
   
      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.limmen.crs.model;
  
  import java.util.ArrayList;
  import java.util.List;
  
  import org.limmen.crs.exception.ConfigurationException;
  import org.limmen.crs.exception.SectionNotFoundException;
  import org.limmen.crs.exception.SettingNotFoundException;
  
  /***
   * The Configuration class is a container for sections that contains all
   * settings.
   *
   * @author Ivo Limmen
   * @see Section
   * @see Setting
   */
  public class Configuration implements java.io.Serializable {
  
  	private static final long serialVersionUID = -7002796947675718127L;
  
  	private Configuration baseConfiguration;
  
  	private List<Documentation> documentations = new ArrayList<Documentation>();
  
  	private final String id;
  
  	private List<Section> sections = new ArrayList<Section>();
  
  	/***
  	 * Create a new configuration with an ID.
  	 *
  	 * @param id
  	 *           a unique identifier for this configuration
  	 */
  	public Configuration(String id) {
  
  		this(id, null);
  	}
  
  	/***
  	 * Full constructor for the Configuration object, creates a Configuration
  	 * with a unique identifier, a base configuration (may be NULL) and a list
  	 * of documentation items (may also be NULL).
  	 *
  	 * @param id unique identifier for this configuration object
  	 * @param baseConfiguration configuration this configuration is based on
  	 * @param documentation a list of {@link Documentation} objects that provide
  	 * 		information on this configuration
  	 */
  	public Configuration(String id, Configuration baseConfiguration) {
  
  		super();
  
  		this.id = id;
  		setBaseConfiguration(baseConfiguration);
  	}
  
  	public void addDocumentation(Documentation documentation) {
  
  		getDocumentation().add(documentation);
  	}
  
  	public void addDocumentation(String aSectionId, Documentation documentation) {
  
  		createSection(aSectionId);
  
  		Section section = getUncheckedSection(aSectionId);
  
  		section.getDocumentation().add(documentation);
  	}
  
  	public void addDocumentation(String aSectionId, String aSettingId, Documentation documentation) {
  
  		createSection(aSectionId);
  
  		Section section = getUncheckedSection(aSectionId);
  
  		section.getDocumentation().add(documentation);
  	}
  
  	public void addSetting(String aSectionId, Setting newSetting) {
  
  		createSection(aSectionId);
 
 		Section section = getUncheckedSection(aSectionId);
 
 		if (getBaseConfiguration() != null) {
 
 			if (!getBaseConfiguration().settingExists(aSectionId, newSetting.getId())) {
 
 				throw new IllegalArgumentException(
 						String.format(
 								"Setting '%0$s' does not exist in the base configuration",
 								newSetting.getId()));
 			}
 		}
 
 		section.addSetting(newSetting);
 	}
 
 	private void createSection(String newSectionId) {
 
 		if (!sectionExists(newSectionId)) {
 
 			if (getBaseConfiguration() != null) {
 
 				if (!getBaseConfiguration().sectionExists(newSectionId)) {
 
 					throw new IllegalArgumentException(
 							String.format(
 									"Section '%0$s' does not exist in the base configuration",
 									newSectionId));
 				}
 			}
 
 			getSections().add(new Section(newSectionId));
 		}
 	}
 
 	@Override
 	public boolean equals(Object obj) {
 
 		if (obj.getClass().equals(getClass())) {
 
 			Configuration other = (Configuration) obj;
 
 			if (getId().equals(other.getId())) {
 
 				if (getSections().equals(other.getSections())) {
 
 					return true;
 				}
 			}
 		}
 
 		return false;
 	}
 
 	public Configuration getBaseConfiguration() {
 
 		return baseConfiguration;
 	}
 
 	public List<Documentation> getDocumentation() {
 
 		return documentations;
 	}
 
 	public List<Documentation> getDocumentation(String aSectionId) throws SectionNotFoundException {
 
 		return getSection(aSectionId).getDocumentation();
 	}
 
 	public List<Documentation> getDocumentation(String aSectionId, String aSettingId) throws SectionNotFoundException, SettingNotFoundException {
 
 		return getSetting(aSectionId, aSettingId).getDocumentation();
 	}
 
 	public String getId() {
 
 		return this.id;
 	}
 
 	public Section getSection(String aSectionId) throws SectionNotFoundException {
 
 		for (Section section : getSections()) {
 
 			if (section.getId().equals(aSectionId)) {
 
 				return section;
 			}
 		}
 
 		throw new SectionNotFoundException(
 				String.format("Section '%0$s' not found", aSectionId));
 	}
 
 	public List<Section> getSections() {
 
 		return this.sections;
 	}
 
 	/***
 	 * Retrieve a setting from this configuration object, when it is not found the configuration object will try to
 	 * retrieve the setting from it's base configuration if it available.
 	 *
 	 * @param aSection
 	 *           the section to retrieve the setting from
 	 * @param aSetting
 	 *           the setting to locate
 	 * @return a {@link Setting} object
 	 * @throws ConfigurationException
 	 *            when the section or setting is not found
 	 */
 	public Setting getSetting(String aSection, String aSetting) throws SectionNotFoundException,
 	                                                           SettingNotFoundException {
 
 		try {
 
 			return getSection(aSection).getSetting(aSetting);
 		}
 		catch (ConfigurationException ce) {
 
 			if (getBaseConfiguration() != null) {
 
 				return getBaseConfiguration().getSection(aSection).getSetting(aSetting);
 			}
 
 			// retrow the correct class
 			if (ce instanceof SettingNotFoundException) {
 
 				throw (SettingNotFoundException) ce;
 			}
 			else {
 
 				throw (SectionNotFoundException) ce;
 			}
 		}
 	}
 
 	private Section getUncheckedSection(String aSectionId) {
 
 		for (Section section : getSections()) {
 
 			if (section.getId().equals(aSectionId)) {
 
 				return section;
 			}
 		}
 
 		return null;
 	}
 
 	@Override
 	public int hashCode() {
 
 		final int prime = 31;
 		int result = 1;
 		result = prime * result + ((id == null) ? 0 : id.hashCode());
 		result = prime * result + ((sections == null) ? 0 : sections.hashCode());
 		return result;
 	}
 
 	/***
 	 * Returns <code>true</code> when the specified section id exists.
 	 */
 	private boolean sectionExists(String sectionId) {
 
 		for (Section section : getSections()) {
 
 			if (section.getId().equals(sectionId)) {
 
 				return true;
 			}
 		}
 
 		return false;
 	}
 
 	public void setBaseConfiguration(Configuration baseConfiguration) {
 
 		this.baseConfiguration = baseConfiguration;
 	}
 
 	public void setDocumentation(List<Documentation> documentations) {
 
 		this.documentations = documentations;
 	}
 
 	public void setSections(List<Section> sections) {
 
 		this.sections = sections;
 	}
 
 	/***
 	 * Returns <code>true</code> when the specified setting id exists in a
 	 * specified section id.
 	 */
 	boolean settingExists(String sectionId, String settingId) {
 
 		Section selectedSection = null;
 
 		for (Section section : getSections()) {
 
 			if (section.getId().equals(sectionId)) {
 
 				selectedSection = section;
 			}
 		}
 
 		if (selectedSection == null) {
 
 			return false;
 		}
 
 		for (Setting setting : selectedSection.getSettings()) {
 
 			if (setting.getId().equals(settingId)) {
 
 				return true;
 			}
 		}
 
 		return false;
 	}
 }