com.dslplatform.client

Interface ReportingProxy

public interface ReportingProxy

Proxy service to reporting operations such as document generation, report population and history lookup. Report should be used to minimize calls to server.

It is preferred to use domain patterns instead of this proxy service.

DSL example:

 module Todo {
   aggregate Task {
     timestamp createdAt;
     timestamp? finishedAt;
   }
   
   report LoadData {
     int maxUnfinished;
     List<Task> unfinishedTasks 'it => it.finishedAt == null' LIMIT maxUnfinished ORDER BY createdAt;
     List<Task> recentlyFinishedTasks 'it => it.finishedAt != null' LIMIT 10 ORDER BY finishedAt DESC;
   }
 }
 

Method Summary

Methods

Modifier and Type	Method and Description
<TReport> java.util.concurrent.Future<byte[]>	createReport(TReport report, java.lang.String templater) Create document from report.
<TIdentifiable extends Identifiable> java.util.concurrent.Future<byte[]>	findTemplater(java.lang.Class<TIdentifiable> manifest, java.lang.String file, java.lang.String uri, boolean toPdf) Populate template using found domain object.
<TAggregate extends AggregateRoot> java.util.concurrent.Future<java.util.List<History<TAggregate>>>	getHistory(java.lang.Class<TAggregate> manifest, java.lang.Iterable<java.lang.String> uris) Get aggregate root history.
<TSource extends Searchable> java.util.concurrent.Future<byte[]>	olapCube(java.lang.String cubeName, Specification<TSource> specification, java.lang.String templater, java.lang.Iterable<java.lang.String> dimensions, java.lang.Iterable<java.lang.String> facts, java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> order) Perform data analysis on specified data source.
java.util.concurrent.Future<byte[]>	olapCube(java.lang.String cubeName, java.lang.String templater, java.lang.Iterable<java.lang.String> dimensions, java.lang.Iterable<java.lang.String> facts, java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> order) Perform data analysis on specified data source.
<TReport> java.util.concurrent.Future<TReport>	populate(TReport report) Populate report.
<TSearchable extends Searchable> java.util.concurrent.Future<byte[]>	searchTemplater(java.lang.Class<TSearchable> manifest, java.lang.String file, Specification<TSearchable> specification, boolean toPdf) Populate template using domain objects which satisfies specification.

Method Detail

populate

<TReport> java.util.concurrent.Future<TReport> populate(TReport report)

Populate report. Send message to server with serialized report specification. TODO: API change. New version has TReport and TResult

Parameters:

report - specification

Returns:

future to populated results

createReport

<TReport> java.util.concurrent.Future<byte[]> createReport(TReport report,
                                                         java.lang.String templater)

Create document from report. Send message to server with serialized report specification. Server will return template populated with found data.

DSL example:

 module Todo {
   report LoadData {
     List<Task> unfinishedTasks 'it => it.finishedAt == null' ORDER BY createdAt;
     templater createDocument 'Tasks.docx' pdf;
   }
 }
 

Parameters:

report - specification

templater - templater name

Returns:

future to document content

olapCube

<TSource extends Searchable> java.util.concurrent.Future<byte[]> olapCube(java.lang.String cubeName,
                                                                        Specification<TSource> specification,
                                                                        java.lang.String templater,
                                                                        java.lang.Iterable<java.lang.String> dimensions,
                                                                        java.lang.Iterable<java.lang.String> facts,
                                                                        java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> order)

Perform data analysis on specified data source. Data source is filtered using provided specification. Analysis is performed by grouping data by dimensions and aggregating information using specified facts.

Parameters:

cubeName - olap cube name

specification - filter data source

templater - templater name

dimensions - group by dimensions

facts - analyze using facts

order - custom order for result

Returns:

future to document content

olapCube

java.util.concurrent.Future<byte[]> olapCube(java.lang.String cubeName,
                                           java.lang.String templater,
                                           java.lang.Iterable<java.lang.String> dimensions,
                                           java.lang.Iterable<java.lang.String> facts,
                                           java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> order)

Perform data analysis on specified data source. Analysis is performed by grouping data by dimensions and aggregating information using specified facts.

Parameters:

cubeName - olap cube name

templater - templater name

dimensions - group by dimensions

facts - analyze using facts

order - custom order for result

Returns:

future to document content

getHistory

<TAggregate extends AggregateRoot> java.util.concurrent.Future<java.util.List<History<TAggregate>>> getHistory(java.lang.Class<TAggregate> manifest,
                                                                                                             java.lang.Iterable<java.lang.String> uris)

Get aggregate root history. History is collection of snapshots made at state changes.

Parameters:

manifest - aggregate root type

uris - collection of aggregate identities

Returns:

future to collection of found aggregate histories

findTemplater

<TIdentifiable extends Identifiable> java.util.concurrent.Future<byte[]> findTemplater(java.lang.Class<TIdentifiable> manifest,
                                                                                     java.lang.String file,
                                                                                     java.lang.String uri,
                                                                                     boolean toPdf)

Populate template using found domain object. Optionally convert document to PDF.

Parameters:

manifest - domain object type

file - template file

uri - domain object identity

toPdf - convert populated document to PDF

Returns:

future to populated document

searchTemplater

<TSearchable extends Searchable> java.util.concurrent.Future<byte[]> searchTemplater(java.lang.Class<TSearchable> manifest,
                                                                                   java.lang.String file,
                                                                                   Specification<TSearchable> specification,
                                                                                   boolean toPdf)

Populate template using domain objects which satisfies specification. Optionally convert document to PDF.

Parameters:

manifest - domain object type

file - template file

specification - filter domain objects using specification

toPdf - convert populated document to PDF

Returns:

future to populated document