# Help with the java documentation page

**URL:** <https://discuss.elastic.co/t/help-with-the-java-documentation-page/7046>\
**Category:** Elasticsearch\
**Created:** [March 18, 2012, 11:58pm UTC](https://discuss.elastic.co/t/help-with-the-java-documentation-page/7046 "2012-03-18T23:58:21Z")\
**Posts on this page:** 8\
**Page:** 1

<div class="post-metadata">

**Author:** ![Dennis](https://avatars.discourse-cdn.com/v4/letter/d/e56c9b/32.png) [@Dennis](https://discuss.elastic.co/u/Dennis)\
**Post date:** [March 18, 2012, 11:58pm UTC](https://discuss.elastic.co/t/help-with-the-java-documentation-page/7046/1 "2012-03-18T23:58:21Z")

</div>

I would like to help edit the content and the english of the Java API.  
I am working with making a JPA style connector that works the same way

- osemManagerFactory issues osemManager to do CRUD/S on the store.  
It'll be a bit crude at first. I will ask questions of Kimchy here to  
get answers, to help my project and understanding of the Java API.

Shay/Kimchy, are you interested in my input on the documentation? Do  
you want me to run it by the community here or straight to a private  
email with you?

Is the community interested in the code for an 'osemManager' a la'  
JPA? Can it be hosted on the site along with Elasticsearch?

---

<div class="post-metadata">

**Author:** ![kimchy](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/kimchy/32/44952_2.png) [@kimchy](https://discuss.elastic.co/u/kimchy)\
**Post date:** [March 20, 2012, 9:57am UTC](https://discuss.elastic.co/t/help-with-the-java-documentation-page/7046/2 "2012-03-20T09:57:23Z")

</div>

Sure, contributing to the documentation would be great!. For the "osem"  
like project, just create a public project on github, we can start from  
there.

On Mon, Mar 19, 2012 at 1:58 AM, Dennis [gearond@gmail.com](mailto:gearond@gmail.com) wrote:

> I would like to help edit the content and the english of the Java API.  
> I am working with making a JPA style connector that works the same way
> 
> - osemManagerFactory issues osemManager to do CRUD/S on the store.  
> It'll be a bit crude at first. I will ask questions of Kimchy here to  
> get answers, to help my project and understanding of the Java API.
> 
> Shay/Kimchy, are you interested in my input on the documentation? Do  
> you want me to run it by the community here or straight to a private  
> email with you?
> 
> Is the community interested in the code for an 'osemManager' a la'  
> JPA? Can it be hosted on the site along with Elasticsearch?

---

<div class="post-metadata">

**Author:** ![Dennis](https://avatars.discourse-cdn.com/v4/letter/d/e56c9b/32.png) [@Dennis](https://discuss.elastic.co/u/Dennis)\
**Post date:** [March 23, 2012, 11:41pm UTC](https://discuss.elastic.co/t/help-with-the-java-documentation-page/7046/3 "2012-03-23T23:41:59Z")

</div>

Hmmm, sorry for long delay on this. Been working 10.5-16 hour days for  
20 in a row. That's why I have Contracted for the 'osemManagerFactory'  
instead of doing it myself, (plus impatience with my own learning  
speed.) The guy is going a good job. At least, from the odesk  
screenshots. I'll post some code someday soon.

About helping with the documentation, I'll do one page first. I've  
started on the first java page. I'll submit it within a week.

On Mar 20, 4:57 am, Shay Banon [kim...@gmail.com](mailto:kim...@gmail.com) wrote:

> Sure, contributing to the documentation would be great!. For the "osem"  
> like project, just create a public project on github, we can start from  
> there.
> 
> On Mon, Mar 19, 2012 at 1:58 AM, Dennis [gear...@gmail.com](mailto:gear...@gmail.com) wrote:
> 
> > I would like to help edit the content and the english of the Java API.  
> > I am working with making a JPA style connector that works the same way
> > 
> > - osemManagerFactory issues osemManager to do CRUD/S on the store.  
> > It'll be a bit crude at first. I will ask questions of Kimchy here to  
> > get answers, to help my project and understanding of the Java API.
> 
> > Shay/Kimchy, are you interested in my input on the documentation? Do  
> > you want me to run it by the community here or straight to a private  
> > email with you?
> 
> > Is the community interested in the code for an 'osemManager' a la'  
> > JPA? Can it be hosted on the site along with Elasticsearch?

---

<div class="post-metadata">

**Author:** ![dadoonet](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/dadoonet/32/137187_2.png) [@dadoonet](https://discuss.elastic.co/u/dadoonet)\
**Post date:** [March 24, 2012, 11:19am UTC](https://discuss.elastic.co/t/help-with-the-java-documentation-page/7046/4 "2012-03-24T11:19:27Z")

</div>

Heya,

Did you gave a look at [https://github.com/aloiscochard/elasticsearch-osem](https://github.com/aloiscochard/elasticsearch-osem)  
[https://github.com/aloiscochard/elasticsearch-osem](https://github.com/aloiscochard/elasticsearch-osem) ?

Alois annotation are very complete and close to Compass OSEM annotations.

David.

De : [elasticsearch@googlegroups.com](mailto:elasticsearch@googlegroups.com) [[mailto:elasticsearch@googlegroups.com](mailto:elasticsearch@googlegroups.com)]  
De la part de Shay Banon  
Envoyé : mardi 20 mars 2012 10:57  
À : [elasticsearch@googlegroups.com](mailto:elasticsearch@googlegroups.com)  
Objet : Re: Help with the java documentation page

Sure, contributing to the documentation would be great!. For the "osem" like  
project, just create a public project on github, we can start from there.

On Mon, Mar 19, 2012 at 1:58 AM, Dennis [gearond@gmail.com](mailto:gearond@gmail.com) wrote:

I would like to help edit the content and the english of the Java API.  
I am working with making a JPA style connector that works the same way

- osemManagerFactory issues osemManager to do CRUD/S on the store.  
It'll be a bit crude at first. I will ask questions of Kimchy here to  
get answers, to help my project and understanding of the Java API.

Shay/Kimchy, are you interested in my input on the documentation? Do  
you want me to run it by the community here or straight to a private  
email with you?

Is the community interested in the code for an 'osemManager' a la'  
JPA? Can it be hosted on the site along with Elasticsearch?

---

<div class="post-metadata">

**Author:** ![Dennis](https://avatars.discourse-cdn.com/v4/letter/d/e56c9b/32.png) [@Dennis](https://discuss.elastic.co/u/Dennis)\
**Post date:** [March 24, 2012, 9:09pm UTC](https://discuss.elastic.co/t/help-with-the-java-documentation-page/7046/5 "2012-03-24T21:09:57Z")

</div>

@David Pilato

Weird! The last time that I looked at that project, it had a note at  
the top, "Warning: Project Abandoned". I don't see that now.

It looks like a good project. I don't see the 'RUD' of CRUD in the  
test application, but it's probably there. One thing that I am  
providing support for is checking the mapping in the index is the same  
mapping that the class was designed for, similar to blah\</  
class\> in the persistence.xml file for JPA.

There'll also be hooks for all CRUD methods both pre and post, via  
annotations, that will allow extra code in the perisisted class to be  
triggered to:  
Check additional fields for uniqueness, if you have them, like  
emails.  
give the ability to do cascading deletes and other more database  
like automatic behaviours.

I am going to look more at that code. I was originally going to use  
it, but it seemed to have that message I spoke about and my poor  
memory says something else wasn't there as a feature.

Anyway, his work is much appreciated, it motivated me to do  
something 🙂

PS, it's coming along fine, my programmer is doing quite well. We'll  
be doing reflection on the JPA annotations of a class or putting our  
own in for the @ID field so that it can be stored. Some other features  
are gelling.

On Mar 24, 6:19 am, "David Pilato" [da...@pilato.fr](mailto:da...@pilato.fr)rote:

> Heya,
> 
> Did you gave a look at [https://github.com/aloiscochard/elasticsearch-osem](https://github.com/aloiscochard/elasticsearch-osem)[GitHub - aloiscochard/elasticsearch-osem: ElasticSearch OSEM](https://github.com/aloiscochard/elasticsearch-osem)?
> 
> Alois annotation are very complete and close to Compass OSEM annotations.
> 
> David.
> 
> De : [elasticsearch@googlegroups.com](mailto:elasticsearch@googlegroups.com) [[mailto:elasticsearch@googlegroups.com](mailto:elasticsearch@googlegroups.com)]  
> De la part de Shay Banon  
> Envoyé : mardi 20 mars 2012 10:57  
> À : [elasticsearch@googlegroups.com](mailto:elasticsearch@googlegroups.com)  
> Objet : Re: Help with the java documentation page
> 
> Sure, contributing to the documentation would be great!. For the "osem" like  
> project, just create a public project on github, we can start from there.
> 
> On Mon, Mar 19, 2012 at 1:58 AM, Dennis [gear...@gmail.com](mailto:gear...@gmail.com) wrote:
> 
> I would like to help edit the content and the english of the Java API.  
> I am working with making a JPA style connector that works the same way
> 
> - osemManagerFactory issues osemManager to do CRUD/S on the store.  
> It'll be a bit crude at first. I will ask questions of Kimchy here to  
> get answers, to help my project and understanding of the Java API.
> 
> Shay/Kimchy, are you interested in my input on the documentation? Do  
> you want me to run it by the community here or straight to a private  
> email with you?
> 
> Is the community interested in the code for an 'osemManager' a la'  
> JPA? Can it be hosted on the site along with Elasticsearch?

---

<div class="post-metadata">

**Author:** ![Dennis](https://avatars.discourse-cdn.com/v4/letter/d/e56c9b/32.png) [@Dennis](https://discuss.elastic.co/u/Dennis)\
**Post date:** [March 25, 2012, 11:25pm UTC](https://discuss.elastic.co/t/help-with-the-java-documentation-page/7046/6 "2012-03-25T23:25:44Z")

</div>

I remember what was the problem last time - the repository does not  
connect . . . and it still doesn't.

[http://orexio.org/~alois/repositories/snapshots](http://orexio.org/~alois/repositories/snapshots)

On Mar 24, 4:09 pm, Dennis [gear...@gmail.com](mailto:gear...@gmail.com) wrote:

> @David Pilato
> 
> Weird! The last time that I looked at that project, it had a note at  
> the top, "Warning: Project Abandoned". I don't see that now.
> 
> It looks like a good project. I don't see the 'RUD' of CRUD in the  
> test application, but it's probably there. One thing that I am  
> providing support for is checking the mapping in the index is the same  
> mapping that the class was designed for, similar to blah\</  
> class\> in the persistence.xml file for JPA.
> 
> There'll also be hooks for all CRUD methods both pre and post, via  
> annotations, that will allow extra code in the perisisted class to be  
> triggered to:  
> Check additional fields for uniqueness, if you have them, like  
> emails.  
> give the ability to do cascading deletes and other more database  
> like automatic behaviours.
> 
> I am going to look more at that code. I was originally going to use  
> it, but it seemed to have that message I spoke about and my poor  
> memory says something else wasn't there as a feature.
> 
> Anyway, his work is much appreciated, it motivated me to do  
> something 🙂
> 
> PS, it's coming along fine, my programmer is doing quite well. We'll  
> be doing reflection on the JPA annotations of a class or putting our  
> own in for the @ID field so that it can be stored. Some other features  
> are gelling.
> 
> On Mar 24, 6:19 am, "David Pilato" [da...@pilato.fr](mailto:da...@pilato.fr)rote:
> 
> > Heya,
> 
> > Did you gave a look at [https://github.com/aloiscochard/elasticsearch-osem](https://github.com/aloiscochard/elasticsearch-osem)[GitHub - aloiscochard/elasticsearch-osem: ElasticSearch OSEM](https://github.com/aloiscochard/elasticsearch-osem)?
> 
> > Alois annotation are very complete and close to Compass OSEM annotations.
> 
> > David.
> 
> > De : [elasticsearch@googlegroups.com](mailto:elasticsearch@googlegroups.com) [[mailto:elasticsearch@googlegroups.com](mailto:elasticsearch@googlegroups.com)]  
> > De la part de Shay Banon  
> > Envoyé : mardi 20 mars 2012 10:57  
> > À : [elasticsearch@googlegroups.com](mailto:elasticsearch@googlegroups.com)  
> > Objet : Re: Help with the java documentation page
> 
> > Sure, contributing to the documentation would be great!. For the "osem" like  
> > project, just create a public project on github, we can start from there.
> 
> > On Mon, Mar 19, 2012 at 1:58 AM, Dennis [gear...@gmail.com](mailto:gear...@gmail.com) wrote:
> 
> > I would like to help edit the content and the english of the Java API.  
> > I am working with making a JPA style connector that works the same way
> > 
> > - osemManagerFactory issues osemManager to do CRUD/S on the store.  
> > It'll be a bit crude at first. I will ask questions of Kimchy here to  
> > get answers, to help my project and understanding of the Java API.
> 
> > Shay/Kimchy, are you interested in my input on the documentation? Do  
> > you want me to run it by the community here or straight to a private  
> > email with you?
> 
> > Is the community interested in the code for an 'osemManager' a la'  
> > JPA? Can it be hosted on the site along with Elasticsearch?

---

<div class="post-metadata">

**Author:** ![dadoonet](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/dadoonet/32/137187_2.png) [@dadoonet](https://discuss.elastic.co/u/dadoonet)\
**Post date:** [March 26, 2012, 12:26pm UTC](https://discuss.elastic.co/t/help-with-the-java-documentation-page/7046/7 "2012-03-26T12:26:50Z")

</div>

Hi Dennis,

In fact, you hit at first my own github repo with the ES Hibernate  
Connector : [GitHub - dadoonet/es-hibernate-connector: Make your Hibernate Search more Elastic ! WARNING : project suspended !](https://github.com/dadoonet/es-hibernate-connector)  
[https://github.com/dadoonet/es-hibernate-connector](https://github.com/dadoonet/es-hibernate-connector)  
I suspended my work on this project for two reasons:

- First Alois started its OSEM work  
[GitHub - aloiscochard/elasticsearch-osem: ElasticSearch OSEM](https://github.com/aloiscochard/elasticsearch-osem)  
[https://github.com/aloiscochard/elasticsearch-osem](https://github.com/aloiscochard/elasticsearch-osem) and better to create  
my own annotations, I started to use Alois's one.
- Then, thinking NoSQL with YesSQL database (and ORM framework) could be a  
nonsense. IMHO, as it's so easy to create JSON from your entities with  
Jackson and it's so easy to push a full JSON document in ES, wiring  
Hibernate and Elasticsearch is not really useful.

But, OSEM annotations still useful. For example, managing mapping with  
Annotations could be very powerful.  
That's one of the reason I started to create an Elasticsearch Maven Plugin  
to generate mappings from Alois OSEM annotations.  
[https://github.com/dadoonet/esmavenplugin](https://github.com/dadoonet/esmavenplugin)  
[https://github.com/dadoonet/esmavenplugin](https://github.com/dadoonet/esmavenplugin)  
But, I did not succeed because of classloading issues (Annotations are not  
visible in Maven classloader ☹ ).

BTW, I started something which is near of your concern.  
It's a Spring factory based on this excellent work :

> <https://github.com/ezbz/projectx/tree/master/org.projectx.elasticsearch>
>
> //github.com/ezbz/projectx/tree/master/org.projectx.elasticsearch

[https://github.com/erezmazor/projectx/tree/master/org.projectx.elasticsearch](https://github.com/erezmazor/projectx/tree/master/org.projectx.elasticsearch)

"My" factory allow to define mappings or settings files in classpath and  
push it automatically at startup.  
Source code is here : [GitHub - dadoonet/spring-elasticsearch: Spring factories for elasticsearch](https://github.com/dadoonet/spring-elasticsearch)  
[https://github.com/dadoonet/spring-elasticsearch](https://github.com/dadoonet/spring-elasticsearch) (with a little  
documentation).  
It's not released yet but I'm using this source code in production (I have  
to update the github repo).  
I have some ideas in mind but not enough time by now to work on it...

I don't know if this will help you but now you have a better picture of the  
OSEM story. 😉

Cheers  
David.

Le 26 mars 2012 à 01:25, Dennis [gearond@gmail.com](mailto:gearond@gmail.com) a écrit :

> I remember what was the problem last time - the repository does not  
> connect . . . and it still doesn't.
> 
> [http://orexio.org/~alois/repositories/snapshots](http://orexio.org/~alois/repositories/snapshots)
> 
> On Mar 24, 4:09 pm, Dennis [gear...@gmail.com](mailto:gear...@gmail.com) wrote:
> 
> > @David Pilato
> > 
> > Weird! The last time that I looked at that project, it had a note at  
> > the top, "Warning: Project Abandoned". I don't see that now.
> > 
> > It looks like a good project. I don't see the 'RUD' of CRUD in the  
> > test application, but it's probably there. One thing that I am  
> > providing support for is checking the mapping in the index is the same  
> > mapping that the class was designed for, similar to blah\</  
> > class\> in the persistence.xml file for JPA.
> > 
> > There'll also be hooks for all CRUD methods both pre and post, via  
> > annotations, that will allow extra code in the perisisted class to be  
> > triggered to:  
> > Check additional fields for uniqueness, if you have them, like  
> > emails.  
> > give the ability to do cascading deletes and other more database  
> > like automatic behaviours.
> > 
> > I am going to look more at that code. I was originally going to use  
> > it, but it seemed to have that message I spoke about and my poor  
> > memory says something else wasn't there as a feature.
> > 
> > Anyway, his work is much appreciated, it motivated me to do  
> > something 🙂
> > 
> > PS, it's coming along fine, my programmer is doing quite well. We'll  
> > be doing reflection on the JPA annotations of a class or putting our  
> > own in for the @ID field so that it can be stored. Some other features  
> > are gelling.
> > 
> > On Mar 24, 6:19 am, "David Pilato" [da...@pilato.fr](mailto:da...@pilato.fr)rote:
> > 
> > > Heya,
> > 
> > > Did you gave a look at  
> > > [https://github.com/aloiscochard/elasticsearch-osem](https://github.com/aloiscochard/elasticsearch-osem)[GitHub - aloiscochard/elasticsearch-osem: ElasticSearch OSEM](https://github.com/aloiscochard/elasticsearch-osem)?
> > 
> > > Alois annotation are very complete and close to Compass OSEM  
> > > annotations.
> > 
> > > David.
> > 
> > > De : [elasticsearch@googlegroups.com](mailto:elasticsearch@googlegroups.com)  
> > > [[mailto:elasticsearch@googlegroups.com](mailto:elasticsearch@googlegroups.com)]  
> > > De la part de Shay Banon  
> > > Envoyé : mardi 20 mars 2012 10:57  
> > > À : [elasticsearch@googlegroups.com](mailto:elasticsearch@googlegroups.com)  
> > > Objet : Re: Help with the java documentation page
> > 
> > > Sure, contributing to the documentation would be great!. For the  
> > > "osem" like  
> > > project, just create a public project on github, we can start from  
> > > there.
> > 
> > > On Mon, Mar 19, 2012 at 1:58 AM, Dennis [gear...@gmail.com](mailto:gear...@gmail.com) wrote:
> > 
> > > I would like to help edit the content and the english of the Java  
> > > API.  
> > > I am working with making a JPA style connector that works the same  
> > > way
> > > 
> > > - osemManagerFactory issues osemManager to do CRUD/S on the store.  
> > > It'll be a bit crude at first. I will ask questions of Kimchy here to  
> > > get answers, to help my project and understanding of the Java API.
> > 
> > > Shay/Kimchy, are you interested in my input on the documentation? Do  
> > > you want me to run it by the community here or straight to a private  
> > > email with you?
> > 
> > > Is the community interested in the code for an 'osemManager' a la'  
> > > JPA? Can it be hosted on the site along with Elasticsearch?

--  
David Pilato  
[http://dev.david.pilato.fr/](http://dev.david.pilato.fr/)  
Twitter : @dadoonet

---

<div class="post-metadata">

**Author:** ![system](https://us1.discourse-cdn.com/elastic/original/3X/1/a/1ac57faf039f6b580b3f104ef42a2a89e41014de.png) [@system](https://discuss.elastic.co/u/system)\
**Post date:** [July 6, 2017, 3:34am UTC](https://discuss.elastic.co/t/help-with-the-java-documentation-page/7046/8 "2017-07-06T03:34:48Z")

</div>


