org.greports.annotations.Configuration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of greports Show documentation
There is a newer version: 3.4.2
package org.greports.annotations;

import org.apache.commons.lang3.StringUtils;
import org.greports.utils.TranslationsParser;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Configuration {

    /**
     * Defines a name of report which is used by the org.greports.engine
     * to obtain this configuration.
     *
     * @return {@link String}
     */
    String[] reportName();

    /**
     * Relative route to directory containing translations.
     * This directory needs to be placed in resource folder of the project.
     * Every translations file need to have the follow name: messages.[reportLang].(yml|yaml)
     * Valid examples for .yml:
     *                 i18n/messages.en.yml
     *                 i18n/messages.es.yml
     *                 i18n/messages.de.yml

     * Valid example .yaml:
     *                  i18n/messages.en.yaml
     *                  i18n/messages.es.yaml
     *                  i18n/messages.de.yaml
     *
     * @return {@link String}
     */
    String translationsDir() default "i18n/";

    /**
     * Translation file extension.
     * @return {@link TranslationsParser.FileExtensions}
     */
    TranslationsParser.FileExtensions translationFileExtension() default TranslationsParser.FileExtensions.YML;

    /**
     * Locale string representation.
     *
     * @return {@link String}
     */
    String locale() default "en_US";

    /**
     * Template path to be used to generate the report.
     * This template path needs to point the template inside the resource folder of the project.
     *
     * @return {@link String}
     */
    String templatePath() default StringUtils.EMPTY;

    /**
     * Sheet's name. If value is empty, the org.greports.engine will generate the sheet's name automatically.
     *
     * @return {@link String}
     */
    String sheetName() default StringUtils.EMPTY;

    /**
     * The value indicates if the header needs to be created.
     *
     * @return {@code boolean}
     */
    boolean createHeader() default true;

    /**
     * This value indicates if the header row needs t be sticky (freeze).
     *
     * @return {@code boolean}
     */
    boolean stickyHeader() default false;

    /**
     * The value indicates if the header needs to be sortable.
     *
     * @return {@code boolean}
     */
    boolean sortableHeader() default false;

    /**
     * Header's row index.
     *
     * @return {@code short}
     */
    short headerRowIndex() default 0;

    /**
     * Indicates on which row the data will start.
     * 0-based.
     *
     * @return {@code short}
     */
    short dataStartRowIndex() default 1;

    /**
     * Indicates if the configuration to be parsed need to be injected
     * into existing sheet using {@link org.greports.engine.TemplateDataInjector}
     *
     * @return {@code boolean}
     */
    boolean templatedInject() default false;

    /**
     * Vertical offset. When greater then zero, indicated quantity of rows
     * will be skipped counting from first row (0 index). Applies as global offset.
     * {@code headerRowIndex}, {@code dataStartRowIndex} and {@code specialRows}
     * will consider the offset value.
     * 

     * Example: (All row indexes are 0-based)
     *      *     verticalOffset = 0, headerRowIndex = 1 => header starts at row 1
     *     verticalOffset = 1, headerRowIndex = 1 => header starts at row 2
     *     verticalOffset = 4, headerRowIndex = 0 => header starts at row 4
     *     verticalOffset = 4, headerRowIndex = 2 => header starts at row 6
     * 
     *
     * @return {@code short}
     */
    short verticalOffset() default 0;

    /**
     * Horizontal offset. When greater then zero, indicated quantity of columns
     * will be skipped counting from first column (0 index). Applies as global offset.
     * {@code headerRowIndex}, {@code dataStartRowIndex} and {@code specialRows}
     * will consider the offset value.
     * 

     * Example: (All column indexes are 0-based)
     *      *     horizontalOffset = 0, headerRowIndex = 1 => header starts at column 0 (A)
     *     horizontalOffset = 1, headerRowIndex = 1 => header starts at column 1 (B)
     *     horizontalOffset = 4, headerRowIndex = 0 => header starts at column 4 (E)
     *     horizontalOffset = 4, headerRowIndex = 2 => header starts at column 6 (G)
     * 
     *
     * @return {@code short}
     */
    short horizontalOffset() default 0;

    /**
     * A boolean indicating if the gridlines must be shown.
     *
     * @return {@code boolean}
     */
    boolean showGridlines() default true;

    /**
     * Set whether the window should show 0 (zero) in cells containing zero value.
     * When false, cells with zero value appear blank instead of showing the number zero.
     */
    boolean displayZeros() default true;

    /**
     * An array of {@link SpecialRow}
     *
     * @return {@code SpecialRow[]}
     */
    SpecialRow[] specialRows() default {};

    /**
     * An array of {@link SpecialColumn}
     *
     * @return {@code SpecialColumn[]}
     */
    SpecialColumn[] specialColumns() default {};
}