File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
http://aspose.com/file-tools
The moose likes Beginning Java and the fly likes how to use a java function based on the given Java API Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Java » Beginning Java
Bookmark "how to use a java function based on the given Java API" Watch "how to use a java function based on the given Java API" New topic
Author

how to use a java function based on the given Java API

cake naiyou
Greenhorn

Joined: Apr 29, 2011
Posts: 27
I am quite new to Java, and need to work on a project requiring using open source software. I am very confusing about understanding those Java API's documentation.
Please refer to the following link, and show me how to use the related java class, RemoteXmlSimpleSearchEngineBase, based on its Java API.

http://download.carrot2.org/stable/javadoc/org/carrot2/source/xml/RemoteXmlSimpleSearchEngineBase.html
Jelle Klap
Bartender

Joined: Mar 10, 2008
Posts: 1763
    
    7

You won't be using it directly, because this is an abstract base class.

A base class for implementing data sources based on XML/XSLT.


If you are actually looking for a concrete usable implementation you should have a look at one of the listed known subclasses, which are EToolsDocumentSource, GoogleDesktopDocumentSource, and SolrDocumentSource.
If you plan to extend it read the API contracts carefully and maybe have a look at the source code of the concrete subclasses for hints on how to proceed.

Build a man a fire, and he'll be warm for a day. Set a man on fire, and he'll be warm for the rest of his life.
Kurt Van Etten
Ranch Hand

Joined: Sep 07, 2010
Posts: 98
Just to add a little more to what Jelle said, API docs can be pretty indecipherable when you look at them without any context. I would start by reading through the Carrot2 documentation on this page. Once you have an overview of what the package can do and have examined some code examples, then the specific classes and methods in the API docs should make a lot more sense.
Campbell Ritchie
Sheriff

Joined: Oct 13, 2005
Posts: 38765
    
  23
Welcome to the Ranch

Note Kurt van Etten has found the handbook you need, as I mentioned when I moved your other post.
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: how to use a java function based on the given Java API