00001 #ifndef FdoBulkCopyMappingSchema_H
00002 #define FdoBulkCopyMappingSchema_H
00003 //
00004
00005 //
00006 // Copyright (C) 2004-2006 Autodesk, Inc.
00007 //
00008 // This library is free software; you can redistribute it and/or
00009 // modify it under the terms of version 2.1 of the GNU Lesser
00010 // General Public License as published by the Free Software Foundation.
00011 //
00012 // This library is distributed in the hope that it will be useful,
00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
00015 // Lesser General Public License for more details.
00016 //
00017 // You should have received a copy of the GNU Lesser General Public
00018 // License along with this library; if not, write to the Free Software
00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00020
00021 #include <Utilities/FdoBulkCopy.h>
00022 #include <Utilities/BulkCopy/FdoBulkCopyMappingClassCollection.h>
00023
00024 ///<summary>The FdoBulkCopyMappingSchema class specified which schemas are copied.</summary>
00025 class FdoBulkCopyMappingSchema: public FdoIDisposable, public FdoXmlSaxHandler {
00026
00027 public:
00028 ///<summary>Constructs a default empty instance of a FdoBulkCopyMappingSchema.</summary>
00029 /// <returns>Returns FdoBulkCopyMappingSchema</returns>
00030 FDOBULKCOPY_API static FdoBulkCopyMappingSchema* Create();
00031
00032 ///<summary>Sets the source schema name.</summary>
00033 /// <param name="schemaName">The source schema name</param>
00034 /// <returns>Returns nothing</returns>
00035 FDOBULKCOPY_API void SetSourceSchemaName(FdoString* schemaName);
00036
00037 ///<summary>Gets the source schema name.</summary>
00038 /// <returns>Returns the source schema name</returns>
00039 FDOBULKCOPY_API FdoString* GetSourceSchemaName();
00040
00041 ///<summary>Sets the target schema name.</summary>
00042 /// <param name="schemaName">The target schema name</param>
00043 /// <returns>Returns nothing</returns>
00044 FDOBULKCOPY_API void SetTargetSchemaName(FdoString* schemaName);
00045
00046 ///<summary>Gets the target schema name.</summary>
00047 /// <returns>Returns the target schema name</returns>
00048 FDOBULKCOPY_API FdoString* GetTargetSchemaName();
00049
00050 ///<summary>Gets the mapping classes. Returns an empty FdoBulkCopyMappingClassCollection
00051 ///collection if ReadXML is not called. Otherwise, returns the mapping data from the XML
00052 ///mapping file. An empty collection will copy all the classes from the source datastore.
00053 ///If a subset of the classes should be copied, a FdoBulkCopyMappingClass object should
00054 /// be added to the collection for each class.</summary>
00055 /// <returns>Returns the mapping classes</returns>
00056 FDOBULKCOPY_API FdoBulkCopyMappingClassCollection* GetMappingClasses();
00057
00058 protected:
00059 FdoBulkCopyMappingSchema();
00060 virtual ~FdoBulkCopyMappingSchema();
00061 virtual void Dispose();
00062
00063 private:
00064 FdoStringP mSourceSchemaName;
00065 FdoStringP mTargetSchemaName;
00066 FdoPtr<FdoBulkCopyMappingClassCollection> mClasses;
00067 };
00068
00069 #endif