gb_flatfile_load_manager.cpp

Go to the documentation of this file.

Go to the SVN repository for this file.

/*  $Id: gb_flatfile_load_manager.cpp 46563 2021-07-13 17:50:23Z asztalos $
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * Authors:  Andrea Asztalos
 *
 */
 
#include <ncbi_pch.hpp>
 
#include <gui/packages/pkg_sequence/gb_flatfile_load_manager.hpp>
 
#include <gui/widgets/loaders/gb_flatfile_params_panel.hpp>
#include <gui/widgets/loaders/gb_flatfile_object_loader.hpp>
#include <gui/widgets/wx/file_extensions.hpp>
#include <wx/filename.h>
 
 
BEGIN_NCBI_SCOPE
USING_SCOPE(objects);
 
wxPanel* CGBFlatFileLoadManager::CPage::GetPanel()
{
    return m_Manager.x_GetParamsPanel();
}
 
bool CGBFlatFileLoadManager::CPage::CanLeavePage(bool)
{
    CGBFlatFileParamsPanel* panel = m_Manager.x_GetParamsPanel();
    if (panel) {
        if (!panel->TransferDataFromWindow())
            return false;
        m_Manager.m_Params = panel->GetData();
    }
 
    return true;
}
 
///////////////////////////////////////////////////////////////////////////////
/// CGBFlatFileLoadManager
CGBFlatFileLoadManager::CGBFlatFileLoadManager()
     : m_Descr("GenBank FlatFile files", ""), m_OptionsPage(*this)
{
    m_Descr.SetLogEvent("loaders");
}
 
//
// IFileLoadPanelClient implementation
//
 
string CGBFlatFileLoadManager::GetLabel() const
{
    return m_Descr.GetLabel();
}
 
wxString CGBFlatFileLoadManager::GetFormatWildcard() const
{
    return CFileExtensions::GetDialogFilter(CFileExtensions::kGenBank) + wxT("|") +
           CFileExtensions::GetDialogFilter(CFileExtensions::kAllFiles);
}
 
//
// IUILoadManager implementation
//
 
void CGBFlatFileLoadManager::SetServiceLocator(IServiceLocator* srv_locator)
{
    m_SrvLocator = srv_locator;
}
 
 
void CGBFlatFileLoadManager::SetParentWindow(wxWindow* parent)
{
    m_ParentWindow = parent;
}
 
 
const IUIObject& CGBFlatFileLoadManager::GetDescriptor() const
{
    return m_Descr;
}
 
 
void CGBFlatFileLoadManager::InitUI()
{
    m_State = eParams;
}
 
 
void CGBFlatFileLoadManager::CleanUI()
{
    m_State = eInvalid;
    m_ParamsPanel = nullptr;
}
 
wxPanel* CGBFlatFileLoadManager::GetCurrentPanel()
{
    return (m_State == eParams) ? x_GetParamsPanel() : nullptr;
}
 
CGBFlatFileParamsPanel* CGBFlatFileLoadManager::x_GetParamsPanel()
{
    if (m_ParamsPanel == NULL) {
        m_ParamsPanel = new CGBFlatFileParamsPanel(m_ParentWindow);
        m_ParamsPanel->SetData(m_Params);
        m_ParamsPanel->TransferDataToWindow();
    }
    return m_ParamsPanel;
}
 
bool CGBFlatFileLoadManager::CanDo(EAction action)
{
    switch (m_State) {
    case eParams:
        return action == eNext;
    case eCompleted:
        return action == eBack;
    default:
        _ASSERT(false);
    }
    return false;
}
 
 
bool CGBFlatFileLoadManager::IsFinalState()
{
    return m_State == eParams;
}
 
 
bool CGBFlatFileLoadManager::IsCompletedState()
{
    return m_State == eCompleted;
}
 
 
bool CGBFlatFileLoadManager::DoTransition(EAction action)
{
    if (m_State == eParams && action == eNext) {
        if (m_ParamsPanel->TransferDataFromWindow()) {
            //TODO validate
            m_Params = m_ParamsPanel->GetData();
            m_State = eCompleted;
            return true;
        }
        return false;
    }
    else if (m_State == eCompleted && action == eBack) {
        m_State = eParams;
        return true;
    }
    _ASSERT(false);
    return false;
}
 
IAppTask* CGBFlatFileLoadManager::GetTask()
{
    return nullptr;
}
 
IExecuteUnit* CGBFlatFileLoadManager::GetExecuteUnit()
{
    return new CGBFlatFileObjectLoader(m_Params, m_FileNames);
}
 
wxString CGBFlatFileLoadManager::GetFormatWildcard()
{
    return CFileExtensions::GetDialogFilter(CFileExtensions::kGenBank) + wxT("|") +
           CFileExtensions::GetDialogFilter(CFileExtensions::kAllFiles);
}
 
 
bool CGBFlatFileLoadManager::ValidateFilenames(const vector<wxString>&)
{
    // not implemented
    return true;
}
 
 
void CGBFlatFileLoadManager::SetFilenames(const vector<wxString>& filenames)
{
    m_FileNames = filenames;
}
 
void CGBFlatFileLoadManager::GetFilenames(vector<wxString>& filenames) const
{
    filenames = m_FileNames;
}
 
bool CGBFlatFileLoadManager::IsInitialState()
{
    return m_State == eParams;
}
 
 
bool CGBFlatFileLoadManager::RecognizeFormat(const wxString& filename)
{
    wxString ext;
    wxFileName::SplitPath(filename, 0, 0, &ext);
    return CFileExtensions::RecognizeExtension(CFileExtensions::kGenBank, ext);
}
 
bool CGBFlatFileLoadManager::RecognizeFormat(CFormatGuess::EFormat fmt)
{
    return fmt == CFormatGuess::eFlatFileGenbank;
}
 
string CGBFlatFileLoadManager::GetExtensionIdentifier() const
{
    static string sid("genbank_flatfile_load_manager");
    return sid;
}
 
string CGBFlatFileLoadManager::GetExtensionLabel() const
{
    static string slabel("GenBank FlatFile Format Load Manager");
    return slabel;
}
 
void CGBFlatFileLoadManager::SetRegistryPath(const string& path)
{
    m_RegPath = path; // store for later use
    m_Params.SetRegistryPath(m_RegPath + ".GBFlatFileParams");
}
 
void CGBFlatFileLoadManager::SaveSettings() const
{
    m_Params.SaveSettings();
}
 
void CGBFlatFileLoadManager::LoadSettings()
{
    m_Params.LoadSettings();
}
 
 
END_NCBI_SCOPE