ExternalSortSubStream.h

Go to the documentation of this file.
00001 /*
00002 // $Id: //open/dev/fennel/sorter/ExternalSortSubStream.h#2 $
00003 // Fennel is a library of data storage and processing components.
00004 // Copyright (C) 2005-2009 The Eigenbase Project
00005 // Copyright (C) 2009-2009 SQLstream, Inc.
00006 // Copyright (C) 2004-2009 LucidEra, Inc.
00007 // Portions Copyright (C) 2004-2009 John V. Sichi
00008 //
00009 // This program is free software; you can redistribute it and/or modify it
00010 // under the terms of the GNU General Public License as published by the Free
00011 // Software Foundation; either version 2 of the License, or (at your option)
00012 // any later version approved by The Eigenbase Project.
00013 //
00014 // This program is distributed in the hope that it will be useful,
00015 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00016 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00017 // GNU General Public License for more details.
00018 //
00019 // You should have received a copy of the GNU General Public License
00020 // along with this program; if not, write to the Free Software
00021 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00022 */
00023 
00024 #ifndef Fennel_ExternalSubStream_Included
00025 #define Fennel_ExternalSubStream_Included
00026 
00027 FENNEL_BEGIN_NAMESPACE
00028 
00029 class ExternalSortFetchArray;
00030 
00035 enum ExternalSortRC
00036 {
00040     EXTSORT_SUCCESS,
00041 
00045     EXTSORT_ENDOFDATA,
00046 
00051     EXTSORT_OVERFLOW,
00052 };
00053 
00058 class FENNEL_SORTER_EXPORT ExternalSortSubStream
00059 {
00060 public:
00061     virtual ~ExternalSortSubStream()
00062     {
00063     }
00064 
00071     virtual ExternalSortFetchArray &bindFetchArray() = 0;
00072 
00082     virtual ExternalSortRC fetch(uint nTuplesRequested) = 0;
00083 };
00084 
00088 struct ExternalSortFetchArray
00089 {
00093     PBuffer *ppTupleBuffers;
00094 
00098     uint nTuples;
00099 
00103     explicit ExternalSortFetchArray()
00104     {
00105         ppTupleBuffers = NULL;
00106         nTuples = 0;
00107     }
00108 };
00109 
00113 const uint EXTSORT_FETCH_ARRAY_SIZE = 100;
00114 
00115 FENNEL_END_NAMESPACE
00116 
00117 #endif
00118 
00119 // End ExternalSortSubStream.h

Generated on Mon Jun 22 04:00:20 2009 for Fennel by  doxygen 1.5.1