FDO .NET API Reference Feature Data Objects

mgIBaseSelectImp.h

Go to the documentation of this file.
00001 /*
00002 * Copyright (C) 2004-2006  Autodesk, Inc.
00003 * 
00004 * This library is free software; you can redistribute it and/or
00005 * modify it under the terms of version 2.1 of the GNU Lesser
00006 * General Public License as published by the Free Software Foundation.
00007 * 
00008 * This library is distributed in the hope that it will be useful,
00009 * but WITHOUT ANY WARRANTY; without even the implied warranty of
00010 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00011 * Lesser General Public License for more details.
00012 * 
00013 * You should have received a copy of the GNU Lesser General Public
00014 * License along with this library; if not, write to the Free Software
00015 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00016 *
00017 */
00018 
00019 #pragma once
00020 
00021 #include "FDO\Commands\mgIFeatureCommandImp.h"
00022 #include "FDO\Commands\Feature\mgIBaseSelect.h"
00023 
00024 class FdoIBaseSelect;
00025 
00026 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
00027 
00028 /// \ingroup (OSGeoFDOCommandsFeature)
00029 /// \brief
00030 /// The IBaseSelectImp class is a concrete implementation class for 
00031 /// interface IBaseSelect. The IBaseSelect interface defines a base interface for the the 
00032 /// FDO ISelect command, which queries for features
00033 /// of a given class that match the specified criteria. Input to the select
00034 /// command includes the name of the class, the list of properties to be
00035 /// returned, and a filter. All but the class name is optional. If the list of
00036 /// properties to be returned is empty then all properties are returned. The
00037 /// filter may be specified either as text or as an expression tree (most likely
00038 /// produced by a query builder). The result of executing a select command is an
00039 /// IFeatureReader reference (see "Reading Features"). If the feature provider
00040 /// supports locking, then the select command can optionally lock all of the
00041 /// features selected, via the ExecuteWithLock method (see "Locking
00042 /// Commands" for more information on locking features).
00043 private __gc class IBaseSelectImp : public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommandImp, 
00044                                     public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IBaseSelect
00045 {
00046 public:
00047     /// \brief
00048     /// Gets the IdentifierCollection that holds the list of property names to 
00049     /// return with the result. If empty all properties of the specified class
00050     /// are returned.
00051     /// 
00052     /// \return
00053     /// Returns the list of property names.
00054     /// 
00055     __property NAMESPACE_OSGEO_FDO_COMMANDS::IdentifierCollection* get_PropertyNames();
00056 
00057     /// \brief
00058     /// Gets the IdentifierCollection that holds the list of order by property names. If empty no ordering is used. This list is initially
00059     /// empty and the caller need to add the property that the command should use as a order by criteria.
00060     /// 
00061     /// \return
00062     /// Returns the list of group by property names.
00063     /// 
00064     __property NAMESPACE_OSGEO_FDO_COMMANDS::IdentifierCollection* get_Ordering();
00065 
00066     /// \brief
00067     /// Set the ordering option of the selection. This is only used if the ordering collection is not empty.
00068     /// 
00069     /// \param option 
00070     /// Is the ordering option and should be set to one of OrderingOption_Ascending or OrderingOption_Descending.
00071     /// OrderingOption_Ascending is the default value.
00072     /// 
00073     /// \return
00074     /// Returns nothing
00075     /// 
00076     __property System::Void set_OrderingOption(NAMESPACE_OSGEO_FDO_COMMANDS::OrderingOption option);
00077 
00078     /// \brief
00079     /// Gets the ordering option.
00080     /// 
00081     /// \return
00082     /// Returns the ordering option.
00083     /// 
00084     __property NAMESPACE_OSGEO_FDO_COMMANDS::OrderingOption get_OrderingOption();
00085 
00086 public private:
00087     IBaseSelectImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommandImp(unmanaged, autoDelete)
00088     {
00089 
00090     }
00091 
00092     inline FdoIBaseSelect* GetImpObj();
00093 };
00094 
00095 END_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
00096 
00097 

Comments or suggestions? Send us feedback.