DDD_AttributeList.h

Go to the documentation of this file.

#ifndef _DDD_AttributeList_h_
#define _DDD_AttributeList_h_

/*! \file DDD_AttributeList.h
  \brief  The DDD_AttributeList class.  Maintains a list of Data Director attributes.

  \par Copyright Information

  Copyright (c) 2012 The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBLITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/

#include "DDD_AttributeBase.h"
#include "dynamic_ptr_array.h"
#include <string>

namespace disti
{
/** \brief  The DDD_AttributeList class.  Maintains a list of Data Director attributes.
    */
class DDD_EXPORT DDD_AttributeList : public DynamicPtrArray<DDD_AttributeBase *>
{
public:
    /** Constructor. */
    DDD_AttributeList();

    /** Destructor 
      * The DDD_AttributeList does NOT manage the storage of its attributes.
      * Prior to calling this destructor, the calling code should free
      * all of the attributes in this list.
      */
    ~DDD_AttributeList();

    /** Get the value of the named attribute and return it as a parameter
      * \param name  The name of the attribute to get
      * \param returnedValue   Will contain the attribute value if found
      * \return True if the attribute was found, false otherwise
      */
    bool GetValueString(const std::string &name,std::string &returnedValue);

    /** Add an attribute to the list and set its observer 
      * \param attr   The attribute to add
      * \param observer  An observer (or NULL) that will observe the attribute 
      */
    void Add(DDD_AttributeBase *attr,DDD_AttributeObserver *observer);

    /** Find the attribute with the given name within this attribute list
      * \param name  The name of the attribute to find
      * \return A pointer to the attribute or NULL if not found
      */
    DDD_AttributeBase *Find(const std::string &name);

    /** Get the list index of the attribute with the given name within this attribute list
      * \param name  The name of the attribute to find
      * \return The (0 based) list index of the attribute or -1 if not found
      */
    int IndexOf(const std::string &name);

    /** Find the attribute with the given name within this attribute list and remove it
      * \param name  The name of the attribute to find
      */
    void Remove(const std::string &name);

    /** Find the attribute with the given name within this attribute list and replace it
      * \param name  The name of the attribute to find
      * \param newAttr  The new attribute with which to replace it
      */
    void Replace(DDD_AttributeBase *oldAttr,DDD_AttributeBase *newAttr);

    /** Copies the attribute values from the supplied list into this list.
      * Only attributes that exist in both lists will be updated/
      * \param attrList  A list of attributes
      * \param notifyObservers If true, the attributes whose values are overwritten will notify their observers
      */
    void CopyValues(DDD_AttributeList &attrList, bool notifyObservers = false);
    
    /** Utility method that converts an attribute list into a single formatted string using the specified delimiter.
      * NOTE:  No trailing delimeter will be added to the string.
      * \param delim1  The delimiter to separate name/value pairs.
      * \param delim2  The delimiter to sepatate names from values.
      * \return A string containing the attribute list, e.g. "name1=value1;name2=value2"
      */
    std::string ToString(const std::string& delim1 = ";", const std::string& delim2 = "="); 

    /** Utility method that converts formatted string into an attribute list
      * NOTE:  No trailing delimeter will be expected in the string.
      * NOTE!: This method DOES NOT CHECK FOR DUPLICATE NAMES.  IT IS EXPECTED THAT THE CALLER FIRST EMPTY THIS LIST.
      * \param str A string containing the attribute list, e.g. "name1=value1;name2=value2"
      * \param delim1  The delimiter to separate name/value pairs.
      * \param delim2  The delimiter to sepatate names from values.
      */
    void FromString(const std::string& str, const std::string& delim1 = ";", const std::string& delim2 = "=");

    /** Merges another attribute list into this one
      * \param otherList  Another attribute list
      */
    void Merge(const DDD_AttributeList &otherList);

    /** Deletes and deallocates all of the attributes in this list that are not marked with the "Persistent" flag
      */
    void DeleteDynamicAttributes();

    /** Reverts all of the attributes in this list that are marked with the "Revertable" flag
      */
    void RevertAttributes();
};

} // namespace disti

#endif