Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » BIRT » Where can i find the Birt 2.5.2 report engine api documentation?(Birt 2.5.2 report engine api documentation.)
Where can i find the Birt 2.5.2 report engine api documentation? [message #558582] Mon, 13 September 2010 15:16 Go to next message
dash  is currently offline dash Friend
Messages: 20
Registered: August 2010
Junior Member
Hi,

The integration tutorial offers code snippets on how to accomplish certain tasks in report engine, but I haven't be able to find a complete api doc for release 2.5.2. There is a link points to a wiki page that shows bits and pieces of some sample code for 2.2 release...

Is there a 2.5 api documentation somewhere for the report engine? If not, what will my best option?

thanks,
kenny
Re: Where can i find the Birt 2.5.2 report engine api documentation? [message #558621 is a reply to message #558582] Mon, 13 September 2010 17:32 Go to previous messageGo to next message
Jason Weathersby is currently offline Jason WeathersbyFriend
Messages: 9167
Registered: July 2009
Senior Member

Kenny,

We have them online at
http://www.birt-exchange.com/be/downloads/documentation/#cur rentdocs
but they need to be updated. If you download sdk
here:
http://download.eclipse.org/birt/downloads/build.php?build=R -R1-2_5_2-201002221500

You will find three doc plugins and 3 doc features that you can add to
your eclipse install and they will show up in your help.

They are named (plugins and features)
org.eclipse.birt.chart.doc.isv
org.eclipse.birt.doc.isv
org.eclipse.birt.doc

Jason

On 9/13/2010 11:16 AM, dash wrote:
> Hi,
>
> The integration tutorial offers code snippets on how to accomplish
> certain tasks in report engine, but I haven't be able to find a complete
> api doc for release 2.5.2. There is a link points to a wiki page that
> shows bits and pieces of some sample code for 2.2 release...
>
> Is there a 2.5 api documentation somewhere for the report engine? If
> not, what will my best option?
>
> thanks,
> kenny
Re: Where can i find the Birt 2.5.2 report engine api documentation? [message #558665 is a reply to message #558621] Mon, 13 September 2010 20:24 Go to previous messageGo to next message
dash  is currently offline dash Friend
Messages: 20
Registered: August 2010
Junior Member
Jason,

Good to hear from you! After digging thru the docs a bit, I can't find what I'm looking for. I would like to hear your advice on what I would like to implement.

Instead of writing the report to the disk, I would like to get
the report binary and store it into a byte array in the RunReportResponse object, that needs to be populated with other data before sending it back to the client.

I've only found an api that does
options.setOutputStream(response); where response is an HttpServletResponse object.

I don't want to stream the report back to the client right away.

I could do the dumb way by writing the report out to a file and reading it back to the byte array, but it's an unnecessary IO that hammers the performance.

Any suggestion or workaround?

Thanks,
kenny

// code snippets
public class RunReportResponse extends ReportResponse
{
private byte[] reportData;

publi
Re: Where can i find the Birt 2.5.2 report engine api documentation? [message #558667 is a reply to message #558621] Mon, 13 September 2010 20:34 Go to previous messageGo to next message
dash  is currently offline dash Friend
Messages: 20
Registered: August 2010
Junior Member
Jason,

Good to hear from you! After digging thru the docs a bit, I can't find what I'm looking for. I would like to hear your advice on what I would like to implement.

Instead of writing the report to the disk, I would like to get
the report binary and store it into a byte array in an RunReportResponse object, our custom response object, that needs to be populated with other data before sending it back to the client.

I've only found an api that does
options.setOutputStream(response); where response is an HttpServletResponse object. I don't want to stream the report back to the client right away.

I could do the dumb way by writing the report out to a file and reading it back to a byte array in the RunReportResponse, but it's an unnecessary IO that hammers the performance.

Any suggestion or workaround?

Thanks,
kenny

// code snippets
public class RunReportResponse extends ReportResponse
{
private byte[] reportData;

public void setReportData(byte[] reportData)
{
this.reportData = reportData;
}

public byte[] getReportData()
{
return reportData;
}
}


@WebMethod
public RunReportResponse runReport(RunReportRequest request) {

String reportName = request.getName();
...
if (reportFormat.equalsIgnoreCase(PDF_FORMAT)) {
PDFRenderOption options = new PDFRenderOption();


options.setOutputFileName(REPORTS_PATH + "/" + reportName + "." + PDF_FORMAT);

options.setOutputFormat(PDF_FORMAT);
task.setRenderOption(options);
}

...
}
Re: Where can i find the Birt 2.5.2 report engine api documentation? [message #558864 is a reply to message #558667] Tue, 14 September 2010 15:50 Go to previous message
Jason Weathersby is currently offline Jason WeathersbyFriend
Messages: 9167
Registered: July 2009
Senior Member

Kenny,

The setOutputStream method can use any OutputStream. If you just want
the bytes, create a new ByteArrayOutputStream and use it.

ByteArrayOutputStream baos= new ByteArrayOutputStream();
options.setOutputStream(baos);
mybytearray = baos.getBytes();

Jason

On 9/13/2010 4:34 PM, dash wrote:
> Jason,
>
> Good to hear from you! After digging thru the docs a bit, I can't find
> what I'm looking for. I would like to hear your advice on what I would
> like to implement.
>
> Instead of writing the report to the disk, I would like to get the
> report binary and store it into a byte array in an RunReportResponse
> object, our custom response object, that needs to be populated with
> other data before sending it back to the client.
>
> I've only found an api that does options.setOutputStream(response);
> where response is an HttpServletResponse object. I don't want to stream
> the report back to the client right away.
> I could do the dumb way by writing the report out to a file and reading
> it back to a byte array in the RunReportResponse, but it's an
> unnecessary IO that hammers the performance.
>
> Any suggestion or workaround?
>
> Thanks,
> kenny
>
> // code snippets
> public class RunReportResponse extends ReportResponse
> {
> private byte[] reportData;
> public void setReportData(byte[] reportData)
> {
> this.reportData = reportData;
> }
>
> public byte[] getReportData()
> {
> return reportData;
> }
> }
>
>
> @WebMethod
> public RunReportResponse runReport(RunReportRequest request) {
>
> String reportName = request.getName();
> ...
> if (reportFormat.equalsIgnoreCase(PDF_FORMAT)) {
> PDFRenderOption options = new PDFRenderOption();
>
>
> options.setOutputFileName(REPORTS_PATH + "/" + reportName + "." +
> PDF_FORMAT);
>
> options.setOutputFormat(PDF_FORMAT);
> task.setRenderOption(options);
> }
>
> ...
> }
Previous Topic:Modify the "Business Intelligence and Reporting Tools -> New Report" wizard?
Next Topic:BIRT and iText (or other GPL libraries)
Goto Forum:
  


Current Time: Thu Nov 27 07:16:30 GMT 2014

Powered by FUDForum. Page generated in 0.02554 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software