IArrayNode.h

Go to the documentation of this file.

#ifndef __IArrayNode_h__
#define __IArrayNode_h__ 1

// =================================================================================================
// ADOBE SYSTEMS INCORPORATED
// Copyright 2014 Adobe Systems Incorporated
// All Rights Reserved
//
// NOTICE:  Adobe permits you to use, modify, and distribute this file in accordance with the terms
// of the Adobe license agreement accompanying it.
// =================================================================================================


#include "XMPCore/Interfaces/ICompositeNode.h"

namespace AdobeXMPCore {

        class XMP_PUBLIC IArrayNode_v1
                : public virtual ICompositeNode_v1
        {
        public:

                typedef enum {
                        kAFNone                                                                 = 0,

                        kAFUnordered                                                    = 1 << 0,

                        kAFOrdered                                                              = 1 << 1,

                        kAFAlternative                                                  = 1 << 2,

                        kAFAll                                                                  = kAllBits
                } eArrayForm;

                virtual eArrayForm APICALL GetArrayForm() const  = 0;

                virtual eNodeType APICALL GetChildNodeType() const = 0;

                virtual spINode APICALL GetNodeAtIndex( sizet index ) = 0;
                XMP_PRIVATE spcINode GetNodeAtIndex( sizet index ) const {
                        return const_cast< IArrayNode_v1 * >( this )->GetNodeAtIndex( index );
                }

                XMP_PRIVATE spcISimpleNode GetSimpleNodeAtIndex( sizet index ) const {
                        auto node = GetNodeAtIndex( index );
                        if ( node ) return node->ConvertToSimpleNode();
                        return spcISimpleNode();
                }

                XMP_PRIVATE spISimpleNode GetSimpleNodeAtIndex( sizet index ) {
                        auto node = GetNodeAtIndex( index );
                        if ( node ) return node->ConvertToSimpleNode();
                        return spISimpleNode();
                }

                XMP_PRIVATE spcIStructureNode GetStructureNodeAtIndex( sizet index ) const {
                        auto node = GetNodeAtIndex( index );
                        if ( node ) return node->ConvertToStructureNode();
                        return spcIStructureNode();
                }

                XMP_PRIVATE spIStructureNode GetStructureNodeAtIndex( sizet index ) {
                        auto node = GetNodeAtIndex( index );
                        if ( node ) return node->ConvertToStructureNode();
                        return spIStructureNode();
                }

                XMP_PRIVATE spcIArrayNode GetArrayNodeAtIndex( sizet index ) const {
                        auto node = GetNodeAtIndex( index );
                        if ( node ) return node->ConvertToArrayNode();
                        return spcIArrayNode();
                }

                XMP_PRIVATE spIArrayNode GetArrayNodeAtIndex( sizet index ) {
                        auto node = GetNodeAtIndex( index );
                        if ( node ) return node->ConvertToArrayNode();
                        return spIArrayNode();
                }

                virtual void APICALL InsertNodeAtIndex( const spINode & node, sizet index ) = 0;

                virtual spINode APICALL ReplaceNodeAtIndex( const spINode & node, sizet index ) = 0;

                virtual spINode APICALL RemoveNodeAtIndex( sizet index ) = 0;
                
                
                virtual pIArrayNode APICALL GetActualIArrayNode() __NOTHROW__ = 0;
                XMP_PRIVATE pcIArrayNode GetActualIArrayNode() const __NOTHROW__ {
                        return const_cast< IArrayNode_v1 * >( this )->GetActualIArrayNode();
                }

                virtual AdobeXMPCore_Int::pIArrayNode_I APICALL GetIArrayNode_I() __NOTHROW__ = 0;

                XMP_PRIVATE AdobeXMPCore_Int::pcIArrayNode_I GetIArrayNode_I() const __NOTHROW__ {
                        return const_cast< IArrayNode_v1 * >( this )->GetIArrayNode_I();
                }
                
                XMP_PRIVATE static spIArrayNode MakeShared( pIArrayNode_base ptr );
                XMP_PRIVATE static spcIArrayNode MakeShared( pcIArrayNode_base ptr ) {
                        return MakeShared( const_cast< pIArrayNode_base >( ptr ) );
                }

                XMP_PRIVATE static uint64 GetInterfaceID() { return kIArrayNodeID; }

                XMP_PRIVATE static uint32 GetInterfaceVersion() { return 1; }

                // Factories to create the array node

                XMP_PRIVATE static spIArrayNode CreateUnorderedArrayNode( const char * nameSpace, sizet nameSpaceLength, const char * name, sizet nameLength );

                XMP_PRIVATE static spIArrayNode CreateOrderedArrayNode( const char * nameSpace, sizet nameSpaceLength, const char * name, sizet nameLength );

                XMP_PRIVATE static spIArrayNode CreateAlternativeArrayNode( const char * nameSpace, sizet nameSpaceLength, const char * name, sizet nameLength );

        protected:
                virtual ~IArrayNode_v1() __NOTHROW__ {}

                virtual uint32 APICALL getArrayForm( pcIError_base & error ) const __NOTHROW__ = 0;
                virtual uint32 APICALL getChildNodeType( pcIError_base & error ) const __NOTHROW__ = 0;
                virtual pINode_base APICALL getNodeAtIndex( sizet index, pcIError_base & error ) __NOTHROW__ = 0;
                virtual void APICALL insertNodeAtIndex( pINode_base node, sizet index, pcIError_base & error ) __NOTHROW__ = 0;
                virtual pINode_base APICALL replaceNodeAtIndex( pINode_base node, sizet index, pcIError_base & error ) __NOTHROW__ = 0;
                virtual pINode_base APICALL removeNodeAtIndex( sizet index, pcIError_base & error ) __NOTHROW__ = 0;

                #ifdef FRIEND_CLASS_DECLARATION
                        FRIEND_CLASS_DECLARATION();
                #endif
                REQ_FRIEND_CLASS_DECLARATION();

        };
}

#endif  // __IArrayNode_h__