DbIndex.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
 
 
 
#ifndef OD_DBINDEX_H
#define OD_DBINDEX_H
 
#include "TD_PackPush.h"
 
class OdDbDate;
class OdDbIndexIterator; 
class OdDbFilter;
class OdDbIndexUpdateData;
class OdDbBlockChangeIterator;
class OdDbFilter;
class OdDbBlockTableRecord;
class OdDbBlockChangeIterator;
class OdDbIndexUpdateData;
class OdDbBlockChangeIteratorImpl;
class OdDbIndexUpdateDataImpl;
class OdDbIndexUpdateDataIteratorImpl;
class OdDbFilteredBlockIterator;
 
typedef OdSmartPtr<OdDbFilteredBlockIterator> OdDbFilteredBlockIteratorPtr;
 
#include "DbFilter.h"
 
extern void processBTRIndexObjects(
  OdDbBlockTableRecord* pBlock, 
  int indexCtlVal,
  OdDbBlockChangeIterator* pBlkChgIter,
  OdDbIndexUpdateData* pIdxUpdData);
 
 
class TOOLKIT_EXPORT OdDbBlockChangeIterator
{
private:
  friend class OdDbBlockChangeIteratorImpl;
  OdDbBlockChangeIteratorImpl* m_pImpl;
  OdDbBlockChangeIterator() : m_pImpl(0) {}
  OdDbBlockChangeIterator(
    const OdDbBlockChangeIterator&);
public:
 
    void start();
 
    OdDbObjectId id() const;
  
    void next();
 
    bool done(); 
  
    void curIdInfo(
    OdDbObjectId& currentId, 
    OdUInt8& flags, 
    OdUInt32& data) const;
    
    void setCurIdInfo(
    OdUInt8 flags, 
    OdUInt32 data);
  
  OdDbIndexUpdateData* updateData() const;
  
  void clearProcessedFlags();
};
 
class TOOLKIT_EXPORT OdDbIndexUpdateData 
{
  friend class OdDbIndexUpdateDataImpl;
  OdDbIndexUpdateDataImpl* m_pImpl;
  OdDbIndexUpdateData() : m_pImpl(0) {}
  OdDbIndexUpdateData(
    const OdDbIndexUpdateData&);
public:
  enum UpdateFlags 
  { 
    kModified   = 1, // Modified RO
    kDeleted    = 2, // Deleted RO
    kProcessed  = 4, // Processed RW
    kUnknownKey = 8  // Unknown key
  };
  OdDbObjectId objectBeingIndexedId() const;
 
  
  void addId(
    OdDbObjectId objectId);
  
  bool setIdFlags(
    OdDbObjectId objectId, 
    OdUInt8 flags);
 
  bool setIdData(
    OdDbObjectId objectId, 
    OdUInt32 data);
 
  bool getIdData(
    OdDbObjectId objectId, 
    OdUInt32& data) const;
 
  bool getIdFlags(
    OdDbObjectId objectId, 
    OdUInt8& flags) const; 
 
  bool getFlagsAndData(
    OdDbObjectId objectId, 
    OdUInt8& flags, 
    OdUInt32& data) const;
};
 
class TOOLKIT_EXPORT OdDbIndexUpdateDataIterator
{
  friend class OdDbIndexUpdateDataIteratorImpl;
  OdDbIndexUpdateDataIteratorImpl* m_pImpl;
public:
  OdDbIndexUpdateDataIterator(
    const OdDbIndexUpdateData* pIndexUpdateData);
  
    void start();
 
    OdDbObjectId id() const;
  
    void next();
 
    bool done(); 
  
    void currentData(
    OdDbObjectId& currentId, 
    OdUInt8& flags, 
    OdUInt32& data) const;
};
 
 
class TOOLKIT_EXPORT OdDbIndex : public OdDbObject
{
public:
  ODDB_DECLARE_MEMBERS(OdDbIndex);
 
  OdDbIndex();
  
  
   virtual OdDbFilteredBlockIteratorPtr newIterator(
    const OdDbFilter* pFilter) const;
 
   virtual void rebuildFull(
    OdDbIndexUpdateData* pIdxData);
  
  void setLastUpdatedAt(
    const OdDbDate& time);
    
  OdDbDate lastUpdatedAt() const;
  
  void setLastUpdatedAtU(
    const OdDbDate& time);
    
  OdDbDate lastUpdatedAtU() const;
  
  bool isUptoDate() const; 
  
  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);
 
  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;
 
  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);
 
  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;
 
protected:
 
 virtual void rebuildModified(
    OdDbBlockChangeIterator* iterator);
  
  friend class OdDbIndexImpl;
  friend void processBTRIndexObjects(
    OdDbBlockTableRecord* pBTR, 
    int indexCtlVal, 
    OdDbBlockChangeIterator* pBlkChgIter, 
    OdDbIndexUpdateData* pIdxUpdData );
};
typedef OdSmartPtr<OdDbIndex> OdDbIndexPtr;
 
class OdDbBlockTableRecord;
class OdDbBlockReference;
 
namespace OdDbIndexFilterManager
{
  TOOLKIT_EXPORT void updateIndexes(
    OdDbDatabase* pDb);
  
  TOOLKIT_EXPORT void addIndex(
    OdDbBlockTableRecord* pBTR, 
    OdDbIndex* pIndex);
  
  TOOLKIT_EXPORT void removeIndex(
    OdDbBlockTableRecord* pBTR, 
    const OdRxClass* key);
 
  
  TOOLKIT_EXPORT OdDbIndexPtr getIndex(
    const OdDbBlockTableRecord* pBTR, 
    const OdRxClass* key, 
    OdDb::OpenMode readOrWrite = OdDb::kForRead);
 
    TOOLKIT_EXPORT OdDbIndexPtr getIndex(
    const OdDbBlockTableRecord* pBTR, 
    int btrIndex, 
    OdDb::OpenMode readOrWrite = OdDb::kForRead);
  
  TOOLKIT_EXPORT int numIndexes(
    const OdDbBlockTableRecord* pBTR);
  
  TOOLKIT_EXPORT void addFilter(
    OdDbBlockReference* pBlkRef, 
    OdDbFilter* pFilter);
  
  TOOLKIT_EXPORT void removeFilter(
    OdDbBlockReference* pBlkRef, 
    const OdRxClass* key);
  
  TOOLKIT_EXPORT OdDbFilterPtr getFilter(
    const OdDbBlockReference* pBlkRef, 
    const OdRxClass* key, 
    OdDb::OpenMode readOrWrite);
  
    TOOLKIT_EXPORT OdDbFilterPtr getFilter(
    const OdDbBlockReference* pBlkRef, 
    int btrIndex, 
    OdDb::OpenMode readOrWrite);
  
  TOOLKIT_EXPORT int numFilters(
    const OdDbBlockReference* pBlkRef);
}
 
#include "TD_PackPop.h"
 
#endif // OD_DBINDEX_H