Difference between revisions of "Java Examples"

From BaseX Documentation
Jump to navigation Jump to search
Line 16: Line 16:
  
 
==Server Examples==
 
==Server Examples==
 +
 +
The examples below take advantage of the client/server architecture:
  
 
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerCommands.java ServerCommands.java]<br/>launches server-side commands using a client session.
 
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerCommands.java ServerCommands.java]<br/>launches server-side commands using a client session.
Line 21: Line 23:
 
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerConcurrency.java ServerConcurrency.java]<br/>runs concurrent queries.
 
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerConcurrency.java ServerConcurrency.java]<br/>runs concurrent queries.
 
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerQueries.java ServerQueries.java]<br/>shows how iterative queries can be performed.
 
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerQueries.java ServerQueries.java]<br/>shows how iterative queries can be performed.
 +
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerEventsGUI.java ServerEventsGUI.java]<br/>is a little GUI example for demonstrating database events.
 
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/UserExample.java UserExample.java]<br/>manages database users.
 
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/UserExample.java UserExample.java]<br/>manages database users.
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerEventsGUI.java ServerEventsGUI.java]<br/>is a little GUI example for demonstrating database events.
 
  
 
==XQuery Module Examples==
 
==XQuery Module Examples==

Revision as of 08:45, 10 June 2013

This page is part of the Developer Section. The following Java code snippets demonstrate how easy it is to run database commands, create collections, perform queries, etc. by integrating the BaseX code. Most examples are taken from our basex-examples repository, in which you will find some more use cases.

Local Examples

The following code snippets do not require any server instance:

Server Examples

The examples below take advantage of the client/server architecture:

XQuery Module Examples

  • FruitsExample.java
    demonstrates how Java classes can be imported as XQuery modules.
  • FruitsModule.java
    is a simple demo module called by FruitsExample.
  • ModuleDemo.java
    is a simple XQuery demo module that demonstrates how XQuery items can be processed from Java. It is derived from the QueryModule class.
  • QueryModule.java
    is located in the BaseX core. Java query modules can extend this class to get access to the current query context and enrich functions with properties (see more).
 

XQJ API

The implementation of the BaseX XQJ API (closed-source) has been written by Charles Foster. It uses the client/server architecture. The basex-examples repository contains various examples on how to use XQJ.

Client API

REST API

XML:DB API (deprecated)

Note that the XML:DB API does not talk to the server and can thus only be used in embedded mode.