00001 #ifndef FDO_XMIFDOSCHEMATRANSFORM_H
00002 #define FDO_XMIFDOSCHEMATRANSFORM_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 <Fdo.h>
00022 #include <common/Xml/Reader.h>
00023 #include <common/Xml/Writer.h>
00024 #include <common/Io/TextWriter.h>
00025 #include <Utilities/FdoSchema.h>
00026 
00027 
00028 class XmiFdoSchemaTransform
00029 {
00030 public:
00031     /// <summary>Transforms an input XMI stream to an output GML stream.</summary>
00032     /// <param name="pXmi">A FdoXmlReader object from which the input XMI stream will be read.</param>
00033     /// <param name="pGml">A FdoXmlWriter object to which the output GML stream will be written.</param>
00034     /// <param name="pLog">A FdoIoTextWriter object to which logging information (messages and warnings) will be sent; can be null</param>
00035     /// <returns>Returns true if it succeeded without warnings and false if it succeeded with warnings. On error, an exception is thrown.</returns>
00036     /// <remarks>
00037     ///    The output GML stream can be passed along to an FDO provider's FdoFeatureSchemaCollection object's ReadXml method in order to create an in-memory logical feature schema,
00038     ///    which can then be passed along to the provider's FdoIApplySchema command's SetFeatureSchema method, if the provider supports it.
00039     ///    Alternatively, the output GML stream can be passed along to a provider's FdoIConnection object's SetConfiguration method, 
00040     ///    if the provider supports it.
00041     ///    If any errors occur during the translation process, an exception is thrown (as opposed to being sent to the logging object).
00042     /// </remarks>
00043     FDOSCHEMA_API static bool XmiToFdo(FdoXmlReader* pXmi, FdoXmlWriter* pGml, FdoIoTextWriter* pLog);
00044 };
00045 
00046 
00047 #endif  // FDO_XMIFDOSCHEMATRANSFORM_H