All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

Go to download

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

There is a newer version: 8.0.0
Show 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;

import org.apache.commons.lang3.StringUtils;

import java.io.PrintStream;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

import static java.util.stream.Collectors.toList;

/**
 * An abstract base class for implementing data tables.
 *
 * @author Manoel Campos da Silva Filho
 */
public abstract class AbstractTable implements Table {
    private PrintStream printStream;

    /** @see #getColumns() */
    private final List columns;

    /** @see #getTitle() */
    private String title;

    /** @see #getRows() */
    private final List> rows;

    /**
     * @see #getColumnSeparator()
     */
    private String columnSeparator;

    public AbstractTable(){
        this("");
    }

    /**
     * Creates a Table
     * @param title Title of the table
     */
    public AbstractTable(final String title){
        this.printStream = System.out;
        this.columns = new ArrayList<>();
        this.rows = new ArrayList<>();
        setTitle(title);
    }

    /**
     * @return the list of columns of the table
     */
    @Override
    public List getColumns() {
        return columns;
    }

    @Override
    public String getTitle() {
        return title;
    }

    @Override
    public final Table setTitle(final String title) {
        this.title = Objects.requireNonNull(title);
        return this;
    }

    @Override
    public String getColumnSeparator(){
        return columnSeparator;
    }

    @Override
    public final Table setColumnSeparator(String columnSeparator) {
        this.columnSeparator = columnSeparator;
        return this;
    }

    /**
     * @return The data to be printed, where each row contains
     * a list of data columns.
     */
    protected List> getRows() {
        return rows;
    }

    @Override
    public List newRow(){
        final List row = new ArrayList<>();
        rows.add(row);
        return row;
    }

    /**
     *
     * @return true if there is at least a column with a subtitle, false if no column
     * has a subtitle.
     */
    private boolean isThereAnySubtitledColumn(){
        return columns.stream().anyMatch(col -> StringUtils.isNotBlank(col.getSubTitle()));
    }

    private void printRow(final List row) {
        getPrintStream().printf(rowOpening());
        final List cols =
            columns.stream()
                .limit( Math.min(columns.size(), row.size()))
                .collect(toList());

        int idxCol = 0;
        for(final TableColumn col: cols){
            getPrintStream().print(col.generateData(row.get(idxCol++)));
        }
        getPrintStream().printf(rowClosing());
    }

    @Override
    public void print() {
        printTableOpening();
        printTitle();
        printColumnHeaders();
        rows.forEach(this::printRow);
        printTableClosing();
    }

    protected void printColumnHeaders(){
        printStream.printf(rowOpening());
        columns.forEach(col -> printStream.print(col.generateTitleHeader()));
        printStream.printf(rowClosing());
        if(isThereAnySubtitledColumn()){
            printSubtitleHeaders();
        }
    }

    private void printSubtitleHeaders() {
        printStream.printf(subtitleHeaderOpening());
        printStream.printf(rowOpening());
        columns.forEach(col -> printStream.printf(col.generateSubtitleHeader()));
        printStream.printf(rowClosing());
    }

    /**
     * Prints the string to open the table.
     */
    protected abstract void printTableOpening();

    /**
     * Prints the table title.
     */
    protected abstract void printTitle();

    /**
     * Gets the string that has to precede each printed row.
     * @return
     */
    protected abstract String rowOpening();

    /**
     * Gets the string to close a row.
     * @return
     */
    protected abstract String rowClosing();

    /**
     * Gets the string that has to precede subtitles head.
     * @return
     */
    protected abstract String subtitleHeaderOpening();

    /**
     * Prints the string to close the table.
     */
    protected abstract void printTableClosing();

    @Override
    public final Table addColumnList(final String... columnTitles) {
        for(final String column: columnTitles){
            addColumn(column);
        }
        return this;
    }

    @Override
    public final TableColumn addColumn(final String columnTitle) {
        return addColumn(getColumns().size(), columnTitle);
    }

    @Override
    public final TableColumn addColumn(final String columnTitle, final String columnSubTitle) {
        return addColumn(columnTitle).setSubTitle(columnSubTitle);
    }

    @Override
    public final TableColumn addColumn(final int index, final TableColumn column) {
        columns.add(index, column);
        return column;
    }

    @Override
    public final TableColumn addColumn(final TableColumn column) {
        return addColumn(columns.size(), column);
    }

    /**
     * Sets the {@link PrintStream} used to print the generated table.
     * @param printStream the {@link PrintStream} to set
     */
    public void setPrintStream(final PrintStream printStream) {
        this.printStream = printStream;
    }

    /**
     * Gets the {@link PrintStream} used to print the generated table.
     * @return the {@link PrintStream}
     */
    protected PrintStream getPrintStream() {
        return printStream;
    }
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy