Package io.jmix.reports.entity

Enum Class DataSetType

java.lang.Object

java.lang.Enum<DataSetType>

io.jmix.reports.entity.DataSetType

All Implemented Interfaces:

EnumClass<Integer>, Serializable, Comparable<DataSetType>, Constable

public enum DataSetType
extends Enum<DataSetType>
implements EnumClass<Integer>

When running a report, datasets are transformed into lists of rows, where each row contains a map of name-value pairs. Data set type determines source where the data comes from.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DELEGATE	Delegation to user-defined ReportDataLoader object.
GROOVY	Data is produced by Groovy script.
JPQL	Data is produced by JPQL query.
JSON	Data is produced by applying a JsonPath query to a JSON input.
MULTI	Data is produced using attributes of an entity list, which is taken from input parameters.
SINGLE	Data consists of a single row, and is produced using attributes of an input parameter of the ParameterType.ENTITY type.
SQL	Data is produced by SQL query.

Method Summary

Modifier and Type	Method	Description
static DataSetType	fromCode(String code)
static DataSetType	fromId(Integer id)
String	getCode()
Integer	getId()
static DataSetType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DataSetType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SQL

public static final DataSetType SQL

Data is produced by SQL query.

JPQL

public static final DataSetType JPQL

Data is produced by JPQL query.

GROOVY

public static final DataSetType GROOVY

Data is produced by Groovy script.

SINGLE

public static final DataSetType SINGLE

Data consists of a single row, and is produced using attributes of an input parameter of the ParameterType.ENTITY type.

MULTI

public static final DataSetType MULTI

Data is produced using attributes of an entity list, which is taken from input parameters. Two options are available:

• input parameter of the ParameterType.ENTITY_LIST type is used as a source
• sub-collection attribute of the ParameterType.ENTITY parameter is used as a source

JSON

public static final DataSetType JSON

Data is produced by applying a JsonPath query to a JSON input.

DELEGATE

public static final DataSetType DELEGATE

Delegation to user-defined ReportDataLoader object.

Method Details

values

public static DataSetType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DataSetType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getId

public Integer getId()

Specified by:

getId in interface EnumClass<Integer>

getCode

public String getCode()

fromId

public static DataSetType fromId(Integer id)

fromCode

public static DataSetType fromCode(String code)