dcmwlm/include/dcmtk/dcmwlm/wlds.h

/*
 *
 *  Copyright (C) 1996-2010, OFFIS e.V.
 *  All rights reserved.  See COPYRIGHT file for details.
 *
 *  This software and supporting documentation were developed by
 *
 *    OFFIS e.V.
 *    R&D Division Health
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *
 *  Module:  dcmwlm
 *
 *  Author:  Thomas Wilkens
 *
 *  Purpose: (Partially) abstract class for connecting to an arbitrary data source.
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2010-10-14 13:16:38 $
 *  CVS/RCS Revision: $Revision: 1.28 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */

#ifndef WlmDataSource_h
#define WlmDataSource_h

#include "dcmtk/config/osconfig.h"
#include "dcmtk/dcmwlm/wltypdef.h"
#include "dcmtk/dcmdata/dcdatset.h"
#include "dcmtk/oflog/oflog.h"

OFLogger DCM_dcmwlmGetLogger();

#define DCMWLM_TRACE(msg) OFLOG_TRACE(DCM_dcmwlmGetLogger(), msg)
#define DCMWLM_DEBUG(msg) OFLOG_DEBUG(DCM_dcmwlmGetLogger(), msg)
#define DCMWLM_INFO(msg)  OFLOG_INFO(DCM_dcmwlmGetLogger(), msg)
#define DCMWLM_WARN(msg)  OFLOG_WARN(DCM_dcmwlmGetLogger(), msg)
#define DCMWLM_ERROR(msg) OFLOG_ERROR(DCM_dcmwlmGetLogger(), msg)
#define DCMWLM_FATAL(msg) OFLOG_FATAL(DCM_dcmwlmGetLogger(), msg)

class DcmAttributeTag;
class DcmLongString;

class WlmDataSource
{
  protected:

    OFBool failOnInvalidQuery;
    OFString calledApplicationEntityTitle;
    DcmDataset *identifiers;
    DcmAttributeTag *errorElements;
    DcmAttributeTag *offendingElements;
    DcmLongString *errorComment;
    OFBool foundUnsupportedOptionalKey;
    OFBool readLockSetOnDataSource;
    OFBool noSequenceExpansion;
    WlmReturnedCharacterSetType returnedCharacterSet;
    OFList<DcmDataset*> matchingDatasets;
    OFString specificCharacterSet;
    WlmSuperiorSequenceInfoType *superiorSequenceArray;
    unsigned long numOfSuperiorSequences;

    OFBool CheckSearchMask( DcmDataset *searchMask );

    void CheckNonSequenceElementInSearchMask( DcmDataset *searchMask, int &invalidMatchingKeyAttributeCount, DcmElement *element, DcmSequenceOfItems *supSequenceElement=NULL );

    void CheckSequenceElementInSearchMask( DcmDataset *searchMask, int &invalidMatchingKeyAttributeCount, DcmElement *element, DcmSequenceOfItems *supSequenceElement=NULL );

    void ExpandEmptySequenceInSearchMask( DcmElement *&element );

    OFBool IsSupportedMatchingKeyAttribute( DcmElement *element, DcmSequenceOfItems *supSequenceElement=NULL );

    OFBool IsSupportedReturnKeyAttribute( DcmElement *element, DcmSequenceOfItems *supSequenceElement=NULL );

    void ClearDataset( DcmDataset *idents );

    void PutOffendingElements( const DcmTagKey &tag );

    void PutErrorElements( const DcmTagKey &tag );

    OFBool CheckMatchingKey( const DcmElement *elem );

    OFBool ContainsOnlyValidCharacters( const char *s, const char *charset );

    OFBool IsValidDateOrDateRange( const OFString& value );

    OFBool IsValidDate( const OFString& value );

    OFBool IsValidTimeOrTimeRange( const OFString& value );

    OFBool IsValidTime( const OFString& value );

    OFBool GetStringValue( const DcmElement *elem,
                           OFString& resultVal );

    OFString DeleteLeadingAndTrailingBlanks( const OFString& value );

    WlmDataSource( const WlmDataSource &Src );

    WlmDataSource &operator=( const WlmDataSource &Src );


  public:
    WlmDataSource();

    virtual ~WlmDataSource();

    virtual OFCondition ConnectToDataSource() = 0;

    virtual OFCondition DisconnectFromDataSource() = 0;

    void SetCalledApplicationEntityTitle( const OFString& value );

    void SetFailOnInvalidQuery( OFBool value );

    void SetNoSequenceExpansion( OFBool value );

    void SetReturnedCharacterSet( WlmReturnedCharacterSetType value );

    virtual OFBool IsCalledApplicationEntityTitleSupported() = 0;

    virtual WlmDataSourceStatusType StartFindRequest( const DcmDataset &findRequestIdentifiers ) = 0;

    virtual DcmDataset *NextFindResponse( WlmDataSourceStatusType &rStatus ) = 0;

    WlmDataSourceStatusType CancelFindRequest();

    DcmAttributeTag *GetOffendingElements();

    DcmLongString *GetErrorComments();

    virtual void SetDbDsn( const OFString& /*value*/ ) {}

    virtual void SetDbUserName( const OFString& /*value*/ ) {}

    virtual void SetDbUserPassword( const OFString& /*value*/ ) {}

    virtual void SetCfgFileMatchRecords( const OFString& /*value*/ ) {}

    virtual void SetCfgFileSelectValues( const OFString& /*value*/ ) {}

    virtual void SetDatabaseType( WlmDatabaseType /*value*/ ) {}

    virtual void SetSerialNumber( const int /*value*/ ) {}

    virtual void SetInstitutionId( const unsigned int /*value*/ ) {}

    virtual void SetDfPath( const OFString& /*value*/ ) {}

    virtual void SetEnableRejectionOfIncompleteWlFiles( OFBool /*value*/ ) {}

    virtual void SetCreateNullvalues( OFBool /*value*/ ) {}

    virtual void SetPfFileName( const OFString& /*value*/ ) {}

    virtual void SetModalityToReturn( const OFString& /*value*/ ) {}

    virtual void SetCommaSeparatePatientName( OFBool /*value*/ ) {}

    virtual void SetReturnPatientUidInAccessionNumber( OFBool /*value*/ ) {}
};

#endif

/*
** CVS Log
** $Log: wlds.h,v $
** Revision 1.28  2010-10-14 13:16:38  joergr
** Updated copyright header. Added reference to COPYRIGHT file.
**
** Revision 1.27  2010-08-09 13:29:38  joergr
** Updated data dictionary to 2009 edition of the DICOM standard. From now on,
** the official "keyword" is used for the attribute name which results in a
** number of minor changes (e.g. "PatientsName" is now called "PatientName").
**
** Revision 1.26  2009-11-24 10:40:01  uli
** Switched to logging mechanism provided by the "new" oflog module.
**
** Revision 1.25  2009-09-30 08:40:34  uli
** Make dcmwlm's include headers self-sufficient by including all
** needed headers directly.
**
** Revision 1.24  2006-12-15 14:49:21  onken
** Removed excessive use char* and C-array in favour of OFString and
** OFList. Simplified some implementation details.
**
** Revision 1.23  2005/12/08 16:05:40  meichel
** Changed include path schema for all DCMTK header files
**
** Revision 1.22  2005/09/23 12:56:40  wilkens
** Added attribute PatientsBirthDate as a matching key attribute to wlmscpfs.
** Thanks to Andre M. Descombes <andre@descombes.info> for the code template.
**
** Revision 1.21  2005/05/04 11:34:31  wilkens
** Added two command line options --enable-file-reject (default) and
** --disable-file-reject to wlmscpfs: these options can be used to enable or
** disable a file rejection mechanism which makes sure only complete worklist files
** will be used during the matching process. A worklist file is considered to be
** complete if it contains all necessary type 1 information which the SCP might
** have to return to an SCU in a C-Find response message.
**
** Revision 1.20  2004/04/06 18:19:28  joergr
** Updated data dictionary, UIDs and transfer syntaxes for the latest Final Text
** Supplements (42 and 47) and Correction Proposals (CP 25).
**
** Revision 1.19  2004/01/15 12:01:24  wilkens
** Added function to Worklist Management Data Source Base Class. This function
** is needed in the private part of this toolkit.
**
** Revision 1.18  2004/01/07 09:52:18  wilkens
** Fixed typo in comment.
**
** Revision 1.17  2004/01/07 08:32:28  wilkens
** Added new sequence type return key attributes to wlmscpfs. Fixed bug that for
** equally named attributes in sequences always the same value will be returned.
** Added functionality that also more than one item will be returned in sequence
** type return key attributes.
**
** Revision 1.16  2004/01/02 13:56:14  wilkens
** Integrated new return key attributes into wlmscpfs and updated function that
** checks integrity of matching key attribute values (added support for new VR).
**
** Revision 1.15  2003/12/23 13:04:36  wilkens
** Integrated new matching key attributes into wlmscpfs.
**
** Revision 1.14  2003/12/11 10:45:33  wilkens
** Added function to Worklist Management Data Source Base Class. This function
** is needed in the private part of this toolkit.
**
** Revision 1.13  2003/08/21 13:38:23  wilkens
** Moved declaration and initialization of member variables matchingDatasets and
** numOfMatchingDatasets to base class.
** Got rid of superfluous member variable objlist and of superfluous function
** ClearObjList().
**
** Revision 1.12  2003/07/02 09:17:55  wilkens
** Updated documentation to get rid of doxygen warnings.
**
** Revision 1.11  2003/02/17 12:02:03  wilkens
** Made some minor modifications to be able to modify a special variant of the
** worklist SCP implementation (wlmscpki).
**
** Revision 1.10  2002/12/16 11:08:33  wilkens
** Added missing #include "osconfig.h" to certain files.
**
** Revision 1.9  2002/08/12 10:56:07  wilkens
** Made some modifications in in order to be able to create a new application
** which contains both wlmscpdb and ppsscpdb and another application which
** contains both wlmscpfs and ppsscpfs.
**
** Revision 1.8  2002/07/17 13:10:36  wilkens
** Corrected some minor logical errors in the wlmscpdb sources and completely
** updated the wlmscpfs so that it does not use the original wlistctn sources
** any more but standard wlm sources which are now used by all three variants
** of wlmscps.
**
** Revision 1.7  2002/07/01 14:13:56  wilkens
** Some more corrections to get rid of msvc6's warnings.
**
** Revision 1.6  2002/06/10 11:25:05  wilkens
** Made some corrections to keep gcc 2.95.3 quiet.
**
** Revision 1.5  2002/05/08 13:20:51  wilkens
** Added new command line option -nse to wlmscpki and wlmscpdb.
**
** Revision 1.4  2002/04/18 14:20:08  wilkens
** Modified Makefiles. Updated latest changes again. These are the latest
** sources. Added configure file.
**
** Revision 1.3  2002/01/08 17:45:34  joergr
** Reformatted source files (replaced Windows newlines by Unix ones, replaced
** tabulator characters by spaces, etc.)
**
** Revision 1.2  2002/01/08 16:50:12  joergr
** Added preliminary database support using OTL interface library (modified by
** MC/JR on 2001-12-21).
**
** Revision 1.1  2002/01/08 16:30:59  joergr
** Added new module "dcmwlm" developed by Thomas Wilkens (initial release for
** Windows, dated 2001-12-20).
**
**
*/

---

Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1