FinderUtils.hxx

Go to the documentation of this file.

// Copyright 2022 Siemens Digital Industries Software
// ==================================================
// Copyright 2015.
// Siemens Product Lifecycle Management Software Inc.
// All Rights Reserved.
// ==================================================
// Copyright 2022 Siemens Digital Industries Software

#ifndef QRY_FINDERUTILS_HXX
#define QRY_FINDERUTILS_HXX

#include <vector>
#include <stdlib.h>
#include <string.h>
#include <iostream>
#include <map>
#include <metaframework/BusinessObject.hxx>
#include <metaframework/BusinessObjectRef.hxx>
#include <tccore/aom_prop.h>
#include <qry/libqry_exports.h>


namespace Teamcenter
{
    namespace QRY
    {
        class FinderUtils;
    }
}

class QRY_API Teamcenter::QRY::FinderUtils
{
public:

    struct PropertyGroupingValue
    {
        std::string propertyGroupID;
        std::string startValue;
        std::string endValue;
    };

    typedef std::map< BusinessObjectRef<Teamcenter::BusinessObject>, std::vector< std::string > > ObjectPropertyGroupingMap;;

    struct ObjectsGroupedByProperty
    {
        std::string internalPropertyName;
        ObjectPropertyGroupingMap groupedObjectsMap;
        std::vector< BusinessObjectRef<Teamcenter::BusinessObject> > unmatchedObjectList;
    };

    struct ObjectPropertyGroupInput
    {
        std::string internalPropertyName;
        std::vector< PropertyGroupingValue > propertyValues;
        std::vector< BusinessObjectRef<Teamcenter::BusinessObject> > objectList;
    };


    static int groupObjectsByProperties(
                                         const std::vector< ObjectPropertyGroupInput >& objectPropertyGroupInputList, 
                                         std::vector< ObjectsGroupedByProperty>& groupedObjectsList                   
                                       );

    
    
private:

    FinderUtils();

    FinderUtils(const FinderUtils& obj);

    FinderUtils&  operator=(const FinderUtils&  other);

    ~FinderUtils();

    static logical to_logical( std::string const& s );

    static char* getReferencedObjectProperty( const tag_t &object_tag, std::string internalPropertyName );

    static bool isUserObject( const tag_t referencedObject );

    static logical isStartValueEmptyOrNone( const FinderUtils::PropertyGroupingValue propertyValue );

    static logical endValueExists( const FinderUtils::PropertyGroupingValue propertyValue );

    static std::vector< std::string > getGroupWithNoneInStartValues( const FinderUtils::ObjectPropertyGroupInput *objectPropertyGroupInput );

    static void processIntegerProperty( BusinessObjectRef<Teamcenter::BusinessObject> &businessObject,
                                    FinderUtils::ObjectPropertyGroupInput &objectPropertyGroupInput,
                                    FinderUtils::ObjectPropertyGroupingMap &groupedObjectsMap,
                                    bool &foundGroup,
                                    const tag_t &tableRowBOTag,
                                    const char* tableRowPropertyName
                                   );

    static void processDoubleProperty( BusinessObjectRef<Teamcenter::BusinessObject> &businessObject,
                                   FinderUtils::ObjectPropertyGroupInput &objectPropertyGroupInput,
                                   FinderUtils::ObjectPropertyGroupingMap &groupedObjectsMap,
                                   bool &foundGroup,
                                   const tag_t &tableRowBOTag,
                                   const char* tableRowPropertyName
                                   );

    static void processLogicalProperty( BusinessObjectRef<Teamcenter::BusinessObject> &businessObject,
                                    FinderUtils::ObjectPropertyGroupInput &objectPropertyGroupInput,
                                    FinderUtils::ObjectPropertyGroupingMap &groupedObjectsMap,
                                    bool &foundGroup,
                                    const tag_t &tableRowBOTag,
                                    const char* tableRowPropertyName
                                   );

    static void processDateProperty( BusinessObjectRef<Teamcenter::BusinessObject> &businessObject,
                                 FinderUtils::ObjectPropertyGroupInput &objectPropertyGroupInput,
                                 FinderUtils::ObjectPropertyGroupingMap &groupedObjectsMap,
                                 bool &foundGroup,
                                 const tag_t &tableRowBOTag,
                                 const char* tableRowPropertyName
                                 );

    static void processCharProperty( BusinessObjectRef<Teamcenter::BusinessObject> &businessObject,
                                 FinderUtils::ObjectPropertyGroupInput &objectPropertyGroupInput,
                                 FinderUtils::ObjectPropertyGroupingMap &groupedObjectsMap,
                                 bool &foundGroup,
                                 const tag_t &tableRowBOTag,
                                 const char* tableRowPropertyName
                                 );

        static void processStringProperty( BusinessObjectRef<Teamcenter::BusinessObject> &businessObject,
                                   FinderUtils::ObjectPropertyGroupInput &objectPropertyGroupInput,
                                   FinderUtils::ObjectPropertyGroupingMap &groupedObjectsMap,
                                   bool &foundGroup,
                                   const tag_t &tableRowBOTag,
                                   const char* tableRowPropertyName
                                   );

    static void processReferenceProperty( BusinessObjectRef<Teamcenter::BusinessObject> &businessObject,
                                      FinderUtils::ObjectPropertyGroupInput &objectPropertyGroupInput,
                                      FinderUtils::ObjectPropertyGroupingMap &groupedObjectsMap,
                                      bool &isGroupFound
                                      );




    static void processPropertyValuesForGrouping(PROP_value_type_t &propertyValueType,
                                             BusinessObjectRef<Teamcenter::BusinessObject> &businessObject,
                                             FinderUtils::ObjectPropertyGroupInput &objectPropertyGroupInput,
                                             FinderUtils::ObjectPropertyGroupingMap &groupedObjectsMap,
                                             bool &isGroupFound,
                                             const tag_t &tableRowBOTag,
                                             const char* tableRowPropertyName
                                             );

};

#include <qry/libqry_undef.h>
#endif