UReport2

https://github.com/youseries/ureport
Admin
UReport2 is a high-performance pure Java report engine with a web-based designer for creating...
Tokens:15,511
Snippets:146
Trust Score:7
License:Apache-2.0
Update:6 months ago
Show doc for...
Tokens:
Raw
### Expression Syntax Examples

Source: https://context7.com/youseries/ureport/llms.txt

Basic examples of compound conditions, nested calculations, and string concatenation within uReport expressions.

```uReport
A1 > 1000 and A1 < 5000 ? "Medium" : "Out of range"
```

```uReport
A1 > 1000 ? A1 * 0.9 : A1 * 0.95
```

```uReport
A1 > 100 and B1 == "Active" ? "Qualified: " + A1 : "Not qualified"
```

--------------------------------

### Examine ReportDefinition in Java

Source: https://context7.com/youseries/ureport/llms.txt

This Java example demonstrates how to access various components of a `ReportDefinition` object, including paper settings, cells, rows, columns, and data sources. It also shows how to create an executable `Report` from the definition.

```java
import com.bstek.ureport.definition.ReportDefinition;
import com.bstek.ureport.definition.CellDefinition;
import com.bstek.ureport.definition.RowDefinition;
import com.bstek.ureport.definition.ColumnDefinition;
import com.bstek.ureport.definition.Paper;
import com.bstek.ureport.model.Report;

// ReportDefinition structure
public class ReportDefinitionExample {

    public void examineReportDefinition(ReportDefinition reportDef) {
        // Get paper settings (page size, margins, orientation)
        Paper paper = reportDef.getPaper();
        int pageWidth = paper.getWidth();
        int pageHeight = paper.getHeight();

        // Get all cell definitions
        List<CellDefinition> cells = reportDef.getCells();
        for (CellDefinition cell : cells) {
            String cellName = cell.getName();           // e.g., "A1", "B2"
            int rowNum = cell.getRowNumber();
            int colNum = cell.getColumnNumber();
            int rowSpan = cell.getRowSpan();
            int colSpan = cell.getColSpan();

            // Get parent cell references
            CellDefinition leftParent = cell.getLeftParentCell();
            CellDefinition topParent = cell.getTopParentCell();
        }

        // Get row definitions
        List<RowDefinition> rows = reportDef.getRows();
        for (RowDefinition row : rows) {
            int height = row.getHeight();
            Band band = row.getBand();  // headerrepeat, footerrepeat, title, summary
        }

        // Get column definitions
        List<ColumnDefinition> columns = reportDef.getColumns();
        for (ColumnDefinition col : columns) {
            int width = col.getWidth();
        }

        // Get datasource definitions
        List<DatasourceDefinition> datasources = reportDef.getDatasources();

        // Create executable Report from definition
        Report report = reportDef.newReport();

        // Get CSS styles for HTML rendering
        String styles = reportDef.getStyle();
    }
}

```

--------------------------------

### UReport2 Case Expression Examples

Source: https://github.com/youseries/ureport/blob/master/docs/EXPRESSION.md

Demonstrates the syntax and usage of case expressions for conditional logic in UReport2. Conditions are evaluated sequentially, and the first matching condition's return value is used.

```UReport2
case{A1==100 return "normal ", A1>100 and A1<1000 return "normal value", A1>100 and A1<1000 return 'high'}
```

```UReport2
case{A1==100 return "normal ", A1>100 and A1<1000 return "normal value", A1>100 and A1<1000  ‘high'}
```

--------------------------------

### GET /ureport/preview

Source: https://context7.com/youseries/ureport/llms.txt

Endpoints for rendering and interacting with reports in the browser.

```APIDOC
## GET /ureport/preview

### Description
Serves reports for web display with support for pagination, custom titles, toolbar configuration, and data loading.

### Method
GET

### Endpoint
/ureport/preview

### Query Parameters
- **_u** (string) - Required - The report file path (e.g., 'file:report.ureport.xml').
- **_method** (string) - Optional - Action to perform: 'loadData', 'loadPrintPages', or 'loadPagePaper'.
- **_i** (integer) - Optional - Page index to display.
- **_title** (string) - Optional - Custom title for the report.
- **_t** (string) - Optional - Toolbar configuration (e.g., 'pdf,excel,print').
```

--------------------------------

### ExportManager API for Programmatic Export (Java)

Source: https://context7.com/youseries/ureport/llms.txt

This section provides Java code examples demonstrating how to use the ExportManager interface to programmatically export reports to HTML, PDF, Excel, and Word formats.

```APIDOC
## ExportManager API for Programmatic Export

Use the ExportManager interface to programmatically export reports to various formats from Java code.

### Export to HTML
```java
public String exportToHtml(String reportFile, Map<String, Object> parameters) {
    HtmlReport htmlReport = exportManager.exportHtml(
        reportFile,
        "/myapp",  // context path
        parameters
    );
    return htmlReport.getContent();
}
```

### Export Specific Page of HTML Report
```java
public HtmlReport exportHtmlPage(String reportFile, Map<String, Object> parameters, int pageIndex) {
    return exportManager.exportHtml(reportFile, "/myapp", parameters, pageIndex);
}
```

### Export to PDF File
```java
public void exportToPdf(String reportFile, String outputPath, Map<String, Object> parameters)
        throws Exception {
    try (OutputStream out = new FileOutputStream(outputPath)) {
        ExportConfigure config = new ExportConfigureImpl(reportFile, parameters, out);
        exportManager.exportPdf(config);
    }
}
```

### Export to Excel (xlsx format) without pagination
```java
public void exportToExcel(String reportFile, String outputPath, Map<String, Object> parameters)
        throws Exception {
    try (OutputStream out = new FileOutputStream(outputPath)) {
        ExportConfigure config = new ExportConfigureImpl(reportFile, parameters, out);
        exportManager.exportExcel(config);
    }
}
```

### Export to Excel with pagination (each page as content block)
```java
public void exportToExcelWithPaging(String reportFile, OutputStream out,
        Map<String, Object> parameters) {
    ExportConfigure config = new ExportConfigureImpl(reportFile, parameters, out);
    exportManager.exportExcelWithPaging(config);
}
```

### Export to Excel with each page as separate sheet
```java
public void exportToExcelWithSheets(String reportFile, OutputStream out,
        Map<String, Object> parameters) {
    ExportConfigure config = new ExportConfigureImpl(reportFile, parameters, out);
    exportManager.exportExcelWithPagingSheet(config);
}
```

### Export to Excel 97 format (xls)
```java
public void exportToExcel97(String reportFile, OutputStream out, Map<String, Object> parameters) {
    ExportConfigure config = new ExportConfigureImpl(reportFile, parameters, out);
    exportManager.exportExcel97(config);
}
```

### Export to Word document
```java
public void exportToWord(String reportFile, OutputStream out, Map<String, Object> parameters) {
    ExportConfigure config = new ExportConfigureImpl(reportFile, parameters, out);
    exportManager.exportWord(config);
}
```
```

--------------------------------

### Configure Spring Bean for Properties

Source: https://github.com/youseries/ureport/blob/master/docs/STORAGE-DATASOURCE.md

Add this Bean definition to your Spring context.xml to load custom properties from config.properties. This is a standard Spring PropertyPlaceholderConfigurer setup.

```xml
<bean id="propertyConfigurer" parent="ureport.props">
    <property  name="location">
    <value>/WEB-INF/config.properties</value>
    </property>
</bean>
```

--------------------------------

### Ternary Expression

Source: https://context7.com/youseries/ureport/llms.txt

Explanation and examples of using ternary expressions for conditional value selection within UReport2.

```APIDOC
## Ternary Expression

Use ternary expressions for simple conditional value selection based on cell values or calculations.

### Basic ternary expression
```
A1 > 1000 ? "High" : "Low"
```
```

--------------------------------

### UReport2 If Expression Examples

Source: https://github.com/youseries/ureport/blob/master/docs/EXPRESSION.md

The if expression allows for more complex conditional logic, including multiple elseif conditions and an optional else block. The 'return' keyword is optional and can be followed by a semicolon.

```text
if\(A1>1000\){return "normal value"}
```

```text
if\(A1>1000\){return "normal value"}else{\"low value\";}
```

```text
if\(A1>1000 and A1<20000\){ return "normal value:"+A1}else if\(A>20000 and A1<40000\){ return "High value" }else if\(A>20000 and A1<40000\){ return "ultra-high value"}else{ \"low value\"}
```

--------------------------------

### UReport2 Ternary Expression Example

Source: https://github.com/youseries/ureport/blob/master/docs/EXPRESSION.md

The ternary expression provides a concise way to perform conditional assignments. It evaluates a condition and returns one value if true, and another if false.

```text
A1>1000 ? “normal value" : “low value"
```

```text
A1>1000 and A1<20000 ? “normal value" : “corrected value:"+\(A1+100\)
```

--------------------------------

### Cell Sequence Reference

Source: https://context7.com/youseries/ureport/llms.txt

Use the & prefix to get the sequence number of an expanded cell, useful for row numbering and conditional formatting.

```uReport
# Get sequence number of current A2 cell
&A2
```

```uReport
# Conditional logic based on sequence
if(&A2 == 1) {
    ""                       # First row: return empty
} else {
    C2 - C2[A2:-1]          # Other rows: calculate difference
}
```

```uReport
# Row numbering in report
&A1                          # Returns 1, 2, 3... for each expanded A1 cell
```

--------------------------------

### Configure UReport2 Servlet

Source: https://github.com/youseries/ureport/blob/master/README.md

Add this servlet configuration to your project's web.xml file to enable the UReport2 servlet. The url-pattern must be set to '/ureport/*' for the system to function correctly.

```xml
<servlet>
    <servlet-name>ureportServlet</servlet-name>
    <servlet-class>com.bstek.ureport.console.UReportServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>ureportServlet</servlet-name>
    <url-pattern>/ureport/*</url-pattern>
</servlet-mapping>
```

--------------------------------

### Implement ReportProvider for Custom Storage

Source: https://context7.com/youseries/ureport/llms.txt

Create custom storage mechanisms by implementing the ReportProvider interface. The prefix method is used to identify and strip storage-specific prefixes from file paths.

```java
package com.example.report;

import com.bstek.ureport.provider.report.ReportFile;
import com.bstek.ureport.provider.report.ReportProvider;
import java.io.InputStream;
import java.util.List;

public class DatabaseReportProvider implements ReportProvider {
    private String prefix = "db:";

    @Override
    public InputStream loadReport(String file) {
        // Remove prefix and load report from database
        if (file.startsWith(prefix)) {
            file = file.substring(prefix.length());
        }
        // Return InputStream from database BLOB
        return reportRepository.loadReportContent(file);
    }

    @Override
    public void deleteReport(String file) {
        if (file.startsWith(prefix)) {
            file = file.substring(prefix.length());
        }
        reportRepository.deleteReport(file);
    }

    @Override
    public List<ReportFile> getReportFiles() {
        return reportRepository.getAllReportFiles();
    }

    @Override
    public void saveReport(String file, String content) {
        if (file.startsWith(prefix)) {
            file = file.substring(prefix.length());
        }
        reportRepository.saveReport(file, content);
    }

    @Override
    public String getName() {
        return "Database Storage";
    }

    @Override
    public boolean disabled() {
        return false;
    }

    @Override
    public String getPrefix() {
        return prefix;
    }
}
```

--------------------------------

### FileReportProvider Implementation

Source: https://github.com/youseries/ureport/blob/master/docs/STORAGE-DATASOURCE.md

The `FileReportProvider` class implements the `ReportProvider` interface to manage report files on the server's file system. It handles loading, deleting, saving, and listing report files.

```APIDOC
## FileReportProvider Implementation

### Description
Provides functionality to manage report files stored on the server's file system. This includes loading, deleting, saving, and listing reports.

### Class
`com.bstek.ureport.provider.report.file.FileReportProvider`

### Implements
`com.bstek.ureport.provider.report.ReportProvider`, `org.springframework.context.ApplicationContextAware`

### Key Methods

#### `loadReport(String file)`
Loads a report file from the file system.

#### `deleteReport(String file)`
Deletes a report file from the file system.

#### `getReportFiles()`
Retrieves a list of all available report files, sorted by modification date.

#### `saveReport(String file, String content)`
Saves the given content to a report file on the file system.

#### `disabled()`
Returns the disabled status of the provider.

### Configuration Properties

- `prefix` (String): The prefix used to identify file system reports (default: "file:").
- `fileStoreDir` (String): The directory on the server where report files are stored.
- `disabled` (boolean): A flag to disable this report provider.

### Spring Bean Configuration
To use this provider, it needs to be configured as a Spring Bean. The `fileStoreDir` can be set directly or resolved relative to the web application context.

```java
@Bean
public ReportProvider fileReportProvider() {
    FileReportProvider provider = new FileReportProvider();
    provider.setFileStoreDir("/ureportfiles"); // Example directory
    // provider.setDisabled(true); // Uncomment to disable
    return provider;
}
```

### Disabling the Default Provider
To disable the default file system report provider, add the following property to your `config.properties` file:

`ureport.disableFileProvider=true`
```

--------------------------------

### Preview Data using Built-in Datasource

Source: https://context7.com/youseries/ureport/llms.txt

Preview data from a pre-configured built-in data source. This simplifies data access for common data sources within the application.

```http
POST /ureport/datasource?_method=previewData&type=buildin&name=Application%20Database
sql=SELECT * FROM products
```

--------------------------------

### Configure Spring Context

Source: https://context7.com/youseries/ureport/llms.txt

Load the UReport2 configuration file either via web.xml listener or by importing it into an existing Spring configuration.

```xml
<!-- Option 1: Configure in web.xml for projects without existing Spring setup -->
<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:ureport-console-context.xml</param-value>
</context-param>

<!-- Option 2: Import in existing Spring configuration file -->
<import resource="classpath:ureport-console-context.xml" />
```

--------------------------------

### Build Database Tables

Source: https://context7.com/youseries/ureport/llms.txt

Use this endpoint to retrieve a list of database tables for a given JDBC connection. Ensure all JDBC parameters are correctly provided.

```http
POST /ureport/datasource?_method=buildDatabaseTables&type=jdbc
driver=com.mysql.cj.jdbc.Driver&url=jdbc:mysql://localhost:3306/mydb&username=root&password=secret
```

--------------------------------

### Basic HTML Report Preview

Source: https://context7.com/youseries/ureport/llms.txt

Render a report in HTML format for web display. This is the most basic way to view a report in a browser.

```http
GET /ureport/preview?_u=file:report.ureport.xml
```

--------------------------------

### HTML Report Preview with Toolbar Configuration

Source: https://context7.com/youseries/ureport/llms.txt

Customize the report viewer's toolbar. Options include hiding the toolbar (`_t=0`) or showing specific buttons like PDF, Excel, and Print.

```http
GET /ureport/preview?_u=file:report.ureport.xml&_t=pdf,excel,print
```

--------------------------------

### HTML Report Preview with Parameters

Source: https://context7.com/youseries/ureport/llms.txt

View a report with specific parameters applied. This allows for dynamic filtering and customization of the report content.

```http
GET /ureport/preview?_u=file:report.ureport.xml&year=2023&department=Sales
```

--------------------------------

### Implement BuildinDatasource for Connections

Source: https://context7.com/youseries/ureport/llms.txt

Implement the BuildinDatasource interface to expose custom database connections to the report designer.

```java
package com.example.datasource;

import com.bstek.ureport.definition.datasource.BuildinDatasource;
import javax.sql.DataSource;
import java.sql.Connection;
import java.sql.SQLException;

@Component
public class ApplicationDatasource implements BuildinDatasource {

    @Autowired
    private DataSource dataSource;

    @Override
    public String name() {
        return "Application Database";
    }

    @Override
    public Connection getConnection() {
        try {
            return dataSource.getConnection();
        } catch (SQLException e) {
            throw new RuntimeException("Failed to get database connection", e);
        }
    }
}
```

--------------------------------

### Import UReport2 Spring Context (Existing Spring Project)

Source: https://github.com/youseries/ureport/blob/master/README.md

If your project already uses Spring, import UReport2's Spring configuration file into your existing Spring configuration file using the '<import>' tag.

```xml
<import  resource="classpath:ureport-console-context.xml"  />
```

--------------------------------

### Preview Data from SQL Query

Source: https://context7.com/youseries/ureport/llms.txt

Preview data from a SQL query, limited to a maximum of 500 rows. Supports parameterized queries for dynamic data retrieval.

```http
POST /ureport/datasource?_method=previewData&type=jdbc
driver=...&url=...&username=...&password=...&sql=SELECT * FROM employees WHERE dept=:dept
parameters=[{"name":"dept","type":"String","defaultValue":"Sales"}]
```

--------------------------------

### Configure Maven Dependencies

Source: https://context7.com/youseries/ureport/llms.txt

Add the UReport2 console dependency to your pom.xml. Include the Sonatype repository if using snapshot versions.

```xml
<!-- Add UReport2 dependency to pom.xml -->
<dependency>
    <groupId>com.bstek.ureport</groupId>
    <artifactId>ureport2-console</artifactId>
    <version>2.2.3</version>
</dependency>

<!-- Optional: For snapshot versions, add the Sonatype repository -->
<repository>
    <id>sonatype</id>
    <url>https://oss.sonatype.org/content/groups/public/</url>
</repository>
```

--------------------------------

### FileReportProvider Implementation for UReport2

Source: https://github.com/youseries/ureport/blob/master/docs/STORAGE-DATASOURCE.md

This Java class implements the ReportProvider interface for UReport2, enabling report storage and retrieval using the server's file system. It handles loading, deleting, saving, and listing report files. Configure this class as a Spring Bean to integrate it.

```java
package com.bstek.ureport.provider.report.file;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;

import javax.servlet.ServletContext;

import org.apache.commons.io.IOUtils;
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.web.context.WebApplicationContext;

import com.bstek.ureport.exception.ReportException;
import com.bstek.ureport.provider.report.ReportFile;
import com.bstek.ureport.provider.report.ReportProvider;

/**
 * @author Jacky.gao
 * @since 2017年2月11日
 */
public class FileReportProvider implements ReportProvider,ApplicationContextAware{
    private String prefix="file:";
    private String fileStoreDir;
    private boolean disabled;
    @Override
    public InputStream loadReport(String file) {
        if(file.startsWith(prefix)){
            file=file.substring(prefix.length(),file.length());
        }
        String fullPath=fileStoreDir+"/"+file;
        try {
            return new FileInputStream(fullPath);
        } catch (FileNotFoundException e) {
            throw new ReportException(e);
        }
    }

    @Override
    public void deleteReport(String file) {
        if(file.startsWith(prefix)){
            file=file.substring(prefix.length(),file.length());
        }
        String fullPath=fileStoreDir+"/"+file;
        File f=new File(fullPath);
        if(f.exists()){
            f.delete();
        }
    }

    @Override
    public List<ReportFile> getReportFiles() {
        File file=new File(fileStoreDir);
        List<ReportFile> list=new ArrayList<ReportFile>();
        for(File f:file.listFiles()){
            Calendar calendar=Calendar.getInstance();
            calendar.setTimeInMillis(f.lastModified());
            list.add(new ReportFile(f.getName(),calendar.getTime()));
        }
        Collections.sort(list, new Comparator<ReportFile>(){
            @Override
            public int compare(ReportFile f1, ReportFile f2) {
                return f2.getUpdateDate().compareTo(f1.getUpdateDate());
            }
        });
        return list;
    }

    @Override
    public String getName() {
        return "服务器文件系统";
    }

    @Override
    public void saveReport(String file,String content) {
        if(file.startsWith(prefix)){
            file=file.substring(prefix.length(),file.length());
        }
        String fullPath=fileStoreDir+"/"+file;
        FileOutputStream outStream=null;
        try{
            outStream=new FileOutputStream(new File(fullPath));
            IOUtils.write(content, outStream,"utf-8");
        }catch(Exception ex){
            throw new ReportException(ex);
        }finally{
            if(outStream!=null){
                try {
                    outStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }

    }

    @Override
    public boolean disabled() {
        return disabled;
    }

    public void setDisabled(boolean disabled) {
        this.disabled = disabled;
    }

    public void setFileStoreDir(String fileStoreDir) {
        this.fileStoreDir = fileStoreDir;
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        File file=new File(fileStoreDir);
        if(file.exists()){
            return;
        }
        if(applicationContext instanceof WebApplicationContext){
            WebApplicationContext context=(WebApplicationContext)applicationContext;
            ServletContext servletContext=context.getServletContext();
            String basePath=servletContext.getRealPath("/");
            fileStoreDir=basePath+fileStoreDir;
            file=new File(fileStoreDir);
            if(!file.exists()){
                file.mkdirs();
            }
        }
    }

    @Override
    public String getPrefix() {
        return prefix;
    }
}
```

--------------------------------

### Configure UReportServlet

Source: https://context7.com/youseries/ureport/llms.txt

Register the UReportServlet in web.xml to handle report design, preview, and export operations.

```xml
<!-- web.xml servlet configuration -->
<servlet>
    <servlet-name>ureportServlet</servlet-name>
    <servlet-class>com.bstek.ureport.console.UReportServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>ureportServlet</servlet-name>
    <url-pattern>/ureport/*</url-pattern>
</servlet-mapping>
```

--------------------------------

### Build Field List from SQL Query

Source: https://context7.com/youseries/ureport/llms.txt

Construct a list of fields from a SQL query for a JDBC data source. This is useful for understanding the structure of data before fetching it.

```http
POST /ureport/datasource?_method=buildFields&type=jdbc
driver=...&url=...&username=...&password=...&sql=SELECT * FROM employees&parameters=[]
```

--------------------------------

### Access Report Designer and Preview

Source: https://context7.com/youseries/ureport/llms.txt

Use the browser to access the designer or preview reports with specific parameters.

```text
# Access the report designer in browser
http://localhost:8080/[contextPath]/ureport/designer

# Preview a specific report with parameters
http://localhost:8080/[contextPath]/ureport/preview?_u=file:sales-report.ureport.xml&year=2023

# Preview with custom title
http://localhost:8080/[contextPath]/ureport/preview?_u=file:report.ureport.xml&_title=Sales%20Report
```

--------------------------------

### Load UReport2 Spring Context (Standalone)

Source: https://github.com/youseries/ureport/blob/master/README.md

If your project does not use Spring, use this configuration in web.xml to load UReport2's Spring configuration file using Spring's ContextLoaderListener.

```xml
<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:ureport-console-context.xml</param-value>
</context-param>
```

--------------------------------

### Configure Custom Report Storage

Source: https://context7.com/youseries/ureport/llms.txt

Define the storage directory in a properties file and load it into the Spring context.

```properties
# config.properties - Custom report storage directory
ureport.fileStoreDir=D:/ureportfiles

# Disable default file provider if using custom storage
ureport.disableFileProvider=true
```

```xml
<!-- Load properties file in Spring context -->
<bean id="propertyConfigurer" parent="ureport.props">
    <property name="location">
        <value>/WEB-INF/config.properties</value>
    </property>
</bean>
```

--------------------------------

### Load Paper Configuration

Source: https://context7.com/youseries/ureport/llms.txt

Retrieve the paper configuration settings for a report, including page size and margins.

```http
GET /ureport/preview?_method=loadPagePaper&_u=file:report.ureport.xml
```

--------------------------------

### Implement Built-in Data Source Interface

Source: https://github.com/youseries/ureport/blob/master/docs/STORAGE-DATASOURCE.md

Custom data sources must implement the BuildinDatasource interface and be registered in the Spring context.

```java
package com.bstek.ureport.definition.datasource;

import java.sql.Connection;

/**
 * @author Jacky.gao
 * @since 2017年2月9日
 */
public interface BuildinDatasource {
	/**
	 * @return 返回数据源名称
	 */
	String name();
	/**
	 * @return 返回当前采用数据源的一个连接
	 */
	Connection getConnection();
}
```

--------------------------------

### Add Sonatype Repository for Snapshots

Source: https://github.com/youseries/ureport/blob/master/README.md

If you need to use the latest snapshot versions of UReport2, add this repository configuration to your Maven pom.xml. This allows Maven to download snapshot packages from Sonatype.

```xml
<repository>
    <id>sonatype</id>
    <url>https://oss.sonatype.org/content/groups/public/</url>
</repository>
```

--------------------------------

### HTML Report Preview for Specific Page

Source: https://context7.com/youseries/ureport/llms.txt

Access a specific page of a report for preview. Use the `_i` parameter to specify the page index.

```http
GET /ureport/preview?_u=file:report.ureport.xml&_i=2
```

--------------------------------

### POST /ureport/datasource

Source: https://context7.com/youseries/ureport/llms.txt

Endpoints for managing and previewing data from JDBC or built-in datasources.

```APIDOC
## POST /ureport/datasource

### Description
Provides functionality to build database tables, generate field lists, and preview data from configured datasources.

### Method
POST

### Endpoint
/ureport/datasource

### Query Parameters
- **_method** (string) - Required - The action to perform: 'buildDatabaseTables', 'buildFields', or 'previewData'.
- **type** (string) - Required - The datasource type: 'jdbc' or 'buildin'.
- **driver** (string) - Optional - JDBC driver class name.
- **url** (string) - Optional - JDBC connection URL.
- **username** (string) - Optional - Database username.
- **password** (string) - Optional - Database password.
- **sql** (string) - Optional - SQL query string.
- **parameters** (string) - Optional - JSON array of parameters for the query.
- **name** (string) - Optional - Name of the built-in datasource.
```

--------------------------------

### Datasource Servlet API Endpoints

Source: https://context7.com/youseries/ureport/llms.txt

The datasource servlet handles data source configuration, testing, and data preview operations.

```HTTP
# Load available built-in datasources
GET /ureport/datasource?_method=loadBuildinDatasources
```

```HTTP
# Load methods from Spring Bean
GET /ureport/datasource?_method=loadMethods&beanId=reportDataBean
```

```HTTP
# Build field list from Java class
GET /ureport/datasource?_method=buildClass&clazz=com.example.model.Employee
```

```HTTP
# Test database connection
POST /ureport/datasource?_method=testConnection
Content-Type: application/x-www-form-urlencoded
driver=com.mysql.cj.jdbc.Driver&url=jdbc:mysql://localhost:3306/mydb&username=root&password=secret
```

--------------------------------

### Define Custom Report Storage Directory

Source: https://github.com/youseries/ureport/blob/master/docs/STORAGE-DATASOURCE.md

In your config.properties file, set the 'ureport.fileStoreDir' attribute to specify a custom directory for storing report files. Ensure the directory exists before use.

```properties
ureport.fileStoreDir=D:/ureportfiles
```

--------------------------------

### Load Print Pages HTML

Source: https://context7.com/youseries/ureport/llms.txt

Fetch the HTML content for all print-ready pages of a report. This is useful for generating printable versions of reports.

```http
GET /ureport/preview?_method=loadPrintPages&_u=file:report.ureport.xml
```

--------------------------------

### Export Reports Programmatically with Java

Source: https://context7.com/youseries/ureport/llms.txt

Utilize the ExportManager interface to generate reports in HTML, PDF, Excel, or Word formats. Requires an ExportConfigure implementation to define the report file, parameters, and output stream.

```java
package com.example.export;

import com.bstek.ureport.export.ExportConfigure;
import com.bstek.ureport.export.ExportConfigureImpl;
import com.bstek.ureport.export.ExportManager;
import com.bstek.ureport.export.html.HtmlReport;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.io.FileOutputStream;
import java.io.OutputStream;
import java.util.HashMap;
import java.util.Map;

@Service
public class ReportExportService {

    @Autowired
    private ExportManager exportManager;

    // Export report to HTML
    public String exportToHtml(String reportFile, Map<String, Object> parameters) {
        HtmlReport htmlReport = exportManager.exportHtml(
            reportFile,
            "/myapp",  // context path
            parameters
        );
        return htmlReport.getContent();
    }

    // Export specific page of HTML report
    public HtmlReport exportHtmlPage(String reportFile, Map<String, Object> parameters, int pageIndex) {
        return exportManager.exportHtml(reportFile, "/myapp", parameters, pageIndex);
    }

    // Export to PDF file
    public void exportToPdf(String reportFile, String outputPath, Map<String, Object> parameters)
            throws Exception {
        try (OutputStream out = new FileOutputStream(outputPath)) {
            ExportConfigure config = new ExportConfigureImpl(reportFile, parameters, out);
            exportManager.exportPdf(config);
        }
    }

    // Export to Excel (xlsx format) without pagination
    public void exportToExcel(String reportFile, String outputPath, Map<String, Object> parameters)
            throws Exception {
        try (OutputStream out = new FileOutputStream(outputPath)) {
            ExportConfigure config = new ExportConfigureImpl(reportFile, parameters, out);
            exportManager.exportExcel(config);
        }
    }

    // Export to Excel with pagination (each page as content block)
    public void exportToExcelWithPaging(String reportFile, OutputStream out,
            Map<String, Object> parameters) {
        ExportConfigure config = new ExportConfigureImpl(reportFile, parameters, out);
        exportManager.exportExcelWithPaging(config);
    }

    // Export to Excel with each page as separate sheet
    public void exportToExcelWithSheets(String reportFile, OutputStream out,
            Map<String, Object> parameters) {
        ExportConfigure config = new ExportConfigureImpl(reportFile, parameters, out);
        exportManager.exportExcelWithPagingSheet(config);
    }

    // Export to Excel 97 format (xls)
    public void exportToExcel97(String reportFile, OutputStream out, Map<String, Object> parameters) {
        ExportConfigure config = new ExportConfigureImpl(reportFile, parameters, out);
        exportManager.exportExcel97(config);
    }

    // Export to Word document
    public void exportToWord(String reportFile, OutputStream out, Map<String, Object> parameters) {
        ExportConfigure config = new ExportConfigureImpl(reportFile, parameters, out);
        exportManager.exportWord(config);
    }
}
```

--------------------------------

### ReportProvider Interface

Source: https://github.com/youseries/ureport/blob/master/docs/STORAGE-DATASOURCE.md

Overview of the `ReportProvider` interface, which defines the contract for report storage mechanisms.

```APIDOC
## ReportProvider Interface

### Description
The "server file system" storage mechanism implemented by UReport2 adheres to the `com.bstek.ureport.provider.report.ReportProvider` interface. This interface defines the methods for interacting with report storage.

### Interface Definition

```java
package com.bstek.ureport.provider.report;

import java.io.InputStream;
import java.util.List;

/**
 * @author Jacky.gao
 * @since 2016年12月4日
 * @since Dec. 4 2016
 */
public interface ReportProvider {
    /**
     * Load the report file according to the report name
     * @param file report name
     * @return returned InputStream
     */
    InputStream loadReport(String file);

    /**
     * Delete the specific report file according to the report name
     * @param file report name
     */
    void deleteReport(String file);

    /**
     * Acquire all report files
     * @return return the list of report file
     */
    List<ReportFile> getReportFiles();

    /**
     * Save report files
     * @param file report name
     * @param content XML content of report
     */
    void saveReport(String file, String content);

    /**
     * return storage name
     */
    String getName();

    /**
     * return if deactivation
     */
    boolean disabled();

    /**
     * return prefix of report name
     */
    // Note: The original text seems to be cut off here. The method signature for returning the prefix is incomplete.
}
```
```

--------------------------------

### Expression Language Basics

Source: https://context7.com/youseries/ureport/llms.txt

An overview of the basic syntax and capabilities of the UReport2 expression language, including arithmetic operations, string concatenation, and cell references.

```APIDOC
## Expression Language Basics

UReport2 expressions support arithmetic operations, string concatenation, and various data types for cell calculations and conditional logic.

### Basic data types and arithmetic
```
1 + 2 * 3                    # Result: 7
100 / 4                      # Result: 25
17 % 5                       # Result: 2
"Total: " + 1500             # Result: "Total: 1500"
```

### Cell references
```
A1                           # Reference cell A1 value
A1 + B1                      # Sum of cells A1 and B1
A1 * 0.1                     # Calculate 10% of A1
```

### Boolean values
```
true
false
A1 > 1000                    # Comparison returns boolean
```
```

--------------------------------

### Case Expression Syntax

Source: https://context7.com/youseries/ureport/llms.txt

Case expressions provide a clean syntax for multiple condition matching, similar to switch statements.

```uReport
# Basic case expression
case {
    A1 == 100 return "Exact match",
    A1 > 100 and A1 < 500 return "Low range",
    A1 >= 500 and A1 < 1000 return "Medium range",
    A1 >= 1000 return "High range"
}
```

```uReport
# Case with calculations
case {
    B1 == "Discount10" return A1 * 0.9,
    B1 == "Discount20" return A1 * 0.8,
    B1 == "Discount30" return A1 * 0.7
}
```

```uReport
# Return keyword is optional
case {
    A1 < 60 "Fail",
    A1 < 80 "Pass",
    A1 >= 80 "Excellent"
}
```

--------------------------------

### HTML Report Preview with Custom Title

Source: https://context7.com/youseries/ureport/llms.txt

Set a custom title for the report preview. This can be used to provide context or branding for the displayed report.

```http
GET /ureport/preview?_u=file:report.ureport.xml&_title=Annual%20Sales%20Report
```

--------------------------------

### Reference All Cells

Source: https://context7.com/youseries/ureport/llms.txt

Use empty brackets [] to reference all instances of a cell regardless of position, with optional condition filtering.

```uReport
# Reference all A1 cells
A1[]
```

```uReport
# Reference all A1 cells with condition filter
A1[]{A1 > 1000 and A1 < 10000}
```

```uReport
# Sum all values matching criteria
sum(A1[]{A1 > 0})
```

```uReport
# Count cells matching condition
count(A1[]{B1 == "Active"})
```

--------------------------------

### Export Reports via HTTP Endpoints

Source: https://context7.com/youseries/ureport/llms.txt

Access report exports directly through URL parameters. Use the _u parameter to specify the report file and _n to define a custom filename.

```http
# Export to PDF (download)
GET /ureport/pdf?_u=file:report.ureport.xml&param1=value1&_n=custom-filename

# Export to PDF (inline display for printing)
GET /ureport/pdf/show?_u=file:report.ureport.xml&param1=value1

# Export to Excel (xlsx) - no pagination
GET /ureport/excel?_u=file:report.ureport.xml&param1=value1&_n=export

# Export to Excel with pagination
GET /ureport/excel/paging?_u=file:report.ureport.xml

# Export to Excel with each page as separate sheet
GET /ureport/excel/sheet?_u=file:report.ureport.xml

# Export to Excel 97 format (xls)
GET /ureport/excel97?_u=file:report.ureport.xml

# Export to Word document
GET /ureport/word?_u=file:report.ureport.xml&_n=report-document
```

--------------------------------

### Create Spring Bean Data Sources

Source: https://context7.com/youseries/ureport/llms.txt

Define Spring beans to provide data via methods accepting datasource name, dataset name, and a parameter map. Methods can return lists of maps or POJOs for reflection-based property extraction.

```java
package com.example.report;

import org.springframework.stereotype.Component;
import java.util.List;
import java.util.Map;
import java.util.ArrayList;
import java.util.HashMap;

@Component("reportDataBean")
public class ReportDataProvider {

    // Method signature: (String dsName, String datasetName, Map<String, Object> parameters)
    public List<Map<String, Object>> loadSalesData(String dsName, String datasetName,
            Map<String, Object> parameters) {
        List<Map<String, Object>> result = new ArrayList<>();

        Integer year = (Integer) parameters.get("year");
        String region = (String) parameters.get("region");

        // Query and transform data
        List<SalesRecord> records = salesService.getSalesByYearAndRegion(year, region);
        for (SalesRecord record : records) {
            Map<String, Object> row = new HashMap<>();
            row.put("product", record.getProductName());
            row.put("quantity", record.getQuantity());
            row.put("amount", record.getAmount());
            row.put("date", record.getSaleDate());
            result.add(row);
        }
        return result;
    }

    // Return POJO list - UReport2 will extract properties via reflection
    public List<Employee> loadEmployeeData(String dsName, String datasetName,
            Map<String, Object> parameters) {
        String department = (String) parameters.get("department");
        return employeeService.getEmployeesByDepartment(department);
    }
}
```

--------------------------------

### Customizing Report Storage Directory

Source: https://github.com/youseries/ureport/blob/master/docs/STORAGE-DATASOURCE.md

This section details how to change the default report storage location by configuring a properties file.

```APIDOC
## Customizing Report Storage Directory

### Description
To change the default storage directory for report files, you can create a `config.properties` file and specify the `ureport.fileStoreDir` property.

### Configuration Steps

1.  **Create `config.properties`:** Place a file named `config.properties` in the `WEB-INF` directory of your project.

2.  **Configure Spring:** Add a Bean definition to your Spring configuration file (e.g., `context.xml`) to load the `config.properties` file. This typically involves using `PropertyPlaceholderConfigurer` or a similar mechanism.

    ```xml
    <bean id="propertyConfigurer" parent="ureport.props">
        <property name="location">
            <value>/WEB-INF/config.properties</value>
        </property>
    </bean>
    ```
    *Note: If your project already has `PropertyPlaceholderConfigurer` configured, you can add UReport2 properties directly to its associated properties file.* 

3.  **Set `ureport.fileStoreDir`:** In the `config.properties` file, define the custom storage directory using the `ureport.fileStoreDir` attribute.

    ```properties
    ureport.fileStoreDir=D:/ureportfiles
    ```

    *Ensure that the specified directory exists on your server before running the application. UReport2 will not create the directory for you.*
```

--------------------------------

### UReport2 Arithmetic and String Operators

Source: https://github.com/youseries/ureport/blob/master/docs/EXPRESSION.md

Operators like +, -, *, /, and % can be used for arithmetic calculations or string concatenation. The '+' operator can combine numbers or join strings with numbers.

```text
21+31 means to calculate the sum of the two numbers and the result should be 52. “value:”+331 means to connect the two values, and the result should be “value: 331”
```

```text
21 – 31 indicates calculating the difference between the two numbers, and the result should be -10
```

```text
3*6 results in 18
```

```text
6/3 results in 2. If one number will not divide into the other number, 8 decimal places shall be kept
```

```text
5%3 results in 2; and 6%2 results in 0
```

--------------------------------

### Add UReport2 Maven Dependency

Source: https://github.com/youseries/ureport/blob/master/README.md

Include this dependency in your Maven project's pom.xml to add UReport2 console functionality. Replace '[version]' with the desired UReport2 version.

```xml
<dependency>
    <groupId>com.bstek.ureport</groupId>
    <artifactId>ureport2-console</artifactId>
    <version>[version]</version>
</dependency>
```

--------------------------------

### If Expression Logic

Source: https://context7.com/youseries/ureport/llms.txt

Use if expressions for complex multi-condition logic with multiple branches and return statements.

```uReport
# Simple if expression
if(A1 > 1000) {
    return "Premium"
}
```

```uReport
# If-else expression
if(A1 > 1000) {
    return "High value"
} else {
    "Standard"
}
```

```uReport
# Multiple conditions with else if
if(A1 > 10000) {
    return "VIP Customer"
} else if(A1 > 5000) {
    return "Gold Customer"
} else if(A1 > 1000) {
    return "Silver Customer"
} else {
    "Regular Customer"
}
```

```uReport
# Compound conditions
if(A1 > 1000 and B1 == "Active") {
    return "Active Premium: " + A1
} else if(A1 > 500 or B1 == "Special") {
    return "Special Rate"
} else {
    "Standard Rate"
}
```

--------------------------------

### UReport2 Expression Language Syntax

Source: https://context7.com/youseries/ureport/llms.txt

Perform calculations and logic within report cells using arithmetic, cell references, and boolean comparisons.

```text
# Basic data types and arithmetic
1 + 2 * 3                    # Result: 7
100 / 4                      # Result: 25
17 % 5                       # Result: 2
"Total: " + 1500             # Result: "Total: 1500"

# Cell references
A1                           # Reference cell A1 value
A1 + B1                      # Sum of cells A1 and B1
A1 * 0.1                     # Calculate 10% of A1

# Boolean values
true
false
A1 > 1000                    # Comparison returns boolean
```

--------------------------------

### UReport2 ReportProvider Interface

Source: https://github.com/youseries/ureport/blob/master/docs/STORAGE-DATASOURCE.md

The ReportProvider interface defines the contract for report storage mechanisms in UReport2. Implementations handle loading, deleting, listing, and saving report files.

```java
package com.bstek.ureport.provider.report;

import java.io.InputStream;
import java.util.List;

/**
*  @author  Jacky.gao
*  @since  2016年12月4日
*  @since  Dec. 4 2016
*/
public interface ReportProvider {
/**
*      根据报表名加载报表文件
* Load the report file according to the report name
*@param file 报表名称
* @param file report name
*@return  返回的InputStream
* @return  returned InputStream
*/
InputStream loadReport(String file);
/**
*       根据报表名，删除指定的报表文件
* Delete the specific report file according to the report name
*  @param  file  报表名称
*  @param  file  report name
*/
void deleteReport(String file);
/**
*     获取所有的报表文件
* Acquire all report files
*  @return  返回报表文件列表
*  @return  return the list of report file
*/
List<ReportFile>  getReportFiles();
/**
*   保存报表文件
* Save report files
*@param file 报表名称
* @param file report name
*@param content 报表的XML内容
* @param content XML content of report
*/
void saveReport(String file,String content);
/**
*  @return  返回存储器名称
*  @return  return storage name
*/
String getName();
/**
*  @return  返回是否禁用
*  @return  return if deactivation
*/
boolean  disabled();
/**
*  @return  返回报表文件名前缀
*  @return  return prefix of report name
*/

```

--------------------------------

### Load Report Data as JSON

Source: https://context7.com/youseries/ureport/llms.txt

Retrieve report data in JSON format, typically used for AJAX requests. Specify the report and page index (`_i`) to load specific data.

```http
GET /ureport/preview?_method=loadData&_u=file:report.ureport.xml&_i=1
```

--------------------------------

### HTTP Export Endpoints

Source: https://context7.com/youseries/ureport/llms.txt

This section lists the available HTTP endpoints for exporting reports directly via URL requests, supporting various formats and options.

```APIDOC
## HTTP Export Endpoints

UReport2 provides servlet endpoints for exporting reports directly via HTTP requests with support for various formats and options.

### Export to PDF (download)
```
GET /ureport/pdf?_u=file:report.ureport.xml&param1=value1&_n=custom-filename
```

### Export to PDF (inline display for printing)
```
GET /ureport/pdf/show?_u=file:report.ureport.xml&param1=value1
```

### Export to Excel (xlsx) - no pagination
```
GET /ureport/excel?_u=file:report.ureport.xml&param1=value1&_n=export
```

### Export to Excel with pagination
```
GET /ureport/excel/paging?_u=file:report.ureport.xml
```

### Export to Excel with each page as separate sheet
```
GET /ureport/excel/sheet?_u=file:report.ureport.xml
```

### Export to Excel 97 format (xls)
```
GET /ureport/excel97?_u=file:report.ureport.xml
```

### Export to Word document
```
GET /ureport/word?_u=file:report.ureport.xml&_n=report-document
```
```
Tokens:
Raw