- Main Page
- Related Pages
- Modules
- Classes
- Files

# CLOBValue.h

Go to the documentation of this file.

    00001 #ifndef _CLOBVALUE_H_
    00002 #define _CLOBVALUE_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
    00022 #ifdef _WIN32
    00023 #pragma once
    00024 #endif
    00025
    00026 #include <FdoStd.h>
    00027 #include <Fdo/Expression/LOBValue.h>
    00028 #include <Fdo/Schema/DataType.h>
    00029
    00030 /// \brief
    00031 /// The FdoCLOBValue class derives from FdoLOBValue and represents a literal
    00032 /// CLOB value.
    00033 class FdoCLOBValue : public FdoLOBValue
    00034 {
    00035 /// \cond DOXYGEN-IGNORE
    00036 protected:
    00037     /// \brief
    00038     /// Constructs a default instance of an FdoCLOBValue with a value of null.
    00039     ///
    00040     /// \return
    00041     /// Returns nothing
    00042     ///
    00043     FdoCLOBValue();
    00044
    00045     /// \brief
    00046     /// Constructs a default instance of an FdoCLOBValue using the specified arguments.
    00047     ///
    00048     /// \param value
    00049     /// Input a byte array
    00050     ///
    00051     /// \return
    00052     /// Returns nothing
    00053     ///
    00054     FdoCLOBValue(FdoByteArray* value);
    00055
    00056     /// \brief
    00057     /// Default destructor for FdoCLOBValue.
    00058     ///
    00059     /// \return
    00060     /// Returns nothing
    00061     ///
    00062     virtual ~FdoCLOBValue();
    00063
    00064     virtual void Dispose();
    00065 /// \endcond
    00066
    00067 public:
    00068     /// \brief
    00069     /// Constructs a default instance of an FdoCLOBValue with a value of null.
    00070     ///
    00071     /// \return
    00072     /// Returns the created FdoCLOBValue
    00073     ///
    00074     FDO_API static FdoCLOBValue* Create();
    00075
    00076     /// \brief
    00077     /// Constructs a default instance of an FdoCLOBValue using the specified arguments.
    00078     ///
    00079     /// \param value
    00080     /// Input a byte array
    00081     ///
    00082     /// \return
    00083     /// Returns the created FdoCLOBValue
    00084     ///
    00085     FDO_API static FdoCLOBValue* Create(FdoByteArray* value);
    00086
    00087     /// \brief
    00088     /// Gets the data type of the FdoCLOBValue.
    00089     ///
    00090     /// \return
    00091     /// Returns an FdoDataType
    00092     ///
    00093     FDO_API FdoDataType GetDataType();
    00094
    00095     /// \brief
    00096     /// Gets the CLOB value.
    00097     ///
    00098     /// \return
    00099     /// Returns a byte array
    00100     ///
    00101     FDO_API FdoByteArray* GetData();
    00102
    00103     /// \brief
    00104     /// Sets the CLOB value.
    00105     ///
    00106     /// \param value
    00107     /// Input a byte array
    00108     ///
    00109     /// \return
    00110     /// Returns nothing
    00111     ///
    00112     FDO_API void SetData(FdoByteArray* value);
    00113
    00114     /// \brief
    00115     /// Sets the CLOB value to a null value.
    00116     ///
    00117     /// \return
    00118     /// Returns nothing
    00119     ///
    00120     FDO_API void SetNull();
    00121
    00122     /// \brief
    00123     /// Overrides FdoExpression.Process to pass the FdoCLOBValue to the appropriate
    00124     /// expression processor operation.
    00125     ///
    00126     /// \param p
    00127     /// Input an FdoIExpressionProcessor
    00128     ///
    00129     /// \return
    00130     /// Returns nothing
    00131     ///
    00132     FDO_API void Process(FdoIExpressionProcessor* p);
    00133
    00134     /// \brief
    00135     /// Returns the well defined text representation of this expression.
    00136     ///
    00137     /// \return
    00138     /// Returns a text string
    00139     ///
    00140     FDO_API FdoString* ToString();
    00141
    00142 };
    00143 #endif
    00144
    00145

Please send us your comment about this page