ClientFolder.h

    /*
    ** \brief Client ID Part
    **
    ** This function constructs a string that appears as the id
    **  element that contains the name we are looking for.  The
    **  id element is a value that begins with " ~ C" (for customer)
    **  and then a leading-zero-padded numeric string.  This is
    **  usually enough to be able to track down a potentially
    **  lost client folder in event that someone renamed it.
    **
    ** \par Examples include:
    ** \code
    **   " ~ C012320"
    **   " ~ C045939"
    **   " ~ C020034"
    **   " ~ C200443"
    **   " ~ C520344"
    **    \v/v\--v-/
    **     | |   |
    **     | |   +---- clientId()
    **     | +-------- clientIdPrefix()
    **     +---------- separator
    ** \endcode
    **
    */

    /*
    ** \brief Client Folder Name
    **
    ** This function calculates what the client folder name
    **  should be.
    **
    ** \par Examples include:
    ** \code
    **  AAA (AAA COSMETIC SUPPLY) ~ C006585
    **  ADVANCE (ADVANCE PROTOTYPES INC) ~ C006767
    **  ALB (ALFRED LARGE BOATS) ~ C000005
    **  ALF (AMWARE COMPANY INC) ~ C002885
    **  DATA (DATA TRANSFER CABLE INC) ~ C002247
    **  DEIPLAN (DEIPLAN-TRAVELOCO) ~ C005227
    **  DEKA (DEKA LIBRARY CO) ~ C001319
    **  DSI (DSI INDIRECT) ~ C006488
    **  DYNE (DYNE ROUNDABOUT) ~ C006166
    **  DYNE IND (DYNE INDISCRETE) ~ C005418
    **  SOLO (SOLO SINGERS) ~ C002094
    **  SOP (SOPLANTING INC) ~ C000030
    **  STAY (STAY AWAY INC) ~ C002876
    **  \-v-/ \-----v-----/  \----v---/
    **    |         |             |
    **    |         |             +------------ clientIdPart()
    **    |         +-------------------------- name()
    **    +------------------------------------ key()
    ** \endcode
    **
    */

    /*
    ** \brief Folder Path
    **
    ** The folder is more-or-less an absolute path
    **  of the hard-drive.
    **
    ** \par Examples include:
    ** \code
    **  approot/customer/A/AAA (AAA COSMETIC SUPPLY) ~ C006585
    **  approot/customer/A/ADVANCE (ADVANCE PROTOTYPES INC) ~ C006767
    **  approot/customer/A/ALB (ALFRED LARGE BOATS) ~ C000005
    **  approot/customer/A/ALF (AMWARE COMPANY INC) ~ C002885
    **  approot/customer/D/DATA (DATA TRANSFER CABLE INC) ~ C002247
    **  approot/customer/D/DEIROSSI (DEIPLAN-TRAVELOCO) ~ C005227
    **  approot/customer/D/DEKA (DEKA LIBRARY CO) ~ C001319
    **  approot/customer/D/DSI (DSI INDIRECT) ~ C006488
    **  approot/customer/D/DYNE (DYNE ROUNDABOUT) ~ C006166
    **  approot/customer/D/DYNE IND (DYNE INDISCRETE) ~ C005418
    **  approot/customer/S/SOLO (SOLO SINGERS) ~ C002094
    **  approot/customer/S/SOP (SOPLANTING INC) ~ C000030
    **  approot/customer/S/STAY (STAY AWAY INC) ~ C002876
    **  \-------v------/ v \-v-/ \-----v-----/  \----v---/
    **          |        |   |         |             |
    **          |        |   |         |             +------------ clientIdPart()
    **          |        |   |         +-------------------------- name()
    **          |        |   +------------------------------------ key()
    **          |        +---------------------------------------- fileCode()
    **          +------------------------------------------------- rootPath()
    ** \endcode
    **
    */

#ifndef __WTX_CLIENTFOLDER_H_234e0174_6b7d_11e8_b503_fb1ef3651ec0__
#define __WTX_CLIENTFOLDER_H_234e0174_6b7d_11e8_b503_fb1ef3651ec0__

#include <string>
#include <vector>

namespace Wtx {
/*
** \image html WtxClientFolderSample.png
*/

class ClientFolder
: public Wt::WObject
{
  public:

    ClientFolder();

    ClientFolder
    (
     int uid,
     const std::string & key,
     const std::string & name
    );

    ClientFolder
    (
     const std::string & uid,
     const std::string & key,
     const std::string & name
    );

    ClientFolder( const ClientFolder & copy );

    static void setup
    (

     const std::string & rootPath,

     const std::string & idPrefix,

     int idLength,

     char idPadding,

     const std::string & idSuffix

    ); // endstatic void setup

    static std::string & rootPath();

    static std::string & idPrefix();

    static int idLength();

    static std::string & idSuffix();

    static char idPadding();

    bool isValid() const;

    const std::string & uid() const;

    const std::string & key() const;

    const std::string & name() const;

    std::string fileParent( const std::string & subFolder = "" ) const;

    std::string filePath( const std::string & subFolder = "" ) const;

    std::string fileFolder( const std::string & subFolder = "" ) const;

    std::string fileAbsolutePath( const std::string & subFolder = "" ) const;

    std::string fileId() const;

    std::string fileCode() const;

    std::string fileName() const;

    std::string fileKey() const;

    std::string fileChar() const;

    std::string fileRoot( const std::string & subFolder = "" ) const;

    static std::string folder( const std::string & base, const std::string & sub );

  private:

    static std::string s_rootPath;
    static std::string s_idPrefix;
    static int         s_idLength;
    static char        s_idPadding;
    static std::string s_idSuffix;

    bool m_isValid;
    std::string m_uid;
    std::string m_key;
    std::string m_name;

}; // endclass ClientFolder

} // endnamespace Wtx

#endif // #ifndef __WTX_CLIENTFOLDER_H___