net.librec.data.DataModel Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2016 LibRec
 * 
 * This file is part of LibRec.
 * LibRec is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 

 * LibRec is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with LibRec. If not, see .
 */
package net.librec.data;

import com.google.common.collect.BiMap;
import net.librec.common.LibrecException;
import net.librec.math.structure.DataSet;

/**
 * A DataModel represents a data access interface
 * to the input file.
 *
 * @author WangYuFeng
 */
public interface DataModel {
    /**
     * Build data model.
     *
     * @throws LibrecException
     *         if error occurs during building
     */
    public void buildDataModel() throws LibrecException;

    /**
     * Load data model.
     *
     * @throws LibrecException
     *         if error occurs during loading
     */
    public void loadDataModel() throws LibrecException;

    /**
     * Save data model.
     *
     * @throws LibrecException
     *         if error occurs during saving
     */
    public void saveDataModel() throws LibrecException;

    /**
     * Get data splitter.
     *
     * @return  the splitter of data model.
     */
    public DataSplitter getDataSplitter();

    /**
     * Get train data set.
     *
     * @return  the train data set of data model.
     */
    public DataSet getTrainDataSet();

    /**
     * Get test data set.
     *
     * @return  the test data set of data model.
     */
    public DataSet getTestDataSet();

    /**
     * Get valid data set.
     *
     * @return  the valid data set of data model.
     */
    public DataSet getValidDataSet();

    /**
     * Get datetime data set.
     *
     * @return  the datetime data set of data model.
     */
    public DataSet getDatetimeDataSet();

    /**
     * Get user mapping data.
     *
     * @return  the user {raw id, inner id} map of data model.
     */
    public BiMap getUserMappingData();

    /**
     * Get item mapping data.
     *
     * @return  the item {raw id, inner id} map of data model.
     */
    public BiMap getItemMappingData();

    /**
     * Get data appender.
     *
     * @return  the appender of data model.
     */
    public DataAppender getDataAppender();
    

    /**
     * Get data Context.
     *
     * @return  the appender of data model.
     */
    public DataContext getContext();
    
}