IXMLNodeTarget.h

//========================================================================================
// 
// $File$
// 
// Owner: Daniel Guenther
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 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. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Note:
// 
//========================================================================================

#ifndef _IXMLNodeTarget_
#define _IXMLNodeTarget_
//________________________________________________________________________________________________
// INCLUDES
//________________________________________________________________________________________________
 #include "IPMUnknown.h"
 #include "ShuksanID.h"
 #include "NodeID.h"
#include "K2Vector.h"
#include "XMediaUIID.h"
#include "XMLID.h"
#include "XMLReference.h"
#include "XMLAttributeReference.h"

//________________________________________________________________________________________________
// CLASS DECLARATION
//________________________________________________________________________________________________
class IXMLNodeTarget : public IPMUnknown
 {
 //____________________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________________
 public:
 enum { kDefaultIID = IID_IXMLNODETARGET };

 enum XMLNodeFilterType
 { kRemoveDescendents
 };
 

 //____________________________________________________________________________________________
 // Member functions
 //____________________________________________________________________________________________
 public:
 //................................................................................
 // Utilities
 //................................................................................

// virtual void Initialize (IDataBase*) = 0;

 virtual int32 Location (const XMLAttributeReference&) const = 0;

 virtual int32 Location (const XMLReference&) const = 0;
 
 virtual int32 CommentLocation (const XMLReference&) const = 0;

 virtual int32 PILocation(const XMLReference&) const = 0;

 virtual int32 AllLocation(const XMLReference&) const = 0;

 //................................................................................
 // (Add to / Remove from) the XML target
 //................................................................................

 virtual void AddAttribute (const XMLAttributeReference& newItem) = 0;

 virtual void RemoveAttribute (const XMLAttributeReference& itemToRemove) = 0;


 virtual void AddElement (const XMLReference& newItem) = 0;

 virtual void RemoveElement (const XMLReference& itemToRemove) = 0;
 

 virtual void AddComment (const XMLReference& newItem) = 0;

 virtual void RemoveComment (const XMLReference& itemToRemove) = 0;


 virtual void AddPI (const XMLReference& newItem) = 0;

 virtual void RemovePI (const XMLReference& itemToRemove) = 0;


 virtual void AddNonAttribute (const XMLReference& newItem) = 0;

 virtual void RemoveNonAttribute (const XMLReference& itemToRemove) = 0;

 
 virtual void Clear (void) = 0;

 virtual void ClearNonAttributes(void) = 0;

 virtual void ClearElements () = 0;

 virtual void ClearComments(void) = 0;

 virtual void ClearPIs(void) = 0;

 virtual void ClearAttributes () = 0;
 

 virtual const K2Vector<XMLAttributeReference>& GetAttributeNodeList () const = 0; 

 virtual void SetAttributeNodeList (const K2Vector<XMLAttributeReference>&) = 0; 

 virtual void SetAttributeNodeList (const XMLAttributeReference&) = 0;

 virtual int32 GetAttributeCount() const = 0;

 virtual const XMLAttributeReference& GetNthAttribute(int32 index) const = 0;


 virtual const K2Vector<XMLReference>& GetElementNodeList () const = 0; 

 virtual void GetFilteredElementNodeList (XMLNodeFilterType, K2Vector<XMLReference>& sortedList) const = 0;

 virtual void SetElementNodeList (const K2Vector<XMLReference>&) = 0; 

 virtual void SetElementNodeList (const XMLReference&) = 0;

 virtual int32 GetElementCount() const = 0;

 virtual const XMLReference& GetNthElement(int32 index) const = 0;
 

 virtual const K2Vector<XMLReference>& GetCommentNodeList () const = 0;

 virtual void SetCommentNodeList (const K2Vector<XMLReference>&) = 0;

 virtual void SetCommentNodeList (const XMLReference&) = 0;

 virtual int32 GetCommentCount() const = 0;

 virtual const XMLReference& GetNthComment(int32 index) const = 0;

 
 virtual const K2Vector<XMLReference>& GetPINodeList () const = 0;

 virtual void SetPINodeList (const K2Vector<XMLReference>&) = 0;

 virtual void SetPINodeList (const XMLReference&) = 0;

 virtual int32 GetPICount() const = 0;

 virtual const XMLReference& GetNthPI(int32 index) const = 0;

 
 virtual const K2Vector<XMLReference>& GetAllNodeList() const = 0;

 virtual void SetAllNodeList (const K2Vector<XMLReference>&) = 0;

 virtual void SetAllNodeList (const XMLReference&) = 0;

 virtual void GetFilteredAllNodeList(IXMLNodeTarget::XMLNodeFilterType, K2Vector<XMLReference>& sortedList) const = 0;

 virtual int32 GetAllCount() const = 0;

 virtual const XMLReference& GetNthNode(int32 index) const = 0;

 
 virtual IDataBase* GetDataBase() const = 0;

 virtual bool16 HasContent(void) const = 0;

 virtual void Initialize (IDataBase* db) = 0;
 };

#endif // _IXMLNodeTarget_