A B C D E F G H I L N O P R S T U V X

A

addAllParameters(Map<String, Object>) - Method in class com.haulmont.yarg.structure.BandData

addChild(BandData) - Method in class com.haulmont.yarg.structure.BandData

addChildren(List<BandData>) - Method in class com.haulmont.yarg.structure.BandData

addData(String, Object) - Method in class com.haulmont.yarg.structure.BandData

addReportFieldFormats(List<ReportFieldFormat>) - Method in class com.haulmont.yarg.structure.BandData

B

BandData - Class in com.haulmont.yarg.structure

BandData(String) - Constructor for class com.haulmont.yarg.structure.BandData

BandData(String, BandData) - Constructor for class com.haulmont.yarg.structure.BandData

BandData(String, BandData, BandOrientation) - Constructor for class com.haulmont.yarg.structure.BandData

BandData.BandNameVisitor - Class in com.haulmont.yarg.structure

BandNameVisitor(String) - Constructor for class com.haulmont.yarg.structure.BandData.BandNameVisitor

BandOrientation - Enum in com.haulmont.yarg.structure

BandVisitor - Interface in com.haulmont.yarg.structure

buildXml(Report) - Method in interface com.haulmont.yarg.structure.xml.XmlWriter

C

childrenBands - Variable in class com.haulmont.yarg.structure.BandData

com.haulmont.yarg.exception - package com.haulmont.yarg.exception

com.haulmont.yarg.formatters - package com.haulmont.yarg.formatters

com.haulmont.yarg.formatters.factory - package com.haulmont.yarg.formatters.factory

com.haulmont.yarg.loaders - package com.haulmont.yarg.loaders

com.haulmont.yarg.loaders.factory - package com.haulmont.yarg.loaders.factory

com.haulmont.yarg.reporting - package com.haulmont.yarg.reporting

com.haulmont.yarg.structure - package com.haulmont.yarg.structure

com.haulmont.yarg.structure.xml - package com.haulmont.yarg.structure.xml

com.haulmont.yarg.util.converter - package com.haulmont.yarg.util.converter

com.haulmont.yarg.util.groovy - package com.haulmont.yarg.util.groovy

com.haulmont.yarg.util.properties - package com.haulmont.yarg.util.properties

content - Variable in class com.haulmont.yarg.reporting.ReportOutputDocumentImpl

convert(Object) - Method in interface com.haulmont.yarg.loaders.ReportFieldsConverter

convert(Object) - Method in interface com.haulmont.yarg.loaders.ReportParametersConverter

convertFromString(Class, String) - Method in interface com.haulmont.yarg.util.converter.ObjectToStringConverter

convertToString(Class, Object) - Method in interface com.haulmont.yarg.util.converter.ObjectToStringConverter

createDataLoader(String) - Method in interface com.haulmont.yarg.loaders.factory.ReportLoaderFactory

createDocument() - Method in interface com.haulmont.yarg.formatters.ReportFormatter

Creates document and put it into byte array

createFormatter(FormatterFactoryInput) - Method in interface com.haulmont.yarg.formatters.factory.ReportFormatterFactory

createReport(Report, BandData, Map<String, Object>) - Method in interface com.haulmont.yarg.formatters.CustomReport

csv - Static variable in class com.haulmont.yarg.structure.ReportOutputType

CUBA_REPORTING_OPENOFFICE_DISPLAY_DEVICE_AVAILABLE - Static variable in interface com.haulmont.yarg.util.properties.PropertiesLoader

CUBA_REPORTING_OPENOFFICE_PATH - Static variable in interface com.haulmont.yarg.util.properties.PropertiesLoader

CUBA_REPORTING_OPENOFFICE_PORTS - Static variable in interface com.haulmont.yarg.util.properties.PropertiesLoader

CUBA_REPORTING_OPENOFFICE_TIMEOUT - Static variable in interface com.haulmont.yarg.util.properties.PropertiesLoader

CUBA_REPORTING_PUT_EMPTY_ROW_IF_NO_DATA_SELECTED - Static variable in interface com.haulmont.yarg.util.properties.PropertiesLoader

CUBA_REPORTING_SQL_DB_URL - Static variable in interface com.haulmont.yarg.util.properties.PropertiesLoader

CUBA_REPORTING_SQL_DRIVER - Static variable in interface com.haulmont.yarg.util.properties.PropertiesLoader

CUBA_REPORTING_SQL_PASSWORD - Static variable in interface com.haulmont.yarg.util.properties.PropertiesLoader

CUBA_REPORTING_SQL_USER - Static variable in interface com.haulmont.yarg.util.properties.PropertiesLoader

custom - Static variable in class com.haulmont.yarg.structure.ReportOutputType

CustomReport - Interface in com.haulmont.yarg.formatters

This interface may be implemented if you need custom formatting logic, not covered by and provided formatter Example: you need to merge pdfs created by another reports

D

data - Variable in class com.haulmont.yarg.structure.BandData

DataExtractor - Interface in com.haulmont.yarg.reporting

This class should load data using ReportQuery objects, convert data onto BandData object and build BandData object tree (link children and parent bands) The default implementation is com.haulmont.yarg.reporting.DataExtractorImpl !Attention! Please make sure if you really need to change this behaviour against default implementation cause it might crash report generation logic

DataLoadingException - Exception in com.haulmont.yarg.exception

Thrown when data loader catches internal exception during load

DataLoadingException() - Constructor for exception com.haulmont.yarg.exception.DataLoadingException

DataLoadingException(String) - Constructor for exception com.haulmont.yarg.exception.DataLoadingException

DataLoadingException(String, Throwable) - Constructor for exception com.haulmont.yarg.exception.DataLoadingException

DataLoadingException(Throwable) - Constructor for exception com.haulmont.yarg.exception.DataLoadingException

DEFAULT_TEMPLATE_CODE - Static variable in interface com.haulmont.yarg.structure.ReportTemplate

doc - Static variable in class com.haulmont.yarg.structure.ReportOutputType

documentName - Variable in class com.haulmont.yarg.reporting.ReportOutputDocumentImpl

docx - Static variable in class com.haulmont.yarg.structure.ReportOutputType

E

evaluateGroovy(String, Map<String, Object>) - Method in interface com.haulmont.yarg.util.groovy.Scripting

extractData(Report, Map<String, Object>, BandData) - Method in interface com.haulmont.yarg.reporting.DataExtractor

F

findBandRecursively(String) - Method in class com.haulmont.yarg.structure.BandData

findBandsRecursively(String) - Method in class com.haulmont.yarg.structure.BandData

firstLevelBandDefinitionNames - Variable in class com.haulmont.yarg.structure.BandData

FormatterFactoryInput - Class in com.haulmont.yarg.formatters.factory

The object is single input parameter for formatter constructor If you need you formatter be created by factory - it should accept this object as constructor parameter

FormatterFactoryInput(String, BandData, ReportTemplate, OutputStream) - Constructor for class com.haulmont.yarg.formatters.factory.FormatterFactoryInput

foundBand - Variable in class com.haulmont.yarg.structure.BandData.BandNameVisitor

fromId(String) - Static method in enum com.haulmont.yarg.structure.BandOrientation

G

getAdditionalParams() - Method in interface com.haulmont.yarg.structure.ReportQuery

getAlias() - Method in interface com.haulmont.yarg.structure.ReportParameter

getBandOrientation() - Method in interface com.haulmont.yarg.structure.ReportBand

getChildByName(String) - Method in class com.haulmont.yarg.structure.BandData

getChildren() - Method in interface com.haulmont.yarg.structure.ReportBand

getChildrenBands() - Method in class com.haulmont.yarg.structure.BandData

getChildrenByName(String) - Method in class com.haulmont.yarg.structure.BandData

getChildrenList() - Method in class com.haulmont.yarg.structure.BandData

getCode() - Method in interface com.haulmont.yarg.structure.ReportTemplate

getContent() - Method in interface com.haulmont.yarg.reporting.ReportOutputDocument

getContent() - Method in class com.haulmont.yarg.reporting.ReportOutputDocumentImpl

getCustomReport() - Method in interface com.haulmont.yarg.structure.ReportTemplate

getData() - Method in class com.haulmont.yarg.structure.BandData

getDefaultValue() - Method in interface com.haulmont.yarg.structure.ReportParameterWithDefaultValue

getDocumentContent() - Method in interface com.haulmont.yarg.structure.ReportTemplate

getDocumentName() - Method in interface com.haulmont.yarg.reporting.ReportOutputDocument

getDocumentName() - Method in class com.haulmont.yarg.reporting.ReportOutputDocumentImpl

getDocumentName() - Method in interface com.haulmont.yarg.structure.ReportTemplate

getDocumentPath() - Method in interface com.haulmont.yarg.structure.ReportTemplate

getFirstLevelBandDefinitionNames() - Method in class com.haulmont.yarg.structure.BandData

getFormat() - Method in interface com.haulmont.yarg.structure.ReportFieldFormat

getFullName() - Method in class com.haulmont.yarg.structure.BandData

getId() - Method in class com.haulmont.yarg.structure.ReportOutputType

getLevel() - Method in class com.haulmont.yarg.structure.BandData

getLinkParameterName() - Method in interface com.haulmont.yarg.structure.ReportQuery

getLoaderType() - Method in interface com.haulmont.yarg.structure.ReportQuery

getMessage() - Method in exception com.haulmont.yarg.exception.ReportingException

getName() - Method in class com.haulmont.yarg.structure.BandData

getName() - Method in interface com.haulmont.yarg.structure.Report

getName() - Method in interface com.haulmont.yarg.structure.ReportBand

getName() - Method in interface com.haulmont.yarg.structure.ReportFieldFormat

getName() - Method in interface com.haulmont.yarg.structure.ReportParameter

getName() - Method in interface com.haulmont.yarg.structure.ReportQuery

getOrientation() - Method in class com.haulmont.yarg.structure.BandData

getOutputNamePattern() - Method in interface com.haulmont.yarg.structure.ReportTemplate

getOutputStream() - Method in class com.haulmont.yarg.formatters.factory.FormatterFactoryInput

getOutputType() - Method in interface com.haulmont.yarg.structure.ReportTemplate

getOutputTypeById(String) - Static method in class com.haulmont.yarg.structure.ReportOutputType

getParameter(String) - Method in class com.haulmont.yarg.structure.BandData

getParameterClass() - Method in interface com.haulmont.yarg.structure.ReportParameter

getParameterValue(String) - Method in class com.haulmont.yarg.structure.BandData

getParent() - Method in interface com.haulmont.yarg.structure.ReportBand

getParentBand() - Method in class com.haulmont.yarg.structure.BandData

getProcessTemplate() - Method in interface com.haulmont.yarg.structure.ReportQuery

getReport() - Method in interface com.haulmont.yarg.reporting.ReportOutputDocument

getReport() - Method in class com.haulmont.yarg.reporting.ReportOutputDocumentImpl

getReportDetails() - Method in exception com.haulmont.yarg.exception.ReportingException

getReportFieldFormats() - Method in class com.haulmont.yarg.structure.BandData

getReportFieldFormats() - Method in interface com.haulmont.yarg.structure.Report

getReportOutputType() - Method in interface com.haulmont.yarg.reporting.ReportOutputDocument

getReportOutputType() - Method in class com.haulmont.yarg.reporting.ReportOutputDocumentImpl

getReportParameters() - Method in interface com.haulmont.yarg.structure.Report

getReportQueries() - Method in interface com.haulmont.yarg.structure.ReportBand

getReportTemplate() - Method in class com.haulmont.yarg.formatters.factory.FormatterFactoryInput

getReportTemplates() - Method in interface com.haulmont.yarg.structure.Report

getRequired() - Method in interface com.haulmont.yarg.structure.ReportParameter

getRootBand() - Method in class com.haulmont.yarg.formatters.factory.FormatterFactoryInput

getRootBand() - Method in interface com.haulmont.yarg.structure.Report

getScript() - Method in interface com.haulmont.yarg.structure.ReportQuery

Sql, groovy or other script which describes logic of data loading

getTemplateExtension() - Method in class com.haulmont.yarg.formatters.factory.FormatterFactoryInput

H

html - Static variable in class com.haulmont.yarg.structure.ReportOutputType

I

id - Variable in enum com.haulmont.yarg.structure.BandOrientation

InitializationException - Exception in com.haulmont.yarg.exception

Thrown when initialization of internal parts of reporting fails Example: you have provided wrong database driver class name

InitializationException() - Constructor for exception com.haulmont.yarg.exception.InitializationException

InitializationException(String) - Constructor for exception com.haulmont.yarg.exception.InitializationException

InitializationException(String, Throwable) - Constructor for exception com.haulmont.yarg.exception.InitializationException

InitializationException(Throwable) - Constructor for exception com.haulmont.yarg.exception.InitializationException

isCustom() - Method in interface com.haulmont.yarg.structure.ReportTemplate

L

level - Variable in class com.haulmont.yarg.structure.BandData

load() - Method in interface com.haulmont.yarg.util.properties.PropertiesLoader

loadData(ReportQuery, BandData, Map<String, Object>) - Method in interface com.haulmont.yarg.loaders.ReportDataLoader

This method MUST return list of mutable maps.

N

name - Variable in class com.haulmont.yarg.structure.BandData.BandNameVisitor

name - Variable in class com.haulmont.yarg.structure.BandData

O

ObjectToStringConverter - Interface in com.haulmont.yarg.util.converter

Converts parameters from string to object and from object to string

OpenOfficeException - Exception in com.haulmont.yarg.exception

Thrown when formatter catches Open/Libre Office internal errors

OpenOfficeException() - Constructor for exception com.haulmont.yarg.exception.OpenOfficeException

OpenOfficeException(String) - Constructor for exception com.haulmont.yarg.exception.OpenOfficeException

OpenOfficeException(String, Throwable) - Constructor for exception com.haulmont.yarg.exception.OpenOfficeException

OpenOfficeException(Throwable) - Constructor for exception com.haulmont.yarg.exception.OpenOfficeException

orientation - Variable in class com.haulmont.yarg.structure.BandData

outputStream - Variable in class com.haulmont.yarg.formatters.factory.FormatterFactoryInput

P

param(String, Object) - Method in class com.haulmont.yarg.reporting.RunParams

Add single parameter

params - Variable in class com.haulmont.yarg.reporting.RunParams

params(Map<String, Object>) - Method in class com.haulmont.yarg.reporting.RunParams

Adds parameters from map

parentBand - Variable in class com.haulmont.yarg.structure.BandData

parseXml(String) - Method in interface com.haulmont.yarg.structure.xml.XmlReader

pdf - Static variable in class com.haulmont.yarg.structure.ReportOutputType

PropertiesLoader - Interface in com.haulmont.yarg.util.properties

This interface describes logic which load properties for application

R

registerOutputType(ReportOutputType) - Static method in class com.haulmont.yarg.structure.ReportOutputType

renderDocument() - Method in interface com.haulmont.yarg.formatters.ReportFormatter

Creates document and serializes it to predefined stream (or something like this)

report - Variable in class com.haulmont.yarg.reporting.ReportOutputDocumentImpl

report - Variable in class com.haulmont.yarg.reporting.RunParams

Report - Interface in com.haulmont.yarg.structure

This interface describes main report object.

ReportBand - Interface in com.haulmont.yarg.structure

This interface describes Band abstraction.

ReportDataLoader - Interface in com.haulmont.yarg.loaders

This interface describes a logic which load rows of data using report query, parent band and params

reportDetails - Variable in exception com.haulmont.yarg.exception.ReportingException

ReportFieldFormat - Interface in com.haulmont.yarg.structure

This interface describes a format for certain result field.

reportFieldFormats - Variable in class com.haulmont.yarg.structure.BandData

ReportFieldsConverter - Interface in com.haulmont.yarg.loaders

This interface describes logic which transform resulting values.

ReportFormatter - Interface in com.haulmont.yarg.formatters

This interface describes a logic which construct resulting document

ReportFormatterFactory - Interface in com.haulmont.yarg.formatters.factory

This interface describes a factory which spawns formatters.

ReportFormattingException - Exception in com.haulmont.yarg.exception

Thrown when formatter's logic fails

ReportFormattingException() - Constructor for exception com.haulmont.yarg.exception.ReportFormattingException

ReportFormattingException(String) - Constructor for exception com.haulmont.yarg.exception.ReportFormattingException

ReportFormattingException(String, Throwable) - Constructor for exception com.haulmont.yarg.exception.ReportFormattingException

ReportFormattingException(Throwable) - Constructor for exception com.haulmont.yarg.exception.ReportFormattingException

ReportingAPI - Interface in com.haulmont.yarg.reporting

This class is entry point for reporting functionality Use it to print reports

ReportingException - Exception in com.haulmont.yarg.exception

Base YARG exception

ReportingException() - Constructor for exception com.haulmont.yarg.exception.ReportingException

ReportingException(String) - Constructor for exception com.haulmont.yarg.exception.ReportingException

ReportingException(String, Throwable) - Constructor for exception com.haulmont.yarg.exception.ReportingException

ReportingException(Throwable) - Constructor for exception com.haulmont.yarg.exception.ReportingException

ReportingXmlException - Exception in com.haulmont.yarg.exception

Thrown when report unmarshalling from xml or report validation by xsd fails

ReportingXmlException() - Constructor for exception com.haulmont.yarg.exception.ReportingXmlException

ReportingXmlException(String) - Constructor for exception com.haulmont.yarg.exception.ReportingXmlException

ReportingXmlException(String, Throwable) - Constructor for exception com.haulmont.yarg.exception.ReportingXmlException

ReportingXmlException(Throwable) - Constructor for exception com.haulmont.yarg.exception.ReportingXmlException

ReportLoaderFactory - Interface in com.haulmont.yarg.loaders.factory

This interface describes a factory which spawns data loaders.

ReportOutputDocument - Interface in com.haulmont.yarg.reporting

This interface describes reporting result object.

ReportOutputDocumentImpl - Class in com.haulmont.yarg.reporting

ReportOutputDocumentImpl(Report, byte[], String, ReportOutputType) - Constructor for class com.haulmont.yarg.reporting.ReportOutputDocumentImpl

reportOutputType - Variable in class com.haulmont.yarg.reporting.ReportOutputDocumentImpl

ReportOutputType - Class in com.haulmont.yarg.structure

This class contains list of supported output types.

ReportOutputType(String) - Constructor for class com.haulmont.yarg.structure.ReportOutputType

ReportParameter - Interface in com.haulmont.yarg.structure

This interface describes report input parameter

ReportParametersConverter - Interface in com.haulmont.yarg.loaders

This interface describes logic which transform input parameters.

ReportParameterWithDefaultValue - Interface in com.haulmont.yarg.structure

ReportQuery - Interface in com.haulmont.yarg.structure

This interface describes certain query which load some data.

reportTemplate - Variable in class com.haulmont.yarg.formatters.factory.FormatterFactoryInput

reportTemplate - Variable in class com.haulmont.yarg.reporting.RunParams

ReportTemplate - Interface in com.haulmont.yarg.structure

This interface describes report template document.

ROOT_BAND_NAME - Static variable in class com.haulmont.yarg.structure.BandData

rootBand - Variable in class com.haulmont.yarg.formatters.factory.FormatterFactoryInput

RunParams - Class in com.haulmont.yarg.reporting

Describes parameters necessary for report run

RunParams(Report) - Constructor for class com.haulmont.yarg.reporting.RunParams

runReport(RunParams, OutputStream) - Method in interface com.haulmont.yarg.reporting.ReportingAPI

This method generates report and put result to output stream.

runReport(RunParams) - Method in interface com.haulmont.yarg.reporting.ReportingAPI

This method generates report and put result to ReportOutputDocument.content field

S

Scripting - Interface in com.haulmont.yarg.util.groovy

This interface describes logic which evaluates groovy scripts

setContent(byte[]) - Method in interface com.haulmont.yarg.reporting.ReportOutputDocument

setContent(byte[]) - Method in class com.haulmont.yarg.reporting.ReportOutputDocumentImpl

setData(Map<String, Object>) - Method in class com.haulmont.yarg.structure.BandData

setDocumentName(String) - Method in interface com.haulmont.yarg.reporting.ReportOutputDocument

setDocumentName(String) - Method in class com.haulmont.yarg.reporting.ReportOutputDocumentImpl

setFirstLevelBandDefinitionNames(Set<String>) - Method in class com.haulmont.yarg.structure.BandData

setParentBand(BandData) - Method in class com.haulmont.yarg.structure.BandData

setReport(Report) - Method in interface com.haulmont.yarg.reporting.ReportOutputDocument

setReport(Report) - Method in class com.haulmont.yarg.reporting.ReportOutputDocumentImpl

setReportDetails(String) - Method in exception com.haulmont.yarg.exception.ReportingException

setReportOutputType(ReportOutputType) - Method in interface com.haulmont.yarg.reporting.ReportOutputDocument

setReportOutputType(ReportOutputType) - Method in class com.haulmont.yarg.reporting.ReportOutputDocumentImpl

T

template(ReportTemplate) - Method in class com.haulmont.yarg.reporting.RunParams

Setup template.

templateCode(String) - Method in class com.haulmont.yarg.reporting.RunParams

Setup necessary template by string code.

templateExtension - Variable in class com.haulmont.yarg.formatters.factory.FormatterFactoryInput

toString() - Method in class com.haulmont.yarg.structure.BandData

U

UnsupportedFormatException - Exception in com.haulmont.yarg.exception

Thrown when user provides template file not supported by any formatter declared in formatter factory

UnsupportedFormatException() - Constructor for exception com.haulmont.yarg.exception.UnsupportedFormatException

UnsupportedFormatException(String) - Constructor for exception com.haulmont.yarg.exception.UnsupportedFormatException

UnsupportedFormatException(String, Throwable) - Constructor for exception com.haulmont.yarg.exception.UnsupportedFormatException

UnsupportedFormatException(Throwable) - Constructor for exception com.haulmont.yarg.exception.UnsupportedFormatException

UnsupportedLoaderException - Exception in com.haulmont.yarg.exception

Thrown when user choose data loader not supported in data loader factory

UnsupportedLoaderException() - Constructor for exception com.haulmont.yarg.exception.UnsupportedLoaderException

UnsupportedLoaderException(String) - Constructor for exception com.haulmont.yarg.exception.UnsupportedLoaderException

UnsupportedLoaderException(String, Throwable) - Constructor for exception com.haulmont.yarg.exception.UnsupportedLoaderException

UnsupportedLoaderException(Throwable) - Constructor for exception com.haulmont.yarg.exception.UnsupportedLoaderException

V

ValidationException - Exception in com.haulmont.yarg.exception

Thrown when data loader met invalid input parameters

ValidationException() - Constructor for exception com.haulmont.yarg.exception.ValidationException

ValidationException(String) - Constructor for exception com.haulmont.yarg.exception.ValidationException

ValidationException(String, Throwable) - Constructor for exception com.haulmont.yarg.exception.ValidationException

ValidationException(Throwable) - Constructor for exception com.haulmont.yarg.exception.ValidationException

valueOf(String) - Static method in enum com.haulmont.yarg.structure.BandOrientation

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.haulmont.yarg.structure.BandOrientation

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

values - Static variable in class com.haulmont.yarg.structure.ReportOutputType

visit(BandData) - Method in class com.haulmont.yarg.structure.BandData.BandNameVisitor

visit(BandVisitor) - Method in class com.haulmont.yarg.structure.BandData

visit(BandData) - Method in interface com.haulmont.yarg.structure.BandVisitor

X

xls - Static variable in class com.haulmont.yarg.structure.ReportOutputType

xlsx - Static variable in class com.haulmont.yarg.structure.ReportOutputType

XmlReader - Interface in com.haulmont.yarg.structure.xml

This class describes logic which read report from xml string

XmlWriter - Interface in com.haulmont.yarg.structure.xml

This class describes logic which convert report to xml string

A B C D E F G H I L N O P R S T U V X