TupleDescriptor.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/tuple/TupleDescriptor.h#23 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2005-2009 The Eigenbase Project
// Copyright (C) 2003-2009 SQLstream, Inc.
// Copyright (C) 2005-2009 LucidEra, Inc.
// Portions Copyright (C) 1999-2009 John V. Sichi
//
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 2 of the License, or (at your option)
// any later version approved by The Eigenbase Project.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef Fennel_TupleDescriptor_Included
#define Fennel_TupleDescriptor_Included

#include <vector>

FENNEL_BEGIN_NAMESPACE

class StoredTypeDescriptor;
class StoredTypeDescriptorFactory;
class TupleData;
class ByteOutputStream;
class ByteInputStream;
class DataVisitor;

struct FENNEL_TUPLE_EXPORT TupleAttributeDescriptor
{
    StoredTypeDescriptor const *pTypeDescriptor;
    bool isNullable;
    TupleStorageByteLength cbStorage;

    explicit TupleAttributeDescriptor();

    explicit TupleAttributeDescriptor(
        StoredTypeDescriptor const &typeDescriptor,
        bool isNullable = false,
        TupleStorageByteLength cbStorage = 0);

    bool operator == (TupleAttributeDescriptor const &other) const;
};

class FENNEL_TUPLE_EXPORT TupleProjection
    : public VectorOfUint
{
public:
    void writePersistent(
        ByteOutputStream &) const;

    void readPersistent(
        ByteInputStream &);

    void projectFrom(
        TupleProjection const &sourceProjection,
        TupleProjection const &tupleProjection);
};

class FENNEL_TUPLE_EXPORT TupleDescriptor
    : public std::vector<TupleAttributeDescriptor>
{
public:
    void projectFrom(
        TupleDescriptor const &tupleDescriptor,
        TupleProjection const &tupleProjection);

    // Utility function to compare the prefixes of two tuples up to keyCount.
    int compareTuplesKey(
        TupleData const &tuple1,
        TupleData const &tuple2,
        uint keyCount) const;

    int compareTuples(
        TupleData const &tuple1,
        TupleData const &tuple2) const;

    int compareTuples(
        TupleData const &tuple1, TupleProjection const &proj1,
        TupleData const &tuple2, TupleProjection const &proj2,
        bool *containsNullKey = NULL) const;

    void writePersistent(
        ByteOutputStream &) const;

    void readPersistent(
        ByteInputStream &,
        StoredTypeDescriptorFactory const &);

    void visit(
        TupleData const &tuple,
        DataVisitor &dataVisitor,
        bool visitLengths) const;

    bool containsNullable() const;

    bool storageEqual(
        TupleDescriptor const &other) const;
    TupleStorageByteLength getMaxByteCount() const;
};

FENNEL_TUPLE_EXPORT std::ostream & operator<< (
    std::ostream &str,TupleDescriptor const &);

FENNEL_TUPLE_EXPORT std::ostream & operator<< (
    std::ostream &str,TupleAttributeDescriptor const &);

FENNEL_END_NAMESPACE

#endif

// End TupleDescriptor.h

---