org.cloudsimplus.builders.tables.TableColumn Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cloudsim-plus Show documentation

CloudSim Plus: A modern, highly extensible and easier-to-use Java 8+ Framework for Modeling and Simulation of Cloud Computing Infrastructures and Services

The newest version!

/*
 * CloudSim Plus: A modern, highly-extensible and easier-to-use Framework for
 * Modeling and Simulation of Cloud Computing Infrastructures and Services.
 * http://cloudsimplus.org
 *
 *     Copyright (C) 2015-2021 Universidade da Beira Interior (UBI, Portugal) and
 *     the Instituto Federal de Educação Ciência e Tecnologia do Tocantins (IFTO, Brazil).
 *
 *     This file is part of CloudSim Plus.
 *
 *     CloudSim Plus 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.
 *
 *     CloudSim Plus 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 CloudSim Plus. If not, see .
 */
package org.cloudsimplus.builders.tables;

/**
 * An interface that represents a column of a table generated
 * using a {@link Table}.
 *
 * @author Manoel Campos da Silva Filho
 * @since CloudSim Plus 1.0
 */
public interface TableColumn {
    /**
     * Gets the index of the column into the table.
     * @return
     */
    int getIndex();

    /**
     * Generates the string that represents the data of the column,
     * formatted according to the {@link #getFormat() format}.
     * @param data The data of the column to be formatted
     * @return a string containing the formatted column data
     */
    String generateData(Object data);

    /**
     * Generates the string that represents the header of the column,
     * containing the column title.
     * @return the generated header string
     */
    String generateTitleHeader();

    /**
     * Generates the string that represents the sub-header of the column (if any),
     * containing the column subtitle.
     * @return the generated sub-header string
     */
    String generateSubtitleHeader();
    /**
     *
     * @return The format to be used to display the content of the column,
     * according to the {@link String#format(java.lang.String, java.lang.Object...)} (optional).
     */
    String getFormat();

    /**
     *
     * @return The subtitle to be displayed below the title of the column (optional).
     */
    String getSubTitle();

    /**
     *
     * @return The table that the column belongs to.
     */
    Table getTable();

    /**
     *
     * @return The title to be displayed at the top of the column.
     */
    String getTitle();

    /**
     * Sets the format to print the column data
     * @param format the format to set
     * @return
     */
    TableColumn setFormat(String format);

    TableColumn setSubTitle(String subTitle);

    TableColumn setTable(Table table);

    TableColumn setTitle(String title);
}