package org.naftulin.configmgr.content;

 import java.util.Collections;

 import java.util.LinkedList;

 import java.util.List;

 import org.naftulin.configmgr.parsers.ConfigEntryParser;

 import org.naftulin.configmgr.parsers.MasterRecordParser;

 import org.apache.commons.lang.builder.ToStringBuilder;

 /**

  * Parses config.xml file: properties file, log4j xml or log4j properties.

  * Once a master record is created, parsers are called for each of the entries

  * to be parsed and stored in config manager. Entry is similar to config manager

  * entry, yet there is no content (since the entry was not parsed yet).

  * 

  * @author Henry Naftulin

  * @since 1.0

  */

 public class MasterRecordImpl extends AbstractRecordImpl {

         private static final ConfigEntryParser PARSER = new MasterRecordParser();

         private boolean jmx = true;

         private final List<AbstractRecordImpl> records = new LinkedList<AbstractRecordImpl>();

         /**

          * Constructs a record without specifying the key or file name.

          */

         public MasterRecordImpl() {

                 super();

         }

         /**

          * Constructs a record with the key and file name specified.

          * @param key the key associated with the record.

          * @param fileName the file name associated with the record.

          */

         public MasterRecordImpl(final String key, final String fileName) {

                 super(key, fileName);

         }

         /**

          * Returns Jmx setting for configuration manager. By defaul the jmx

          * setting is true, which means that configuration manager will try to

          * connect to JMX MBean server.

          * @return returns Jmx setting for configuration manager.

          */

         public boolean isJmx() { 

                 return jmx;

         }

         /**

          * Sets Jmx setting for configuration manager. When Jmx

          * setting equals true, configuration manager will try to

          * connect to JMX MBean server.

          * @param jmx jmx setting

          */

         public void setJmx(boolean jmx) {

                 this.jmx = jmx;

         }

         /**

          * Adds a record to the list of records to be processed. Mirrors the

          * master file which consists of configuration records. 

          * @param record the record to be processed, read from the master configuration file

          */

         public void addRecord(final AbstractRecordImpl record) {

                 records.add(record);

         }

         /**

          * Returns the unmodifiable list of {@link AbstractRecordImpl records} from the cofiguration file.

          * @return a list of {@link AbstractRecordImpl records} from the cofiguration file.

          */

         public List<AbstractRecordImpl> getRecords() {

                 return Collections.unmodifiableList(records);

         }

         /**

          * Returns master record parser. The master record is

          * processed by configuration manager with a special parser; and is

          * not re-parsed when transofrmed to configuration manager entry. 

          * @return Returns master record parser.

          */

         public ConfigEntryParser getParser() {

                 return PARSER;

         }

         /**

          * Returns the string representation of the master record.

          * @return the string representation of the master record.

          */

         public String toString() {

                 return new ToStringBuilder(this)

                                 .append("key", this.getKey())

                                 .append("jmx", this.isJmx())

                                 .append("parser", this.getParser())

                                 .append("fileName",this.getFileName())

                                 .append("records", this.records).toString();

         }

 }