/** * @file include/ActivMiddleware/ActivFramework/TableUiOptions.h * * @brief Header file for the table user interface options. */ #if (!defined ACTIV_FRAMEWORK_TABLE_UI_OPTIONS_H) #define ACTIV_FRAMEWORK_TABLE_UI_OPTIONS_H #include "ActivMiddleware/ActivFramework/External.h" #include "ActivMiddleware/ActivDatabase/ITable.h" #include "ActivMiddleware/ActivDatabase/Key.h" #include "ActivMiddleware/ActivDatabase/Record.h" #include "ActivMiddleware/ActivFramework/UiMenu.h" #include "ActivMiddleware/ActivFramework/UiIo.h" #include "ActivMiddleware/CxxYZ/vector.h" //! Activ namespace. namespace Activ { class File; //! Database namespace. namespace Database { /** * @brief Table user interface options class. */ class TableUiOptions { public: static const int TABLE_NAME_DISPLAY_WIDTH = 30; ///< The table name display width. static const int INDEX_NAME_DISPLAY_WIDTH = 50; ///< The index name display width. static const int FIELD_NAME_DISPLAY_WIDTH = 30; ///< The field name display width. static const int RECORD_COUNT_DISPLAY_WIDTH = 8; ///< The record count display width. static const size_t DEFAULT_DISPLAY_WIDTH = 79; ///< The default display width. static const size_t DISPLAY_BUFFER_SIZE = 4096; ///< The display buffer size width. static const String UNDEFINED_FIELD; /** * @brief Constructor. * * @param pTable a pointer to the table. */ ACTIV_FRAMEWORK_API TableUiOptions(ITable *pTable); /** * @brief Add all options. * * @param uiMenu the user interface menu to add the options to. */ ACTIV_FRAMEWORK_API void AddAllOptions(UiMenu &uiMenu); /** * @brief Add view-only options. * * @param uiMenu the user interface menu to add the options to. */ ACTIV_FRAMEWORK_API void AddViewOptions(UiMenu &uiMenu); /** * @brief Display statistics. * * @param uiIo the user interface i/o object. */ ACTIV_FRAMEWORK_API void DisplayStatistics(const UiIo &uiIo); /** * @brief Display index. * * @param uiIo the user interface i/o object. */ ACTIV_FRAMEWORK_API void DisplayIndex(const UiIo &uiIo); /** * @brief Display record. * * @param uiIo the user interface i/o object. */ ACTIV_FRAMEWORK_API void DisplayRecord(const UiIo &uiIo); /** * @brief Add record. * * @param uiIo the user interface i/o object. */ ACTIV_FRAMEWORK_API void AddRecord(const UiIo &uiIo); /** * @brief Modify record. * * @param uiIo the user interface i/o object. */ ACTIV_FRAMEWORK_API void ModifyRecord(const UiIo &uiIo); /** * @brief Delete record. * * @param uiIo the user interface i/o object. */ ACTIV_FRAMEWORK_API void DeleteRecord(const UiIo &uiIo); /** * @brief Save as a text file. * * @param uiIo the user interface i/o object. */ ACTIV_FRAMEWORK_API void SaveAsTextFile(const UiIo &uiIo); /** * @brief Read from a text file. * * @param uiIo the user interface i/o object. */ ACTIV_FRAMEWORK_API void ReadFromTextFile(const UiIo &uiIo); /** * @brief Clear. * * @param uiIo the user interface i/o object. */ ACTIV_FRAMEWORK_API void Clear(const UiIo &uiIo); /** * @brief Save. * * @param uiIo the user interface i/o object. */ ACTIV_FRAMEWORK_API void Save(const UiIo &uiIo); /** * @brief Read. * * @param uiIo the user interface i/o object. */ ACTIV_FRAMEWORK_API void Read(const UiIo &uiIo); /** * @brief Check table integrity. * * @param uiIo the user interface i/o object. */ ACTIV_FRAMEWORK_API void CheckIntegrity(const UiIo &uiIo); /** * @brief Display statistics. * * @param uiIo the user interface i/o object. * @param pTable a pointer to the table. */ ACTIV_FRAMEWORK_API static void DisplayStatistics(const UiIo &uiIo, ITable *pTable); /** * @brief Display index. * * @param uiIo the user interface i/o object. * @param pTable a pointer to the table. */ ACTIV_FRAMEWORK_API static void DisplayIndex(const UiIo &uiIo, ITable *pTable); /** * @brief Display record. * * @param uiIo the user interface i/o object. * @param pTable a pointer to the table. * @param record the displayed record. * * @return whether a record was displayed. */ ACTIV_FRAMEWORK_API static bool DisplayRecord(const UiIo &uiIo, ITable *pTable, Record &record); /** * @brief Add record. * * @param uiIo the user interface i/o object. * @param pTable a pointer to the table. * @param record the added record. * * @return whether a record was added. */ ACTIV_FRAMEWORK_API static bool AddRecord(const UiIo &uiIo, ITable *pTable, Record &record); /** * @brief Modify record. * * @param uiIo the user interface i/o object. * @param pTable a pointer to the table. * @param record the modified record. * @param originalRecord the original record. * * @return whether a record was modified. */ ACTIV_FRAMEWORK_API static bool ModifyRecord(const UiIo &uiIo, ITable *pTable, Record &record, Record &originalRecord); /** * @brief Delete record. * * @param uiIo the user interface i/o object. * @param pTable a pointer to the table. * @param key the deleted key. * @param record the deleted record. * * @return whether a record was deleted. */ ACTIV_FRAMEWORK_API static bool DeleteRecord(const UiIo &uiIo, ITable *pTable, Key &key, Record &record); /** * @brief Save as a text file. * * @param uiIo the user interface i/o object. * @param pTable a pointer to the table. */ ACTIV_FRAMEWORK_API static void SaveAsTextFile(const UiIo &uiIo, ITable *pTable); /** * @brief Read from a text file. * * @param uiIo the user interface i/o object. * @param pTable a pointer to the table. */ ACTIV_FRAMEWORK_API static void ReadFromTextFile(const UiIo &uiIo, ITable *pTable); /** * @brief Clear. * * @param uiIo the user interface i/o object. * @param pTable a pointer to the table. */ ACTIV_FRAMEWORK_API static void Clear(const UiIo &uiIo, ITable *pTable); /** * @brief Save. * * @param uiIo the user interface i/o object. * @param pTable a pointer to the table. * @param directory the directory to save the data into. */ ACTIV_FRAMEWORK_API static void Save(const UiIo &uiIo, ITable *pTable, const String &directory = String("")); /** * @brief Read. * * @param uiIo the user interface i/o object. * @param pTable a pointer to the table. * @param directory the directory to read the data from. */ ACTIV_FRAMEWORK_API static void Read(const UiIo &uiIo, ITable *pTable, const String &directory = String("")); /** * @brief Check table integrity. * * @param uiIo the user interface i/o object. * @param pTable a pointer to the table. */ ACTIV_FRAMEWORK_API static void CheckIntegrity(const UiIo &uiIo, ITable *pTable); /** * @brief Display a record. * * @param uiIo the user interface i/o object. * @param record the record to display. * * @return whether a record was displayed. */ ACTIV_FRAMEWORK_API static bool DisplayRecord(const UiIo &uiIo, Record &record); /** * @brief Get the index number. * * @param uiIo the user interface i/o object. * @param pTable a pointer to the table. * @param indexNo the index number. * @param allowDuplicateIndex whether allowed to get a duplicate index. * @param allowHashIndex whether allowed to get a hash index. * * @return whether the call was a success. */ ACTIV_FRAMEWORK_API static bool GetIndexNumber(const UiIo &uiIo, ITable *pTable, IndexSpecification::Number &indexNo, const bool allowDuplicateIndex, const bool allowHashIndex); /** * @brief Get the ordered field specification list. * * @param fieldListObject the field list object. * @param orderedFieldSpecificationList the ordered field specification list. * * @return whether the call was a success. */ ACTIV_FRAMEWORK_API static bool GetOrderedFieldSpecificationList(FieldListObject &fieldListObject, FieldSpecificationList &orderedFieldSpecificationList); /** * @brief Get the field specification list. * * @param uiIo the user interface i/o object. * @param prompt the prompt. * @param fieldListObject the field list object. * @param fieldSpecificationList the field specification list. * @param displayFieldList whether the field list should be displayed. * * @return whether the call was a success. */ ACTIV_FRAMEWORK_API static bool GetFieldSpecificationList(const UiIo &uiIo, const String &prompt, FieldListObject &fieldListObject, FieldSpecificationList &fieldSpecificationList, const bool displayFieldList); /** * @brief Get the field specification. * * @param uiIo the user interface i/o object. * @param prompt the prompt. * @param fieldListObject the field list object. * @param fieldSpecification the field specification. * @param displayFieldList whether the field list should be displayed. * * @return whether the call was a success. */ ACTIV_FRAMEWORK_API static bool GetFieldSpecification(const UiIo &uiIo, const String &prompt, FieldListObject &fieldListObject, FieldSpecification &fieldSpecification, const bool displayFieldList); /** * @brief Get key fields. * * @param uiIo the user interface i/o object. * @param key the key. * @param shouldGetMatchingKey whether should attempt to get a matching key. * @param pAllKeyFields whether all the key fields were entered. * * @return whether the call was a success. */ ACTIV_FRAMEWORK_API static bool GetKeyFields(const UiIo &uiIo, Key &key, const bool shouldGetMatchingKey, bool *pAllKeyFields = 0); /** * @brief Get fields. * * @param uiIo the user interface i/o object. * @param fieldListObject the field list object. * * @return whether the call was a success. */ ACTIV_FRAMEWORK_API static bool GetFields(const UiIo &uiIo, FieldListObject &fieldListObject); /** * @brief Get a field. * * @param uiIo the user interface i/o object. * @param fieldSpecification the field specification. * @param fieldListObject the field list object. * * @return whether the call was a success. */ ACTIV_FRAMEWORK_API static StatusCode GetField(const UiIo &uiIo, const FieldSpecification &fieldSpecification, FieldListObject &fieldListObject); /** * @brief Display the field. * * @param fieldListObject the field list object. * @param fieldSpecification the field specification. * @param maxFieldDisplayWidth the maximum field display width. * * @return the maximum field display width. */ ACTIV_FRAMEWORK_API static String DisplayField(const FieldListObject &fieldListObject, const FieldSpecification &fieldSpecification, const size_t maxFieldDisplayWidth = ~0); /** * @brief Get the maximum field display width. * * @param fieldSpecification the field specification. * @param shouldIncludeFieldName whether the field name should be included in the calculation. * * @return the maximum field display width. */ ACTIV_FRAMEWORK_API static int GetMaxFieldDisplayWidth(const FieldSpecification &fieldSpecification, const bool shouldIncludeFieldName = true); /** * @brief Field display sort function. * * @return whether lhs is less than rhs. */ ACTIV_FRAMEWORK_API static bool FieldDisplaySort(const String &lhs, const String &rhs); private: typedef std::vector StringList; ///< Type definition for a list of strings. typedef CxxYZ::unique_ptr FieldTypePtr; ///< Field type ptr type definition for use in stl containers. typedef CxxYZ::vector FieldTypePtrList; ///< Field type ptr list type definition. /** * @brief Save to file. * * @param uiIo user interface io object. * @param file the file to write the output to. * @param pTable a pointer to the table. * @param indexNo the index number. * @param fieldSpecificationList the field specification list to search. * * @throw StatusCodeException * @throw DatabaseException */ static void SaveToFile(const UiIo &uiIo, const String &fileName, ITable *pTable, const IndexSpecification::Number indexNo, const FieldSpecificationList &fieldSpecificationList); /** * @brief Save to screen. * * @param uiIo user interface io object. * @param pTable a pointer to the table. * @param indexNo the index number. * @param fieldSpecificationList the field specification list to search. * * @throw StatusCodeException * @throw DatabaseException */ static void SaveToScreen(const UiIo &uiIo, ITable *pTable, const IndexSpecification::Number indexNo, const FieldSpecificationList &fieldSpecificationList); /** * @brief Get field type pointer list. * * Creates a list of field type objects using the types specified in the field specification list. * * @param uiIo user interface io object. * @param fieldSpecificationList the field specification list to search. * @param fieldTypePtrList set to the list of created field type pointers. * * @throw StatusCodeException */ static void GetFieldTypePtrList(const UiIo &uiIo, const FieldSpecificationList &fieldSpecificationList, FieldTypePtrList &fieldTypePtrList); /** * @brief Get key field offset list. * * Gets the offsets into the field specification list for the fields required for the key. * * @param uiIo user interface io object. * @param fieldSpecificationList the field specification list to search. * @param key the key. * @param keyFieldOffsetList set to the offsets into the field specification list for each of the key fields. * * @throw StatusCodeException */ static void GetKeyFieldOffsetList(const UiIo &uiIo, const FieldSpecificationList &fieldSpecificationList, const Key &key, std::vector &keyFieldOffsetList); /** * @brief Read a field specification list from a file. * * @param uiIo user interface io object. * @param file handle to the file. * @param pTable the table. * @param fieldSpecificationList set equal to the field specification list read from the file. * * @throw StatusCodeException */ static void ReadFieldSpecificationList(const UiIo &uiIo, File &file, const ITable * const pTable, FieldSpecificationList &fieldSpecificationList); /** * @brief Read the field types. * * @param uiIo user interface io object. * @param file handle to the file. * @param fieldTypePtrList set to the values read from the file. * * @param STATUS_CODE_SUCCESS * @param STATUS_CODE_END_OF_DATA * * @throw StatusCodeException */ static StatusCode ReadFieldTypes(const UiIo &uiIo, File &file, FieldTypePtrList &fieldTypePtrList); /** * @brief Read strings. * * @param file handle to the file. * @param stringList set equal to the list of read strings. * * @retval STATUS_CODE_SUCCESS * @retval STATUS_CODE_END_OF_DATA */ static StatusCode ReadStrings(File &file, StringList &stringList); ITable *m_pTable; ///< A pointer to the table. }; } // namespace Database } // namespace Activ #endif // (!defined ACTIV_FRAMEWORK_TABLE_UI_OPTIONS_H)