/*

* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). 

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  This interface defines a generic data type

*

*/

#ifndef ALFVARIANTTYPE_H

#define ALFVARIANTTYPE_H

//  INCLUDES

#include <e32def.h>

#include <osn/osndefines.h>

#include <osn/osncommon.h>

#include <alf/ialfvarianttype.h>

#include <alf/ialfcontainer.h>

#include <alf/ialfmap.h>

#include <alf/ialfbranch.h>

#include <memory>

#include <alf/ialfsortfunction.h>

namespace osncore

    {

class UString;

    }

namespace std

    {

template <class T> class auto_ptr;

    }

using namespace osncore;

using std::auto_ptr;

namespace Alf

    {

// FORWARD DECLARATIONS

class IAlfContainer;

class IAlfMap;

class AlfBranch;

class AlfVariantDataImpl;

class AlfContainerDataImpl;

class AlfMapDataImpl;

class AlfBranchDataImpl;

class IAlfModelBase;

// CLASS DECLARATIONS

/**

 *  @class AlfVariantType alfvarianttype.h "alf/alfvarianttype.h"

 *  Concrete implementation of the variant data type interface. 

 *  AlfVariantType can hold data of integer,real,string and unsigned integer types.

 *  @see IAlfVariantType

 *

 *  @lib alfwidgetmodel.lib

 *  @since S60 ?S60_version

 *  @status Draft

 */

class AlfVariantType: public IAlfVariantType

    {

public:

    /**

     * Constructor for variant data type creation for a descriprtor type of data

     * @exception std::bad_alloc

     *

     * @param aValue - Descriptor to be assigned for the variant data

     * @since S60 ?S60_version

     */

    OSN_IMPORT  AlfVariantType(const UString& aValue);

    /**

     * Constructor for variant data type creation for a integer type of data

     * @exception std::bad_alloc

     *

     * @param aValue - integer to be assigned for the variant data

     * @since S60 ?S60_version

     */

    OSN_IMPORT   AlfVariantType(const int& aValue);

    /**

     * Constructor for variant data type creation for a Unsigned integer type of data

     * @exception std::bad_alloc

     *

     * @param aValue - unsigned integer to be assigned for the variant data

     * @since S60 ?S60_version

     */

    OSN_IMPORT  AlfVariantType(const uint& aValue);

    /**

     * Constructor for variant data type creation for a real type of data

     * @exception std::bad_alloc

     *

     * @param aValue - Real value to be assigned for the variant data

     * @since S60 ?S60_version

     */

    OSN_IMPORT   AlfVariantType(const double& aValue);

    /**

      * Constructor for variant data type creation for a user defined type of data

      * @exception std::bad_alloc

      *

      * @param aValue - IAlfModelBase* to be assigned for the variant data

      * @since S60 ?S60_version

      */

    OSN_IMPORT  AlfVariantType(IAlfModelBase* aValue) ;

    /**

     * Constructor for variant data type creation for a bool type of data

     * @exception std::bad_alloc

     *

     * @param aValue - Boolean value to be assigned for the variant data

     * @since S60 ?S60_version

     */

    OSN_IMPORT  AlfVariantType(const bool& aValue);

    //from IAlfVariantType Interface

    /**

     * Set the Data the variantData. From IAlfVariantType Interface

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType if aValue  

     *                                      is of invalid type.  

     * @exception std::bad_alloc

     *

     * @param aValue    The new value.

     * @return void

     * @since S60 ?S60_version

     */

    OSN_IMPORT    void set(IAlfVariantType& aValue);

    /**

     * Get the data type.From IAlfVariantType Interface

     *

     * @since S60 ?S60_version

     * @return The data type.

     */

    OSN_IMPORT    IAlfVariantType::Type type() const;

    /**

     * Get the data value as an bool .From IAlfVariantType Interface

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType if aValue  

     *                                      is not of boolean type.  

     *

     * @return bool data value.

     * @since S60 ?S60_version

     */

    OSN_IMPORT    bool boolean() const;

    /**

     * Get the data value as an Integer .From IAlfVariantType Interface

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType if aValue  

     *                                      is not of integer type.  

     *

     * @return Integer data value.

     * @since S60 ?S60_version

     */

    OSN_IMPORT    int integer() const;

    /**

     * Get the data value as unsigned  int.From IAlfVariantType Interface

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType if aValue  

     *                                      is not of unsigned integer type.  

     *

     * @return unsigned integer value.

     * @since S60 ?S60_version

     */

    OSN_IMPORT    uint uinteger() const;

    /**

     * Get the data value as an bool .From IAlfVariantType Interface

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType if aValue  

     *                                      is not of real type.  

     *

     * @return real data value.

     * @since S60 ?S60_version

     */

    OSN_IMPORT    double real() const;

    /**

     * Get the data value as an Descriptor .From IAlfVariantType Interface

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType if aValue  

     *                                      is not of string type.  

     *

     * @return string data value.

     * @since S60 ?S60_version

     */

    OSN_IMPORT    const UString& string() const;

    /**

     * Get the data value as an Container .From IAlfVariantType Interface. 

     * Always throws an exception.

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType always

     *                                      since AlfVariantType is not a container.   

     * 

     * @return AlfContainer .

     * @since S60 ?S60_version

     */

    OSN_IMPORT    IAlfContainer* container();

    /**

     * Get the data value as Map .From IAlfVariantType Interface.

     * Always throws an exception.

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType always

     *                                      since AlfVariantType is not a map.   

     *

     * @return Map

     * @since S60 ?S60_version

     */

    OSN_IMPORT    IAlfMap* map() ;

    /**

     * Get the data value as Branch .From IAlfVariantType Interface

     * Always throws an exception.

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType always

     *                                      since AlfVariantType is not a branch.   

     *

     * @return Map

     * @since S60 ?S60_version

     */

    OSN_IMPORT    IAlfBranch* branch() ;

    /**

     * Get the data value as a User Defined Data Pointer.

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType if aValue  

     *                                      is not of custom type.  

     *

     * @return IAlfModelBase interface.

     * @since S60 ?S60_version

     */

    OSN_IMPORT IAlfModelBase* customData();

    /**

     * Destructor

     *

     * @return

     * @since S60 ?S60_version

     */

    OSN_IMPORT ~AlfVariantType();

    /**

     * The default constructor.

     *

     * @since S60 ?S60_version

     */

    OSN_IMPORT AlfVariantType();

    /**

     * Equality comparison operator.

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType if aValue  

     *                                      is of invalid type.  

     *

     * @param aOther object to compare against.

     * @since S60 ?S60_version

     */

    OSN_IMPORT bool operator==(const IAlfVariantType& aOther) const;

private:

    /**

     * 2nd Phase Constructor

     *

     * @since S60 ?S60_version

     * @param aType

     */

    void  construct(Type aType);

private:

    //data owned

    auto_ptr<AlfVariantDataImpl> mVarData;

    };

/**

 *  @class AlfVariantType alfvarianttype.h "alf/alfvarianttype.h"

 *  Concrete implementation of the variant data type interface. 

 *  Simple default container of variant types.

 *  @see IAlfContainer

 *

 *  @lib alfwidgetmodel.lib

 *  @since S60 ?S60_version

 *  @status Draft

 */

class AlfContainer : public IAlfContainer

    {

public:

     /**

     * Constructor for creating a variant data type which can store a alfcontainer

     * @exception std::bad_alloc

     *

     * @since S60 ?S60_version

     */

    OSN_IMPORT  AlfContainer();

    /**

     * Destructor

     * @since S60 ?S60_version

     */

    OSN_IMPORT  ~AlfContainer();

    //IAlfContainer APIs

    /**

     * Adds a variantData item into the container .From IAlfContainer interface

     * @aData variant data to be added into the container. Ownership is transferred

     * if the method completes without exceptions. If there is an exception

     * (e.g. due to out of memory), the client code is responsible for cleaning up the object.

     * @exception std::bad_alloc

     *

     * @return void.

     * @since S60 ?S60_version

     */

    OSN_IMPORT void addItem(IAlfVariantType* aData);

    /**

     * Adds a variantData item into the container .From IAlfContainer interface

     * @aIndex index where the data is added

     * @aData variant data to be added into the container. Ownership is transferred

     * if the method completes without exceptions. If there is an exception

     * (e.g. due to out of memory), the client code is responsible for cleaning up the object.

     * @exception std::bad_alloc

     *

     * @return void.

     * @since S60 ?S60_version

     */

    OSN_IMPORT void addItem(uint aIndex, IAlfVariantType* aData);

    /**

     * Gets the Number of items in  the container . From IAlfContainer interface

     *

     * @return number of items in the container

     * @since S60 ?S60_version

     */

    OSN_IMPORT int count();

    /**

     * Gets the Item at a given index in  the container From IAlfContainer interface

     * @param aIndex - index at which the element is required

     * @return item as a MlfVariantType

     * @since S60 ?S60_version

     */

    OSN_IMPORT IAlfVariantType* item(uint aIndex);

    /**

     * Clones the  entire container From IAlfContainer interface

     * @exception std::bad_alloc

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType if 

     *                                      there is an invalid data type in the container.   

     *

     * @return the cloned container

     * @since S60 ?S60_version

     */

    OSN_IMPORT IAlfContainer* clone();

    /**

     * Removes  an item from  given index in  the container. From IAlfContainer interface

     * @param aIndex - index at which the element is to be removed.

     * @return item as a IAlfVariantType

     * @since S60 ?S60_version

     */

    OSN_IMPORT void removeItem(uint aIndex);

    /**

     * Clear the Container. From IAlfContainer interface

     *

     * @return void

     * @since S60 ?S60_version

     */

    OSN_IMPORT void clear() ;

    /**

     * Replace  an item from  given index in  the container.

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidContainerOperation if

     *                                      the replaceItem fails.   

     *

     * @param aIndex - index at which the element is to be replaced

     * @param aNewData - new Data to be replaced

     * @return void

     * @since S60 ?S60_version

     */

    OSN_IMPORT void replaceItem(uint aIndex, IAlfVariantType* aNewData );

    /**

     * sorts the container using user defined sort function.

     *

     * @param aSortFunction - sort function.

     * @since S60 ?S60_version

     */

    OSN_IMPORT void sort( const IAlfSortFunction& aSortFunction );

    //from IAlfVariantType Interface

    /**

     * Set the Data the variantData. From IAlfVariantType Interface.

     * Always throws an exception always.

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidContainerOperation always. 

     *                                      Use the addItem API.   

     *

     * @param aValue    The new value.

     * @return void

     * @since S60 ?S60_version

     */

    OSN_IMPORT void set(IAlfVariantType& aValue);

    /**

     * Get the data type.From IAlfVariantType Interface

     *

     * @return The data type.

     * @since S60 ?S60_version

     */

    OSN_IMPORT IAlfVariantType::Type type() const;

    /**

     * Get the data value as an bool .From IAlfVariantType Interface.

     * Always throws an exception.

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType always

     *                                      since AlfContainer is not boolean.   

     *

     * @return bool data value.

     * @since S60 ?S60_version

     */

    OSN_IMPORT bool boolean() const;

    /**

     * Get the data value as an Integer .From IAlfVariantType Interface.

     * Always throws an exception.

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType always

     *                                      since AlfContainer is not an integer.   

     *

     * @return Integer data value.

     * @since S60 ?S60_version

     */

    OSN_IMPORT  int integer() const;

    /**

     * Get the data value as unsigned  int.From IAlfVariantType Interface.

     * Always throws an exception.

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType always

     *                                      since AlfContainer is not an unsigned integer.   

     *

     * @return unsigned integer data value.

     * @since S60 ?S60_version

     */

    OSN_IMPORT  uint uinteger() const;

    /**

     * Get the data value as an bool .From IAlfVariantType Interface.

     * Always throws an exception.

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType always

     *                                      since AlfContainer is not a real value.   

     *

     * @return real data value.

     * @since S60 ?S60_version

     */

    OSN_IMPORT double real() const;

    /**

     * Get the data value as an Descriptor .From IAlfVariantType Interface.

     * Always throws an exception.

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType always

     *                                      since AlfContainer is not a string.   

     *

     * @return string data value.

     * @since S60 ?S60_version

     */

    OSN_IMPORT  const UString& string() const;

    /**

     * Get the data value as an Conatiner .From IAlfVariantType Interface.

     *

     * @return AlfContainer .

     * @since S60 ?S60_version

     */

    OSN_IMPORT    IAlfContainer* container();

    /**

     * Get the data value as Map .From IAlfVariantType Interface.

     * Always throws an exception.

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType always

     *                                      since AlfContainer is not a map.   

     *

     * @return Map

     * @since S60 ?S60_version

     */

    OSN_IMPORT    IAlfMap* map();

    /**

     * Get the data value as Branch .From IAlfVariantType Interface.

     * Always throws an exception.

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType always

     *                                      since AlfContainer is not a map.   

     *

     * @return Map

     * @since S60 ?S60_version

     */

    OSN_IMPORT    IAlfBranch* branch();

    /**

     * Get the data value as a User Defined Data Pointer.

     * Always throws an exception.

     * @exception osncore::AlfDataException Thrown with error code osncore::EInvalidVariantDataType always

     *                                      since AlfContainer is not a custom data type.   

     *

     * @return IAlfModelBase interface.

     * @since S60 ?S60_version

     */

    OSN_IMPORT IAlfModelBase* customData();