You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@stanbol.apache.org by Mohammad Ghufran <em...@gmail.com> on 2014/09/26 17:17:37 UTC
JAVA API
Hello,
Is there a way to use stanbol through Java or some third party API like
this one: https://github.com/zaizi/apache-stanbol-client has to be used?
In case there is a way, could someone point me to some documentation and
maybe some examples? In the latter case, which is the recommended API
wrapper?
Best Regards,
Ghufran
Re: JAVA API
Posted by Rupert Westenthaler <ru...@gmail.com>.
Hi Ghufran
Maybe have a look at this Blog post [1]. It nicely describes how to
build your first Enhancement Engine for Apache Stanbol.
best
Rupert
[1] http://blog.iks-project.eu/getting-started-with-apache-stanbol-enhancement-engine/
On Mon, Oct 6, 2014 at 12:29 PM, Mohammad Ghufran <em...@gmail.com> wrote:
> Hello,
>
> Thank you for the responses and sorry for getting back at this so late.
> I've already seen this API documentation but it has no info on how to use
> it inside a standalone java project. Allesandro, I am open to using maven
> too, but I don't know how to make the maven installation of stanbol inside
> eclipse (I am a beginner at Java). If there is some resource available for
> helping with info on this setup, or if you can shed some light on this, it
> would be great!
>
> I don't think converting my existing app to OSGi would be possible (or
> practical).
>
> For the method of including the jar files, I should just add all of the jar
> files of components that I need as references to my project? I don't
> understand, conceptually, how it would make my standalone project
> communicate with the Felix server running the different chains.
>
> Thank you again for your responses and help!
>
> Best Regards,
> Ghufran
>
> Mohammad Ghufran
>
> On Sun, Sep 28, 2014 at 4:31 PM, Rupert Westenthaler <
> rupert.westenthaler@gmail.com> wrote:
>
>> Hi
>>
>> For the Stanbol Enhancer please have a look on the documentation [1]
>> on the webpage.
>>
>> For API usage of the Stanbol Enhancer you need the following OSGI Services:
>>
>> * ContentItemFactory: create ContentItems for InputStreams, Strings
>> and/or ByteArrays
>> * ChainManager: Allows to lookup configured chains
>> * EnhancementJobManager: the interface used to enhance ContentItems
>>
>> best
>> Rupert
>>
>>
>>
>> [1]
>> http://stanbol.apache.org/docs/trunk/components/enhancer/#main-interfaces-and-utility-classes
>>
>> On Fri, Sep 26, 2014 at 5:41 PM, Alessandro Adamou
>> <al...@open.ac.uk> wrote:
>> > I should mention that of course you will need to know how to use the
>> > APIs. Javadoc is available as a separate archive for every bundle. For
>> > example, to get the Javadoc of the Enhancer, you will go to:
>> >
>> >
>> http://central.maven.org/maven2/org/apache/stanbol/org.apache.stanbol.enhancer.servicesapi/0.12.0/
>> >
>> > and download the file called
>> > org.apache.stanbol.enhancer.servicesapi-0.12.0-javadoc.jar
>> >
>> > Eventually, the Javadoc will be available in HTML on the project page,
>> > see http://issues.apache.org/jira/browse/STANBOL-578
>> >
>> > I'm writing all this assuming you are not using Maven. If you are, or
>> > course you do not need to manually download any JAR and have to proceed
>> > differently. Just let us know if you do.
>> >
>> > HTH
>> >
>> > Alessandro
>> >
>> >
>> >
>> > On 26/09/2014 16:32, Alessandro Adamou wrote:
>> >>
>> >> Hi Ghufran,
>> >>
>> >> Stanbol is an OSGi platform, so if you wish to use it programmatically
>> >> via the Java APIs, the natural way to do so is that you package your
>> >> code into a JAR file that is also an OSGi bundle [1], install it on a
>> >> running Stanbol launcher using its OSGi console and activate it.
>> >>
>> >> Of course, at development time you will need access to the Java APIs of
>> >> the Stanbol components. Most of the time, these are made available as
>> >> distinct packages called org.apache.stanbol.{component-name}.servicesapi
>> >> (example: org.apache.stanbol.enhancer.servicesapi). When developing in
>> >> Eclipse or NetBeans etc. you will then include the JAR file of this
>> >> servicesapi in your classpath.
>> >>
>> >> To do unit testing, you will most likely also need the reference
>> >> implementations of these serviceapis, which come as separate packages.
>> >> At runtime, instead of using these implementations directly, you can
>> >> refer to the servicesapi interfaces using the OSGi Service Reference
>> >> mechanism [2], and let the embedded Apache Felix do the job of matching
>> >> API and implementation.
>> >>
>> >> I hope this somehow gets you started.
>> >>
>> >> Alessandro
>> >>
>> >> [1] http://www.osgi.org/Specifications
>> >> [2]
>> >>
>> >>
>> http://felix.apache.org/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html
>> >>
>> >>
>> >>
>> >> On 26/09/2014 16:17, Mohammad Ghufran wrote:
>> >>>
>> >>> Hello,
>> >>>
>> >>> Is there a way to use stanbol through Java or some third party API like
>> >>> this one: https://github.com/zaizi/apache-stanbol-client has to be
>> used?
>> >>>
>> >>> In case there is a way, could someone point me to some documentation
>> and
>> >>> maybe some examples? In the latter case, which is the recommended API
>> >>> wrapper?
>> >>>
>> >>> Best Regards,
>> >>> Ghufran
>> >>>
>> >>
>> >> -- The Open University is incorporated by Royal Charter (RC 000391),
>> >> an exempt charity in England & Wales and a charity registered in
>> >> Scotland (SC 038302). The Open University is authorised and regulated
>> >> by the Financial Conduct Authority.
>> >> .
>> >>
>> >
>> > -- The Open University is incorporated by Royal Charter (RC 000391), an
>> > exempt charity in England & Wales and a charity registered in Scotland
>> (SC
>> > 038302). The Open University is authorised and regulated by the Financial
>> > Conduct Authority.
>>
>>
>>
>> --
>> | Rupert Westenthaler rupert.westenthaler@gmail.com
>> | Bodenlehenstraße 11 ++43-699-11108907
>> | A-5500 Bischofshofen
>> | REDLINK.CO
>> ..........................................................................
>> | http://redlink.co/
>>
--
| Rupert Westenthaler rupert.westenthaler@gmail.com
| Bodenlehenstraße 11 ++43-699-11108907
| A-5500 Bischofshofen
| REDLINK.CO ..........................................................................
| http://redlink.co/
Re: JAVA API
Posted by Mohammad Ghufran <em...@gmail.com>.
Hello,
Thank you for the responses and sorry for getting back at this so late.
I've already seen this API documentation but it has no info on how to use
it inside a standalone java project. Allesandro, I am open to using maven
too, but I don't know how to make the maven installation of stanbol inside
eclipse (I am a beginner at Java). If there is some resource available for
helping with info on this setup, or if you can shed some light on this, it
would be great!
I don't think converting my existing app to OSGi would be possible (or
practical).
For the method of including the jar files, I should just add all of the jar
files of components that I need as references to my project? I don't
understand, conceptually, how it would make my standalone project
communicate with the Felix server running the different chains.
Thank you again for your responses and help!
Best Regards,
Ghufran
Mohammad Ghufran
On Sun, Sep 28, 2014 at 4:31 PM, Rupert Westenthaler <
rupert.westenthaler@gmail.com> wrote:
> Hi
>
> For the Stanbol Enhancer please have a look on the documentation [1]
> on the webpage.
>
> For API usage of the Stanbol Enhancer you need the following OSGI Services:
>
> * ContentItemFactory: create ContentItems for InputStreams, Strings
> and/or ByteArrays
> * ChainManager: Allows to lookup configured chains
> * EnhancementJobManager: the interface used to enhance ContentItems
>
> best
> Rupert
>
>
>
> [1]
> http://stanbol.apache.org/docs/trunk/components/enhancer/#main-interfaces-and-utility-classes
>
> On Fri, Sep 26, 2014 at 5:41 PM, Alessandro Adamou
> <al...@open.ac.uk> wrote:
> > I should mention that of course you will need to know how to use the
> > APIs. Javadoc is available as a separate archive for every bundle. For
> > example, to get the Javadoc of the Enhancer, you will go to:
> >
> >
> http://central.maven.org/maven2/org/apache/stanbol/org.apache.stanbol.enhancer.servicesapi/0.12.0/
> >
> > and download the file called
> > org.apache.stanbol.enhancer.servicesapi-0.12.0-javadoc.jar
> >
> > Eventually, the Javadoc will be available in HTML on the project page,
> > see http://issues.apache.org/jira/browse/STANBOL-578
> >
> > I'm writing all this assuming you are not using Maven. If you are, or
> > course you do not need to manually download any JAR and have to proceed
> > differently. Just let us know if you do.
> >
> > HTH
> >
> > Alessandro
> >
> >
> >
> > On 26/09/2014 16:32, Alessandro Adamou wrote:
> >>
> >> Hi Ghufran,
> >>
> >> Stanbol is an OSGi platform, so if you wish to use it programmatically
> >> via the Java APIs, the natural way to do so is that you package your
> >> code into a JAR file that is also an OSGi bundle [1], install it on a
> >> running Stanbol launcher using its OSGi console and activate it.
> >>
> >> Of course, at development time you will need access to the Java APIs of
> >> the Stanbol components. Most of the time, these are made available as
> >> distinct packages called org.apache.stanbol.{component-name}.servicesapi
> >> (example: org.apache.stanbol.enhancer.servicesapi). When developing in
> >> Eclipse or NetBeans etc. you will then include the JAR file of this
> >> servicesapi in your classpath.
> >>
> >> To do unit testing, you will most likely also need the reference
> >> implementations of these serviceapis, which come as separate packages.
> >> At runtime, instead of using these implementations directly, you can
> >> refer to the servicesapi interfaces using the OSGi Service Reference
> >> mechanism [2], and let the embedded Apache Felix do the job of matching
> >> API and implementation.
> >>
> >> I hope this somehow gets you started.
> >>
> >> Alessandro
> >>
> >> [1] http://www.osgi.org/Specifications
> >> [2]
> >>
> >>
> http://felix.apache.org/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html
> >>
> >>
> >>
> >> On 26/09/2014 16:17, Mohammad Ghufran wrote:
> >>>
> >>> Hello,
> >>>
> >>> Is there a way to use stanbol through Java or some third party API like
> >>> this one: https://github.com/zaizi/apache-stanbol-client has to be
> used?
> >>>
> >>> In case there is a way, could someone point me to some documentation
> and
> >>> maybe some examples? In the latter case, which is the recommended API
> >>> wrapper?
> >>>
> >>> Best Regards,
> >>> Ghufran
> >>>
> >>
> >> -- The Open University is incorporated by Royal Charter (RC 000391),
> >> an exempt charity in England & Wales and a charity registered in
> >> Scotland (SC 038302). The Open University is authorised and regulated
> >> by the Financial Conduct Authority.
> >> .
> >>
> >
> > -- The Open University is incorporated by Royal Charter (RC 000391), an
> > exempt charity in England & Wales and a charity registered in Scotland
> (SC
> > 038302). The Open University is authorised and regulated by the Financial
> > Conduct Authority.
>
>
>
> --
> | Rupert Westenthaler rupert.westenthaler@gmail.com
> | Bodenlehenstraße 11 ++43-699-11108907
> | A-5500 Bischofshofen
> | REDLINK.CO
> ..........................................................................
> | http://redlink.co/
>
Re: JAVA API
Posted by Rupert Westenthaler <ru...@gmail.com>.
Hi
For the Stanbol Enhancer please have a look on the documentation [1]
on the webpage.
For API usage of the Stanbol Enhancer you need the following OSGI Services:
* ContentItemFactory: create ContentItems for InputStreams, Strings
and/or ByteArrays
* ChainManager: Allows to lookup configured chains
* EnhancementJobManager: the interface used to enhance ContentItems
best
Rupert
[1] http://stanbol.apache.org/docs/trunk/components/enhancer/#main-interfaces-and-utility-classes
On Fri, Sep 26, 2014 at 5:41 PM, Alessandro Adamou
<al...@open.ac.uk> wrote:
> I should mention that of course you will need to know how to use the
> APIs. Javadoc is available as a separate archive for every bundle. For
> example, to get the Javadoc of the Enhancer, you will go to:
>
> http://central.maven.org/maven2/org/apache/stanbol/org.apache.stanbol.enhancer.servicesapi/0.12.0/
>
> and download the file called
> org.apache.stanbol.enhancer.servicesapi-0.12.0-javadoc.jar
>
> Eventually, the Javadoc will be available in HTML on the project page,
> see http://issues.apache.org/jira/browse/STANBOL-578
>
> I'm writing all this assuming you are not using Maven. If you are, or
> course you do not need to manually download any JAR and have to proceed
> differently. Just let us know if you do.
>
> HTH
>
> Alessandro
>
>
>
> On 26/09/2014 16:32, Alessandro Adamou wrote:
>>
>> Hi Ghufran,
>>
>> Stanbol is an OSGi platform, so if you wish to use it programmatically
>> via the Java APIs, the natural way to do so is that you package your
>> code into a JAR file that is also an OSGi bundle [1], install it on a
>> running Stanbol launcher using its OSGi console and activate it.
>>
>> Of course, at development time you will need access to the Java APIs of
>> the Stanbol components. Most of the time, these are made available as
>> distinct packages called org.apache.stanbol.{component-name}.servicesapi
>> (example: org.apache.stanbol.enhancer.servicesapi). When developing in
>> Eclipse or NetBeans etc. you will then include the JAR file of this
>> servicesapi in your classpath.
>>
>> To do unit testing, you will most likely also need the reference
>> implementations of these serviceapis, which come as separate packages.
>> At runtime, instead of using these implementations directly, you can
>> refer to the servicesapi interfaces using the OSGi Service Reference
>> mechanism [2], and let the embedded Apache Felix do the job of matching
>> API and implementation.
>>
>> I hope this somehow gets you started.
>>
>> Alessandro
>>
>> [1] http://www.osgi.org/Specifications
>> [2]
>>
>> http://felix.apache.org/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html
>>
>>
>>
>> On 26/09/2014 16:17, Mohammad Ghufran wrote:
>>>
>>> Hello,
>>>
>>> Is there a way to use stanbol through Java or some third party API like
>>> this one: https://github.com/zaizi/apache-stanbol-client has to be used?
>>>
>>> In case there is a way, could someone point me to some documentation and
>>> maybe some examples? In the latter case, which is the recommended API
>>> wrapper?
>>>
>>> Best Regards,
>>> Ghufran
>>>
>>
>> -- The Open University is incorporated by Royal Charter (RC 000391),
>> an exempt charity in England & Wales and a charity registered in
>> Scotland (SC 038302). The Open University is authorised and regulated
>> by the Financial Conduct Authority.
>> .
>>
>
> -- The Open University is incorporated by Royal Charter (RC 000391), an
> exempt charity in England & Wales and a charity registered in Scotland (SC
> 038302). The Open University is authorised and regulated by the Financial
> Conduct Authority.
--
| Rupert Westenthaler rupert.westenthaler@gmail.com
| Bodenlehenstraße 11 ++43-699-11108907
| A-5500 Bischofshofen
| REDLINK.CO ..........................................................................
| http://redlink.co/
Re: JAVA API
Posted by Alessandro Adamou <al...@open.ac.uk>.
I should mention that of course you will need to know how to use the
APIs. Javadoc is available as a separate archive for every bundle. For
example, to get the Javadoc of the Enhancer, you will go to:
http://central.maven.org/maven2/org/apache/stanbol/org.apache.stanbol.enhancer.servicesapi/0.12.0/
and download the file called
org.apache.stanbol.enhancer.servicesapi-0.12.0-javadoc.jar
Eventually, the Javadoc will be available in HTML on the project page,
see http://issues.apache.org/jira/browse/STANBOL-578
I'm writing all this assuming you are not using Maven. If you are, or
course you do not need to manually download any JAR and have to proceed
differently. Just let us know if you do.
HTH
Alessandro
On 26/09/2014 16:32, Alessandro Adamou wrote:
> Hi Ghufran,
>
> Stanbol is an OSGi platform, so if you wish to use it programmatically
> via the Java APIs, the natural way to do so is that you package your
> code into a JAR file that is also an OSGi bundle [1], install it on a
> running Stanbol launcher using its OSGi console and activate it.
>
> Of course, at development time you will need access to the Java APIs of
> the Stanbol components. Most of the time, these are made available as
> distinct packages called org.apache.stanbol.{component-name}.servicesapi
> (example: org.apache.stanbol.enhancer.servicesapi). When developing in
> Eclipse or NetBeans etc. you will then include the JAR file of this
> servicesapi in your classpath.
>
> To do unit testing, you will most likely also need the reference
> implementations of these serviceapis, which come as separate packages.
> At runtime, instead of using these implementations directly, you can
> refer to the servicesapi interfaces using the OSGi Service Reference
> mechanism [2], and let the embedded Apache Felix do the job of matching
> API and implementation.
>
> I hope this somehow gets you started.
>
> Alessandro
>
> [1] http://www.osgi.org/Specifications
> [2]
> http://felix.apache.org/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html
>
>
>
> On 26/09/2014 16:17, Mohammad Ghufran wrote:
>> Hello,
>>
>> Is there a way to use stanbol through Java or some third party API like
>> this one: https://github.com/zaizi/apache-stanbol-client has to be used?
>>
>> In case there is a way, could someone point me to some documentation and
>> maybe some examples? In the latter case, which is the recommended API
>> wrapper?
>>
>> Best Regards,
>> Ghufran
>>
>
> -- The Open University is incorporated by Royal Charter (RC 000391),
> an exempt charity in England & Wales and a charity registered in
> Scotland (SC 038302). The Open University is authorised and regulated
> by the Financial Conduct Authority.
> .
>
-- The Open University is incorporated by Royal Charter (RC 000391), an exempt charity in England & Wales and a charity registered in Scotland (SC 038302). The Open University is authorised and regulated by the Financial Conduct Authority.
Re: JAVA API
Posted by Alessandro Adamou <al...@open.ac.uk>.
Hi Ghufran,
Stanbol is an OSGi platform, so if you wish to use it programmatically
via the Java APIs, the natural way to do so is that you package your
code into a JAR file that is also an OSGi bundle [1], install it on a
running Stanbol launcher using its OSGi console and activate it.
Of course, at development time you will need access to the Java APIs of
the Stanbol components. Most of the time, these are made available as
distinct packages called org.apache.stanbol.{component-name}.servicesapi
(example: org.apache.stanbol.enhancer.servicesapi). When developing in
Eclipse or NetBeans etc. you will then include the JAR file of this
servicesapi in your classpath.
To do unit testing, you will most likely also need the reference
implementations of these serviceapis, which come as separate packages.
At runtime, instead of using these implementations directly, you can
refer to the servicesapi interfaces using the OSGi Service Reference
mechanism [2], and let the embedded Apache Felix do the job of matching
API and implementation.
I hope this somehow gets you started.
Alessandro
[1] http://www.osgi.org/Specifications
[2]
http://felix.apache.org/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.html
On 26/09/2014 16:17, Mohammad Ghufran wrote:
> Hello,
>
> Is there a way to use stanbol through Java or some third party API like
> this one: https://github.com/zaizi/apache-stanbol-client has to be used?
>
> In case there is a way, could someone point me to some documentation and
> maybe some examples? In the latter case, which is the recommended API
> wrapper?
>
> Best Regards,
> Ghufran
>
-- The Open University is incorporated by Royal Charter (RC 000391), an exempt charity in England & Wales and a charity registered in Scotland (SC 038302). The Open University is authorised and regulated by the Financial Conduct Authority.