Home » Archived » BIRT » javadoc online?
|
| Re: javadoc online? [message #195793 is a reply to message #195701] |
Mon, 16 October 2006 17:27   |
|
All the Javadocs are available in the online help for BIRT.
Open the Help Contents. Open the BIRT Programmer's reference and the
Javadocs are included.
Jason
"Leos Literak" <literakl@centrum.cz> wrote in message
news:eh08hb$2l5$1@utils.eclipse.org...
> Hi,
>
> I try to integrate BIRT into our framework. BIRT is
> a component, its html ouput is integrated into JSF page.
> I need to pass parameter from URL into IRunAndRenderTask.
> I didn't find it in http://www.eclipse.org/birt/phoenix/deploy/#reportAPI
> so I looked for javadoc - it is not online. I have to
> download BIRT SDK to access it :-(
>
> 1) please add this information about parameters into Integration
> page
>
> 2) upload javadoc online, it is a good habbit of most open source
> projects
>
> Thanks
>
> Leos
|
|
|
| Re: javadoc online? [message #195893 is a reply to message #195793] |
Tue, 17 October 2006 07:55 |
 Leos Literak
Messages: 115
Registered: July 2009 |
Senior Member |
|
|
Jason,
that does not work for me. When I click on this topic in Help Contents,
SWT error occurs and it instructs me to shut down eclipse.
Nevertheless even if it worked, I don't find it as sufficient. What is
the problem with having javadoc online? Why do I have to download complete
BIRT installation to look for one method's javadoc?
I don't use eclipse as my Java IDE, so I'd prefer to have separate
javadoc independant of Eclipse. It is really useful when javadoc is
online, even google can index it.
I downloaded SDK but it is hard to find it there. It is full of plugins
with long names, that are hard to guess their purpose for newbies.
I found BIRT help in:
plugins/org.eclipse.birt.doc_2.1.1.v20060921-1226/doc.zip
Javadoc is in
plugins/org.eclipse.birt.doc.isv_2.1.1.v20060921-1226/doc.zi p
Could you at least write into README of SDK that users can find it
there?
Thanks
Leos
Jason Weathersby napsal(a):
> All the Javadocs are available in the online help for BIRT.
> Open the Help Contents. Open the BIRT Programmer's reference and the
> Javadocs are included.
>
> Jason
>
> "Leos Literak" <literakl@centrum.cz> wrote in message
> news:eh08hb$2l5$1@utils.eclipse.org...
>> Hi,
>>
>> I try to integrate BIRT into our framework. BIRT is
>> a component, its html ouput is integrated into JSF page.
>> I need to pass parameter from URL into IRunAndRenderTask.
>> I didn't find it in http://www.eclipse.org/birt/phoenix/deploy/#reportAPI
>> so I looked for javadoc - it is not online. I have to
>> download BIRT SDK to access it :-(
>>
>> 1) please add this information about parameters into Integration
>> page
>>
>> 2) upload javadoc online, it is a good habbit of most open source
>> projects
|
|
|
| Re: javadoc online? [message #195901 is a reply to message #195893] |
Tue, 17 October 2006 08:19 |
Eclipse User |
|
|
|
Originally posted by: ratz._NOSPAM_drugphish.ch
Leos,
I'll chime in since you seem to be a bit impatient and the US guys are
still mostly asleep.
> that does not work for me. When I click on this topic in Help Contents,
> SWT error occurs and it instructs me to shut down eclipse.
That's rather bad.
> Nevertheless even if it worked, I don't find it as sufficient. What is
> the problem with having javadoc online? Why do I have to download complete
> BIRT installation to look for one method's javadoc?
Would following documentation be enough for you?:
http://help.eclipse.org/help31/index.jsp?topic=/org.eclipse. birt.doc/model/api/index.html
To me it seems that the whole BIRT API is referenced there in javadoc
format, publicly.
> I don't use eclipse as my Java IDE, so I'd prefer to have separate
> javadoc independant of Eclipse. It is really useful when javadoc is
> online, even google can index it.
Is there some other documentation besides the whole Eclipse and Birt API
you're missing? The Java language API can be found via:
http://java.sun.com/reference/api
But I'm sure you knew that.
> I downloaded SDK but it is hard to find it there. It is full of plugins
> with long names, that are hard to guess their purpose for newbies.
That is true.
> I found BIRT help in:
> plugins/org.eclipse.birt.doc_2.1.1.v20060921-1226/doc.zip
> Javadoc is in
> plugins/org.eclipse.birt.doc.isv_2.1.1.v20060921-1226/doc.zi p
This is IMHO the ROM, to be found at the first reference I gave you above:
http://help.eclipse.org/help31/index.jsp?topic=/org.eclipse. birt.doc/model/api/index.html
> Could you at least write into README of SDK that users can find it
> there?
Which README are you referring to exactly?
Your initial question to my avail has only little to do with BIRT, but
rather with how to handle URI parsing from within Servlet Context.
There's huge amount of excellently written material in the Internet:
http://www.coreservlets.com/
https://bpcatalog.dev.java.net/nonav/ajax/textfield-jsf/desi gn.html
To me, your problem sounded like you just need to get the correct
parameters passed within the request, like so:
String var = request.getParameter("passed_var");
I might be completely mistaken regarding your problem, but then you
probably should re-formulate your problem or wait for someone to
understand your question.
HTH and best regards,
Roberto Nibali, ratz
--
echo
'[q]sa[ln0=aln256%Pln256/snlbx]sb313507179010176854228757843 9snlbxq' | dc
|
|
|
| Re: javadoc online? [message #195944 is a reply to message #195901] |
Tue, 17 October 2006 10:58 |
Leos Literak
Messages: 115
Registered: July 2009 |
Senior Member |
|
|
Roberto Nibali napsal(a):
> I'll chime in since you seem to be a bit impatient and the US guys are
> still mostly asleep.
I know, Roberto :-) But I write emails in my timezone, they can wait
till USE guys wake up. ;-)
>> BIRT installation to look for one method's javadoc?
>
> Would following documentation be enough for you?:
>
> http://help.eclipse.org/help31/index.jsp?topic=/org.eclipse. birt.doc/model/api/index.html
cool, that is what I searched for. Where did you find this link?
I thought that I have already visited most of BIRT pages, though I didn't
find it.
> To me it seems that the whole BIRT API is referenced there in javadoc
> format, publicly.
you are right, perfect!
> Is there some other documentation besides the whole Eclipse and Birt API
> you're missing? The Java language API can be found via:
> http://java.sun.com/reference/api
>
> But I'm sure you knew that.
I was talking about BIRT's javadoc, not JDK javadoc
>> I found BIRT help in:
>> plugins/org.eclipse.birt.doc_2.1.1.v20060921-1226/doc.zip
>> Javadoc is in
>> plugins/org.eclipse.birt.doc.isv_2.1.1.v20060921-1226/doc.zi p
>
> This is IMHO the ROM, to be found at the first reference I gave you above:
I can find complete javadoc in those zip files.
>> Could you at least write into README of SDK that users can find it
>> there?
>
> Which README are you referring to exactly?
birt-report-framework-sdk-2_1_1.zip contains directory eclipse
with sub directories features and plugins and two files:
epl-v10.html and notice.html. So actually you are right - there is
no README at all :-(
As a newbie I didn't know, what to do with this file. I guess that
it shall be copied to eclipse installation, shall not it?
> Your initial question to my avail has only little to do with BIRT, but
> rather with how to handle URI parsing from within Servlet Context.
> There's huge amount of excellently written material in the Internet:
>
> http://www.coreservlets.com/> I might be completely mistaken regarding your problem, but then you
> probably should re-formulate your problem or wait for someone to
> understand your question.
Well, you are right. I didn't seek help for my initial problem,
so I was quite lazy to describe it perfectly. My report requires
a parameter id to be set. I embed BIRT into our JSF page, so I
have to pass HTTP request parameter to BIRT ReportEngine myself.
This page http://www.eclipse.org/birt/phoenix/deploy/reportEngineAPI.p hp
does not deal with parameter passing to report engine. So I had to
find javadoc to see available methods and finally I wrote following
code, which works:
IRunAndRenderTask task = engine.createRunAndRenderTask(design);
task.setParameterValue(key, value);
It would be great, if this use case is covered by Report Engine API
page.
Sincerrelly
Leos
|
|
|
| Re: javadoc online? [message #195961 is a reply to message #195944] |
Tue, 17 October 2006 12:55 |
| Eclipse User |
|
|
|
Originally posted by: ratz._NOSPAM_drugphish.ch
Hello Leos,
> I know, Roberto :-) But I write emails in my timezone, they can wait
> till USE guys wake up. ;-)
>>> BIRT installation to look for one method's javadoc?
>>
>> Would following documentation be enough for you?:
>>
>> http://help.eclipse.org/help31/index.jsp?topic=/org.eclipse. birt.doc/model/api/index.html
>
> cool, that is what I searched for. Where did you find this link?
http://www.google.cz/search?hl=cs&q=birt+api+documentati on&btnG=Vyhledat+Googlem&lr=
And then I clicked on the first link :).
> I thought that I have already visited most of BIRT pages, though I didn't
> find it.
The BIRT homepage is violating the principle of software ergonomics in
GUI design, that's probably why. To me one of the big missing points on
the entry page (http://www.eclipse.org/birt/phoenix/) is a documentation
section, which consist of
1. Users documentation (Installation, FAQ and forth)
2. Developers documentation (Reference, Examples, API, Wiki and forth)
The Navigation Menu should not consist of more than 9 elements,
normally. But this is all off-topic, possibly interesting read-up on:
http://www.webstyleguide.com/index.html
>> To me it seems that the whole BIRT API is referenced there in javadoc
>> format, publicly.
>
> you are right, perfect!
>
>> Is there some other documentation besides the whole Eclipse and Birt
>> API you're missing? The Java language API can be found via:
>> http://java.sun.com/reference/api
>>
>> But I'm sure you knew that.
>
> I was talking about BIRT's javadoc, not JDK javadoc
>>> I found BIRT help in:
>>> plugins/org.eclipse.birt.doc_2.1.1.v20060921-1226/doc.zip
>>> Javadoc is in
>>> plugins/org.eclipse.birt.doc.isv_2.1.1.v20060921-1226/doc.zi p
>>
>> This is IMHO the ROM, to be found at the first reference I gave you
>> above:
>
> I can find complete javadoc in those zip files.
I'm perfectly content with the online API documentation, so the
documentation found somewhere in the sources is of no interest to me.
>>> Could you at least write into README of SDK that users can find it
>>> there?
>>
>> Which README are you referring to exactly?
>
> birt-report-framework-sdk-2_1_1.zip contains directory eclipse
> with sub directories features and plugins and two files:
> epl-v10.html and notice.html. So actually you are right - there is
> no README at all :-(
Where you expecting one?
> As a newbie I didn't know, what to do with this file. I guess that
> it shall be copied to eclipse installation, shall not it?
Which file are you referring to?
>> Your initial question to my avail has only little to do with BIRT, but
>> rather with how to handle URI parsing from within Servlet Context.
>> There's huge amount of excellently written material in the Internet:
>>
>> http://www.coreservlets.com/> I might be completely mistaken regarding
>> your problem, but then you probably should re-formulate your problem
>> or wait for someone to understand your question.
>
> Well, you are right. I didn't seek help for my initial problem,
> so I was quite lazy to describe it perfectly. My report requires
> a parameter id to be set. I embed BIRT into our JSF page, so I
> have to pass HTTP request parameter to BIRT ReportEngine myself.
> This page http://www.eclipse.org/birt/phoenix/deploy/reportEngineAPI.p hp
> does not deal with parameter passing to report engine.
That is correct and Jason has mentioned that this part of the
documentation shall be updated, as soon as he finds time. When I first
searched for this I found following helpful documentation (in this order):
http://wiki.eclipse.org/index.php/Simple_Execute
http://marklorenz.blogspot.com/2006/03/more-birt-tips-for-ja va-developers.html
http://marklorenz.blogspot.com/2006/02/birt-tips-for-java-de velopers.html
http://help.eclipse.org/help31/index.jsp?topic=/org.eclipse. birt.doc/engine/api/org/eclipse/birt/report/engine/api/IEngi neTask.html
> So I had to
> find javadoc to see available methods and finally I wrote following
> code, which works:
>
> IRunAndRenderTask task = engine.createRunAndRenderTask(design);
> task.setParameterValue(key, value);
Alternatively you can create a HashMap of parameters and pass them via
the following call:
task.setParameterValues(params)
That's what I use for example to pass the parameters HashMap I get from
the OpenReports framework to the BIRT engine for rendering. Works like a
charm. For some (not yet understood and decided) motivation I also add
following call after the set-method:
task.validateParameters();
I have absolutely no clue what this actually does and from the
documentation I gather:
public boolean validateParameters()
Returns:
whether the parameter validation succeeds
Aha, and then reading the source code leaves me absolutely clueless:
public boolean validateParameters( ) {
if (runnable == null) {
return false;
}
// set the parameter values into the execution context
usingParameterValues( );
// validate each parameter to see if it is validate
????? I tried really hard to understand this ...
return new ParameterVisitor( ) {
boolean visitScalarParameter( ScalarParameterHandle param, Object
value ) {
return validateScalarParameter( param );
}
boolean visitParameterGroup( ParameterGroupHandle group, Object
value ) {
return visitParametersInGroup( group, value );
}
}.visit( (ReportDesignHandle) runnable.getDesignHandle( ), null );
}
Even when skimming over the call-chain; I was definitely amused by the
code comment regarding validation, though :). So I'd also welcome some
information on this.
> It would be great, if this use case is covered by Report Engine API
> page.
Fully agreed on my part.
Best regards,
Roberto Nibali, ratz
--
echo
'[q]sa[ln0=aln256%Pln256/snlbx]sb313507179010176854228757843 9snlbxq' | dc
|
|
|
Goto Forum:
Current Time: Mon Dec 30 17:14:43 GMT 2024
Powered by FUDForum. Page generated in 0.03445 seconds |
] 
Search
Help
Register
Login
Home
