package org.naftulin.configmgr.content;

 import java.util.Collections;

 import java.util.LinkedList;

 import java.util.List;

 import org.naftulin.configmgr.ConfigurationManagerException;

 import org.naftulin.configmgr.parsers.ConfigEntryParser;

 import org.naftulin.configmgr.parsers.ExternalConfigurationParserImpl;

 /**

  * Represents an external entry, with it's key, name-value pairs and parser class.

  * Intended to mirror master configuration rules for external configuration.

  * The external configuraton xml is:

  * <pre>

  *         <external key="the key" configEntryAdatorClass="the fully qualified parser class">

                 <param name="key1" value="value1" />

                 .....

                 <param name="keyn" value="valuen" />

         </external>

  * </pre>

  * where <code>configEntryParserClass</code> is a class implementing {@link org.naftulin.configmgr.parsers.ExternalRecordAdapter 

  * ExternalRecordAdapter} interface.

  * @author Henry Henry

  * @since 1.0

  */

 public class ExternalRecordImpl extends AbstractRecordImpl {

         private final List<NameValuePairImpl> nameValuePairs = new LinkedList<NameValuePairImpl>();

         private String configEntryAdaptorClass;

         private final ExternalConfigurationParserImpl parser = new ExternalConfigurationParserImpl();

         /**

          * Adds a name-value pair as it is read from the master configuration.

          * @param nameValuePair the name value pair.

          */

         public void addNameValuePair(final NameValuePairImpl nameValuePair) {

                 nameValuePairs.add(nameValuePair);

         }

         /**

          * Sets the configuration entry adapter class. This class will handle 

          * adapting the loading and  reloading of the configurations by calling 

          * load and reload methods on the original, exteral interface. 

          * @param adaptor the fully qualified name of the adaptor implementation class.

          */

         public void setConfigEntryAdaptorClass(final String adaptor) {

                 configEntryAdaptorClass = adaptor;

         }

         /**

          * Returns an instance of {@link ExternalConfigurationParserImpl parser} that can parse the file to extract the configuration.

          * @return the parser that can parse the file to extract the configuration.

          * @throws ConfigurationManagerException if an error occured while instantiating the parser.

          */

         public ConfigEntryParser getParser() throws ConfigurationManagerException {

                 parser.setNameValuePairs(Collections.unmodifiableList(nameValuePairs));

                 parser.setExternalRecordAdapterClass(configEntryAdaptorClass);

                 return parser;

         }

 }