org.greports.annotations.Column 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.converters.NotImplementedConverter;
import org.greports.engine.ValueType;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.ANNOTATION_TYPE})
@Repeatable(Column.List.class)
@Inherited
@Documented
public @interface Column {

    /**
     * Indicates the report's name which contains the column.
     *
     * @return {@link String}
     */
    String[] reportName();

    /**
     * Position of column in the report.
     * The columns will be ordered from lowest to highest position index.
     * In case of need to add a new column among the existing ones,
     * the floating part can be used to indicate the desired position.
     *
     * @return {@code float}
     */
    float position();

    /**
     * The value used to target attributes in a nested class.
     * @return {@link String}
     */
    String target() default StringUtils.EMPTY;

    /**
     * An array of {@link CellValidator} to be applied to the column.
     *
     * @return {@link CellValidator}
     */
    CellValidator[] cellValidators() default {};

    /**
     * An array of {@link ColumnValidator} to be applied to the column.
     *
     * @return {@link ColumnValidator}
     */
    ColumnValidator[] columnValidators() default {};

    /**
     * A converter to be applied when the column value is being obtained.
     *
     * @return {@link Converter}
     */
    Converter getterConverter() default @Converter(converterClass = NotImplementedConverter.class);

    /**
     * A converter to be applied when the data is being loaded.
     *
     * @return {@link Converter}
     */
    Converter setterConverter() default @Converter(converterClass = NotImplementedConverter.class);

    /**
     * Column title. This text string will be used to search for
     * the corresponding translation in the translation file located in
     * the directory provided by the {@link Configuration#translationsDir()}
     *
     * @return {@link String}
     */
    String title() default StringUtils.EMPTY;

    /**
     * Visualisation format to be displayed.
     * You can find information on how to create your own org.greports.styles
     * by going through this link
     *
     * @return {@link String}
     */
    String format() default StringUtils.EMPTY;

    /**
     * The {@link ValueType} of the column.
     *
     * @return {@link ValueType}
     */
    ValueType valueType() default ValueType.PLAIN_VALUE;

    /**
     * Column ID which will be used by other column if that one
     * is of formula type. Also can be used by {@link SpecialColumn} and {@link SpecialRowCell}
     *
     * @see ValueType#FORMULA
     * @return {@link String}
     */
    String id() default StringUtils.EMPTY;

    /**
     * The value indicates whether the column has to fit the width of the longest cell.
     * This functionality is very expensive due to the large number of calculations to be performed.
     * Use only when necessary.
     *
     * @return {@code boolean}
     */
    boolean autoSizeColumn() default false;

    /**
     * This value indicates the number of merged cells.
     * A count of merged cells needs to be grater o equals than 1.
     * If the value is greater than 1 means that the column will merge
     * cells of his right. Example:
     * position = 1 (first column), columnWidth = 2. In this case
     * the row will have the cells A1 and B1 merged in only one cell
     * which will be placed into A1 cell.
     * @return {@code int}
     */
    int columnWidth() default 1;

    /**
     * The value of this attribute allows to enable the translation
     * of the cell content.
     * @return {@code boolean}
     */
    boolean translate() default false;

    /**
     * Defines several {@link Column} annotations on the same element.
     * @see Column
     */
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.FIELD)
    @Inherited
    @Documented
    @interface List {
        /**
         * @return {@link Column} array
         */
        Column[] value();
    }
}