marcosvidolin/doco

Doco - Document Converter for Google App Engine Search API

 

Languages and Tools:

Connect with me:

doco's Issues

Central maven repo for doco

Could this be published to central maven repository for easy adoption?

Converting Ref<?>s to @DocumentField(type = FieldType.Text)

Can doco deal with Ref and Key fields automatically? If not, how should I specify that values need to be fetched and stored in document?

Id is not required for a Document. The search service can automatically create an identifier

Setting the document identifer is optional. If omitted, the search service will create an identifier.

Constructing search queries with Doco

Is it possible to construct search queries below using Doco?
String queryString = "product: piano AND price < 5000";

Support for Polymorphic types

My hierarchy looks like this:

@DocumentIndex
abstract class X {
@DocumentId
private long id;
}

@DocumentIndex
class Y extends X {
  // some fields
}

I'm trying to create a Document from an instance of class Y like below:

X obj = new Y();
Document advertisementDocument = doco.toDocument(obj);

Above code throws exception:
"com.vidolima.doco.exception.DocumentParseException: No @documentid annotation was found in class com.myapp.Y".

Integration with Objectify

I think we should build Doco on top of Objectify. Converting POJO to Document is necessary but converting Document back to POJO is kind of useless because we don't have all the fields in Document. On the other hand, if we integrate Doco with Objectify, we can do following:

• Convert Ofy Entity (only) to Documents with Entity's Key<?> being the documentId.
• Retrieve entire Entity back by just accessing the key from document (reconstruction is easier).
• Converting various other fields to text (Ref, Set, List, etc) which are good to be searched but can't be reconstructed back into POJO. Since we're using Key to retrieve things back, just one-way conversion (from pojo to doc) is enough.
• Less new annotations to learn if we integrate with Ofy's annotations. (e.g. @entity(enableFullTextSearch=true), etc).

Since, Ofy is used extensively already, we can hope for much higher adoption (and contribution) which will make doco even better.

Let me know your thoughts on this.