gcbatchprocessorhelper.h

/* Copyright (c) 2012 - 2013 by William Hallatt.
 *
 * This file forms part of "XML Mill".
 *
 * The official website for this project is <http://www.goblincoding.com> and,
 * although not compulsory, it would be appreciated if all works of whatever
 * nature using this source code (in whole or in part) include a reference to
 * this site.
 *
 * Should you wish to contact me for whatever reason, please do so via:
 *
 *                 <http://www.goblincoding.com/contact>
 *
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program (GNUGPL.txt).  If not, see
 *
 *                    <http://www.gnu.org/licenses/>
 */

#ifndef GCBATCHPROCESSORHELPER_H
#define GCBATCHPROCESSORHELPER_H

#include <QMap>
#include <QMultiHash>
#include <QStringList>
#include <QVariantList>

class QDomDocument;
class QDomElement;


class GCBatchProcessorHelper
{
public:
  GCBatchProcessorHelper( const QDomDocument* domDoc,
                          const QString& stringSeparator,
                          const QStringList& knownElements,
                          const QStringList& knownAttributes );

  const QVariantList& newElementsToAdd() const;

  const QVariantList& newElementChildrenToAdd() const;

  const QVariantList& newElementAttributesToAdd() const;

  const QVariantList& elementsToUpdate() const;

  const QVariantList& elementChildrenToUpdate() const;

  const QVariantList& elementAttributesToUpdate() const;

  const QVariantList& newAttributeKeysToAdd() const;

  const QVariantList& newAssociatedElementsToAdd() const;

  const QVariantList& newAttributeValuesToAdd() const;

  const QVariantList& attributeKeysToUpdate() const;

  const QVariantList& associatedElementsToUpdate() const;

  const QVariantList& attributeValuesToUpdate() const;

private:
  void processElement( const QDomElement& parentElement );

  void createRecord( const QDomElement& element );

  void sortRecords();

  void createVariantLists();

  QString m_stringListSeparator;

  QStringList m_knownElements;
  QStringList m_knownAttributeKeys;

  QVariantList m_newElementsToAdd;
  QVariantList m_newElementChildrenToAdd;
  QVariantList m_newElementAttributesToAdd;

  QVariantList m_elementsToUpdate;
  QVariantList m_elementChildrenToUpdate;
  QVariantList m_elementAttributesToUpdate;

  QVariantList m_newAttributeKeysToAdd;
  QVariantList m_newAssociatedElementsToAdd;
  QVariantList m_newAttributeValuesToAdd;

  QVariantList m_attributeKeysToUpdate;
  QVariantList m_associatedElementsToUpdate;
  QVariantList m_attributeValuesToUpdate;

  struct ElementRecord
  {
    QStringList children;
    QMap< QString/*name*/, QStringList /*values*/ > attributes;

    ElementRecord()
    : children  (),
      attributes() {}
  };

  QMultiHash< QString/*element*/, ElementRecord > m_unsorted;
  QMap< QString/*element*/, ElementRecord > m_records;
};

#endif // GCBATCHPROCESSORHELPER_H