To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Represents a custom repository report loaded from a report descriptor file (named with a .report.json suffix) and parsed by QueryService. Holds the report's name, display title, the name of the SQL table or query it runs against, and its content, which is a data query template combined with formatting instructions. Reports of this kind are listed under a repository's reports folder and rendered on screen or exported to CSV on request.
Properties
| Property | Returns | Description |
|---|---|---|
| content | String | The report's content template, either taken directly from the "content" property of the descriptor file or, if that is blank, read from the file named by its "contentFile" property. Defines the query and formatting used to render the report. |
| description | String | Free text description of the report, taken from the "description" property of the descriptor file. May be null if the descriptor omits it. |
| name | String | The report's identifier, taken from the descriptor file's name with the .report.json suffix removed. Used to look the report up and to build its URL within the reports folder. Never null once loaded from a file, but is null on a bean built with the no-arg constructor. |
| tableName | String | The name of the database table or query the report runs against, taken from the "tableName" property of the descriptor file. Is null when the report does not target a specific table. |
| title | String | The report's human-readable display title, taken from the "title" property of the descriptor file. May be null if the descriptor omits it. |
Methods
getName()
Returns: String
The report's identifier, taken from the descriptor file's name with the .report.json suffix removed. Used to look the report up and to build its URL within the reports folder. Never null once loaded from a file, but is null on a bean built with the no-arg constructor.
getTitle()
Returns: String
The report's human-readable display title, taken from the "title" property of the descriptor file. May be null if the descriptor omits it.
getTableName()
Returns: String
The name of the database table or query the report runs against, taken from the "tableName" property of the descriptor file. Is null when the report does not target a specific table.
getContent()
Returns: String
The report's content template, either taken directly from the "content" property of the descriptor file or, if that is blank, read from the file named by its "contentFile" property. Defines the query and formatting used to render the report.
getDescription()
Returns: String
Free text description of the report, taken from the "description" property of the descriptor file. May be null if the descriptor omits it.
© 2025 Kademi Ltd