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

Modifier and Type	Method and Description
<TReport extends Report<TResult>,TResult> java.util.concurrent.Future<byte[]>	createReport(TReport report, java.lang.String templater) Creates a document from a report.
<T extends Identifiable> java.util.concurrent.Future<byte[]>	findTemplater(java.lang.Class<T> manifest, java.lang.String file, java.lang.String uri, boolean toPdf) Populates a template using a 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) Gets an aggregate root's 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 the 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 extends Report<TResult>,TResult> java.util.concurrent.Future<TResult>	populate(java.lang.Class<TResult> result, TReport report) Populates a report.
<TSearchable extends Searchable> java.util.concurrent.Future<byte[]>	searchTemplater(java.lang.Class<TSearchable> manifest, java.lang.String file, Specification<TSearchable> specification, boolean toPdf) Populates a template using domain objects which satisfies a specification.

Method Detail

populate

<TReport extends Report<TResult>,TResult> java.util.concurrent.Future<TResult> populate(java.lang.Class<TResult> result,
                                                                                        TReport report)

Populates a report. Sends a message to the server with a serialized report specification.

Type Parameters:

TReport - report type

TResult - result type

Parameters:

result - result class

report - specification

Returns:

future with the populated results

createReport

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

Creates a document from a report. Sends a message to server with a serialized report specification. Server will return a 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;
   }
 }
 

Type Parameters:

TReport - report type

TResult - result type

Parameters:

report - specification

templater - templater name

Returns:

future with the 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 the specified data source. Data source is filtered using provided specification. Analysis is performed by grouping data by dimensions and aggregating information using specified facts.

Type Parameters:

TSource - searchable type

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 with the 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 with the 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)

Gets an aggregate root's history. History is a collection of snapshots made at state changes.

Type Parameters:

TAggregate - aggregate root type

Parameters:

manifest - aggregate root class (for deserialization)

uris - collection of aggregate identities

Returns:

future with a collection of found aggregate histories

findTemplater

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

Populates a template using a found domain object. Optionally converts the document to PDF.

Type Parameters:

T - identifiable domain type

Parameters:

manifest - domain object type

file - template file

uri - domain object identity

toPdf - convert populated document to PDF

Returns:

future with the 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)

Populates a template using domain objects which satisfies a specification. Optionally converts the document to PDF.

Type Parameters:

TSearchable - searchable type

Parameters:

manifest - domain object type

file - template file

specification - filter domain objects using specification

toPdf - convert populated document to PDF

Returns:

future with the populated document