public ConfigDescriptionModel() 
{
           
    content = new ArrayList();
}

Creates a new, initially empty ConfigDescriptionModel.

 public  void add(ConfigDescriptionEntry entry) 
{
    if (entry == null)
    {
      throw new NullPointerException(ConfigDescriptionModel.messages.getErrorString("ConfigDescriptionModel.ERROR_0001_ENTRY_IS_NULL")); //$NON-NLS-1$
    }
    // Only add unique elements ...
    final int index = findEntry(entry.getKeyName());
    if (index == -1)
    {
      content.add(entry);
      updated();
    }
    else
    {
      content.set(index, entry);
    }
}

Adds the given entry to the end of the list.

 public boolean contains(ConfigDescriptionEntry entry) 
{
    if (entry == null)
    {
      throw new NullPointerException(ConfigDescriptionModel.messages.getErrorString("ConfigDescriptionModel.ERROR_0004_ENTRY_IS_NULL")); //$NON-NLS-1$
    }
    return findEntry(entry.getKeyName())  > -1;
}

Checks whether the given entry is already contained in this list.

 public ConfigDescriptionEntry get(int pos) 
{
    return (ConfigDescriptionEntry) content.get(pos);
}

Returns the entry stored on the given list position.

 public Object getElementAt(int index) 
{
    final ConfigDescriptionEntry entry = get(index);
    if (entry == null)
    {
      return null;
    }
    return entry.getKeyName();
}

Returns the value at the specified index.

 public int getSize() 
{
    return content.size();
}

Returns the length of the list.

 public  void importFromConfig(Configuration config) 
{
    final Iterator it = config.findPropertyKeys(""); //$NON-NLS-1$
    while (it.hasNext())
    {
      final String keyname = (String) it.next();
      if (System.getProperties().containsKey(keyname))
      {
        continue;
      }
      final TextConfigDescriptionEntry entry = new TextConfigDescriptionEntry(keyname);
      if (contains(entry) == false)
      {
        add(entry);
      }
    }
}

Imports all entries from the given report configuration. Only new entries will be added to the list. This does not add report properties supplied via the System.properties.

 public int indexOf(ConfigDescriptionEntry entry) 
{
    if (entry == null)
    {
      throw new NullPointerException(ConfigDescriptionModel.messages.getErrorString("ConfigDescriptionModel.ERROR_0003_ENTRY_IS_NULL")); //$NON-NLS-1$
    }
    return findEntry(entry.getKeyName());
}

Returns the index of the given entry or -1, if the entry is not in the list.

 public  void load(InputStream in) throws IOException, SAXException, ParserConfigurationException 
{
    content.clear();
    final Document doc = DOMUtilities.parseInputStream(in);
    final Element e = doc.getDocumentElement();
    final NodeList list = e.getElementsByTagName("key"); //$NON-NLS-1$
    for (int i = 0; i <  list.getLength(); i++)
    {
      final Element keyElement = (Element) list.item(i);
      final String keyName = keyElement.getAttribute("name"); //$NON-NLS-1$
      final boolean keyGlobal = StringUtil.parseBoolean(keyElement.getAttribute("global"), false); //$NON-NLS-1$
      final boolean keyHidden = StringUtil.parseBoolean(keyElement.getAttribute("hidden"), false); //$NON-NLS-1$
      final String descr = getDescription(keyElement).trim();
      final NodeList enumNodes = keyElement.getElementsByTagName("enum"); //$NON-NLS-1$
      if (enumNodes.getLength() != 0)
      {
        final String[] alteratives = collectEnumEntries((Element) enumNodes.item(0));
        final EnumConfigDescriptionEntry en = new EnumConfigDescriptionEntry(keyName);
        en.setDescription(descr);
        en.setGlobal(keyGlobal);
        en.setHidden(keyHidden);
        en.setOptions(alteratives);
        add(en);
        continue;
      }
      final NodeList classNodes = keyElement.getElementsByTagName("class"); //$NON-NLS-1$
      if (classNodes.getLength() != 0)
      {
        final Element classElement = (Element) classNodes.item(0);
        final String className = classElement.getAttribute("instanceof"); //$NON-NLS-1$
        if (className == null)
        {
          throw new ParseException(ConfigDescriptionModel.messages.getErrorString("ConfigDescriptionModel.ERROR_0005_MISSING_INSTANCEOF")); //$NON-NLS-1$
        }
        try
        {
          final Class baseClass = ObjectUtilities.getClassLoader(getClass()).loadClass(className);
          final ClassConfigDescriptionEntry ce = new ClassConfigDescriptionEntry(keyName);
          ce.setBaseClass(baseClass);
          ce.setDescription(descr);
          ce.setGlobal(keyGlobal);
          ce.setHidden(keyHidden);
          add(ce);
          continue;
        }
        catch (Exception ex)
        {
          final String message = ConfigDescriptionModel.messages.getErrorString("ConfigDescriptionModel.ERROR_0006_BASE_CLASS_LOAD_FAILED"); //$NON-NLS-1$
          ConfigDescriptionModel.logger.error(message, ex);
          continue; 
        }
      }
      final NodeList textNodes = keyElement.getElementsByTagName("text"); //$NON-NLS-1$
      if (textNodes.getLength() != 0)
      {
        final TextConfigDescriptionEntry textEntry = new TextConfigDescriptionEntry(keyName);
        textEntry.setDescription(descr);
        textEntry.setGlobal(keyGlobal);
        textEntry.setHidden(keyHidden);
        add(textEntry);
      }
    }
}

Loads the entries from the given xml file. The file must be in the format of the config-description.xml file.

 public  void remove(ConfigDescriptionEntry entry) 
{
    if (entry == null)
    {
      throw new NullPointerException(ConfigDescriptionModel.messages.getErrorString("ConfigDescriptionModel.ERROR_0002_ENTRY_IS_NULL")); //$NON-NLS-1$
    }
    final int index = findEntry(entry.getKeyName());
    if (index != -1)
    {
      content.remove(index);
      updated();
    }
}

Removes the given entry from the list.

 public  void removeAll(int[] indices) 
{
    if (indices.length == 0)
    {
      return;
    }
    final Object[] entries = new Object[indices.length];
    for (int i = indices.length - 1; i  >= 0; i--)
    {
      entries[i] = content.get(indices[i]);
    }
    for (int i = 0; i <  entries.length; i++)
    {
      content.remove(entries[i]);
    }
    updated();
}

 public  void save(OutputStream out,
    String encoding) throws IOException 
{
    // This print-writer will be flushed, but not closed, as closing the underlying stream is not desired here.
    final PrintWriter writer = new PrintWriter(new OutputStreamWriter(out, encoding));
    final AttributeList attList = new AttributeList();
    attList.addNamespaceDeclaration("", ConfigGUIModule.NAMESPACE); //$NON-NLS-1$
    final DefaultTagDescription tagDescription = new DefaultTagDescription();
    tagDescription.configure
        (JFreeReportBoot.getInstance().getGlobalConfig(), "org.jfree.report.modules.gui.config.writer.");
    final XmlWriter dwriter = new XmlWriter(writer, tagDescription);
    dwriter.writeXmlDeclaration(encoding);
    dwriter.writeTag(ConfigGUIModule.NAMESPACE,
        "config-description", attList, XmlWriterSupport.OPEN); //$NON-NLS-1$
    final CharacterEntityParser parser = CharacterEntityParser.createXMLEntityParser();
    for (int i = 0; i <  getSize(); i++)
    {
      final ConfigDescriptionEntry entry = get(i);
      final AttributeList p = new AttributeList();
      p.setAttribute(ConfigGUIModule.NAMESPACE, "name", entry.getKeyName()); //$NON-NLS-1$
      p.setAttribute(ConfigGUIModule.NAMESPACE, "global", String.valueOf(entry.isGlobal())); //$NON-NLS-1$
      p.setAttribute(ConfigGUIModule.NAMESPACE, "hidden", String.valueOf(entry.isHidden())); //$NON-NLS-1$
      dwriter.writeTag(ConfigGUIModule.NAMESPACE, "key", p, XmlWriterSupport.OPEN); //$NON-NLS-1$
      if (entry.getDescription() != null)
      {
        dwriter.writeTag(ConfigGUIModule.NAMESPACE, "description", XmlWriterSupport.OPEN); //$NON-NLS-1$
        writer.write(parser.encodeEntities(entry.getDescription()));
        dwriter.writeCloseTag();
      }
      if (entry instanceof ClassConfigDescriptionEntry)
      {
        final ClassConfigDescriptionEntry ce = (ClassConfigDescriptionEntry) entry;
        if (ce.getBaseClass() != null)
        {
          dwriter.writeTag (ConfigGUIModule.NAMESPACE, "class", "instanceof", //$NON-NLS-1$ //$NON-NLS-2$
              ce.getBaseClass().getName(), XmlWriterSupport.CLOSE);
        }
        else
        {
          dwriter.writeTag(ConfigGUIModule.NAMESPACE, "class", "instanceof", //$NON-NLS-1$ //$NON-NLS-2$
              "java.lang.Object", XmlWriterSupport.CLOSE); //$NON-NLS-1$
        }
      }
      else if (entry instanceof TextConfigDescriptionEntry)
      {
        dwriter.writeTag(ConfigGUIModule.NAMESPACE, "text", //$NON-NLS-1$
            new AttributeList(), XmlWriterSupport.CLOSE);
      }
      else if (entry instanceof EnumConfigDescriptionEntry)
      {
        final EnumConfigDescriptionEntry en = (EnumConfigDescriptionEntry) entry;
        dwriter.writeTag(ConfigGUIModule.NAMESPACE, "enum", XmlWriterSupport.OPEN); //$NON-NLS-1$
        final String[] alts = en.getOptions();
        if (alts != null)
        {
          for (int optCount = 0; optCount <  alts.length; optCount++)
          {
            dwriter.writeTag(ConfigGUIModule.NAMESPACE, "text", XmlWriterSupport.OPEN); //$NON-NLS-1$
            dwriter.writeText(dwriter.normalizeLocal(alts[optCount], false));
            dwriter.writeCloseTag();
          }
        }
        dwriter.writeCloseTag();
      }
      dwriter.writeCloseTag();
    }
    dwriter.writeCloseTag();
    writer.flush();
}

Saves the model into an xml file.

 public  void sort() 
{
    Collections.sort(content, new ConfigEntryComparator());
    updated();
}

Sorts the entries of the list. Be aware that calling this method does not fire an updat event; you have to do this manually.

 public ConfigDescriptionEntry[] toArray() 
{
    return (ConfigDescriptionEntry[]) content.toArray (new ConfigDescriptionEntry[content.size()]);
}

Returns the contents of this model as object array.

 public  void updated() 
{
    fireContentsChanged(this, 0, getSize());
}

Fires an contents changed event for all elements in the list.