InterSystems Learning Services| InterSystems

You are viewing as a ‘Guest’.

Topic outline

Java QuickStart
Java QuickStart
The InterSystems® JDBC driver supports three lightweight Java APIs that provide direct access to InterSystems IRIS databases via relational tables, objects, or multidimensional storage.

Java features available in InterSystems IRIS include:

Relational access through the JDBC API

Object access through the InterSystems XEP API

Access to multidimensional storage through the InterSystems Native API

Multi-model access to use multiple APIs together

Support for third-party APIs such as Hibernate

An underlying consistent structure, avoiding data duplication

Watch the video, then try the exercise below!
Collapse all Expand all
Try It
Try It
With Java, you can interact with InterSystems IRIS relationally (with JDBC), using objects (with XEP or Hibernate), or natively (with the Native API). In the steps below, you will access a set of sample stock data using each of the ways described.

Start the exercise in one of three ways:

Use an InterSystems IRIS Learning Lab by clicking the launcher below.

Use AWS, Azure, or GCP, first following the steps to change the password for InterSystems IRIS.

Try the exercise locally with an instance of InterSystems IRIS and an IDE that supports Java (such as Eclipse).
- You must be logged in to launch an InterSystems IRIS instance.
  
  Log in with your existing account.
  
  Don't have an InterSystems account? Create a new account.
- Set up
  
  Load sample stock data into InterSystems IRIS:
  
  If you are using InterSystems Learning Labs, the data is already loaded. Continue to Step 2.
  
  If you have your own instance:
  
  Clone or download this repository: https://github.com/intersystems/Samples-Stock-Data. This repository has a folder named data, which contains all files needed to load the sample stock data.
  
  In the Management Portal, navigate to System Explorer > Classes and import DemoStockCls.xml and StocksUtil.xml files into the USER namespace from the data folder.
  
  In the InterSystems IRIS Terminal, type the following command. Replace repo_home with the directory of Sample-Stock-Data repo that you recently cloned:
  do ##class(Demo.Stock).LoadData("repo_home/data/all_stocks_1yr.csv")
  
  To get the sample Java code, download or clone the following repo into your IDE:
  git clone -b try-iris http://github.com/intersystems/quickstarts-java
  
  With Eclipse:
  
  Select File > Import > Git > Projects from Git. Click Next.
  
  Enter URI: https://github.com/intersystems/quickstarts-java
  
  Select the master branch. Click Next.
  
  Choose import existing project. Click Next.
  
  Click Finish.
  
  Open config.txt file, located inside the Solutions package, and modify the IP and password to be the correct values for your InterSystems IRIS instance. Port and username are most likely the defaults but you can verify those as well.
  
  Save the sample code in your IDE. You should now have several classes for JDBC, XEP, Native API, and multi-model.
  
  If you are using an InterSystems Learning Lab, correct the credentials in the config.txt file. Change the value of the IP address from localhost to the InterSystems IP that is provided when you launch the Learning Lab. On the next line, change the value of port to the InterSystems 1972 Port provided.
- Use the standard JDBC API for SQL-based access to relational tables
  
  Open jdbcplaystocksTask7.java to view the JDBC code. You will notice the connection string uses these variables to connect:
  
  String dbUrl = protocol + ip + ":" + port + "/" + namespace;
  
  Run jdbcplaystocksTask7.java:
  Begin code:
  cd /home/project/quickstarts-java/src
  javac -cp ".:../lib/intersystems-jdbc-3.2.0.jar" jdbcplaystocksTask7.java
  java -cp ".:../lib/intersystems-jdbc-3.2.0.jar" jdbcplaystocksTask7
  End code.
  
  This code simulates a stock trading application, allowing you to manage your personal portfolio and see how you would have done selling on a particular date.
  Run option 1: View the top 10 stocks on 2016-08-12.
  Run option 2: Create the Portfolio table.
  Run option 3: Add three new portfolio items (for AMZN, GOOGL, and EQIX) using a value between the opening and closing price on 2016-08-12.
  Run option 6: Then, see how much you would have made on your portfolio if selling on 2017-08-10.
  Run option 7: Quit.
  
  This code uses standard JDBC to create, read, update, and delete data within InterSystems IRIS. With the InterSystems IRIS driver, you can easily connect and use JDBC in the way you expect.
  
  Use XEP for high performance, real-time object insertions
  
  Open xepplaystocksTask6.java to view the XEP code. You will notice the connection string uses these variables to connect:
  
  xepPersister.connect(ip, port, namespace, username, password);
  
  Run xepplaystocksTask6.java:
  Begin code:
  cd /home/project/quickstarts-java/src
  javac -cp ".:../lib/intersystems-jdbc-3.2.0.jar:../lib/intersystems-xep-3.2.0.jar" xepplaystocksTask6.java
  java -cp ".:../lib/intersystems-jdbc-3.2.0.jar:../lib/intersystems-xep-3.2.0.jar" xepplaystocksTask6
  End code.
  
  This code simulates real-time stock trades.
  Run option 1: Make a sample trade. For example, trade two shares on 2016-08-12 for $300/share, using your own name as the trade.
  Run option 2: Save this trade.
  Run option 3: Generate 500 generic trades.
  Run option 5: Retrieve the trade objects from the database.
  Run option 6: Retrieve the trade objects from the database again and update the names to prepend NYSE- to each stock name.
  Run option 7: Quit.
  
  With XEP, you can efficiently stores objects directly to InterSystems IRIS, requiring no translation to rows.
  
  Use the Native API to store to a custom structure and call InterSystems IRIS methods or routines
  
  Open nativeplaystocksTask5.java to view the Native API code. You will notice the connection string uses these variables to connect:
  
  String dbUrl = protocol + ip + ":" + port + "/" + namespace;
  
  Notice this code uses the standard JDBC connection.
  
  Run nativeplaystocksTask5.java:
  Begin code:
  cd /home/project/quickstarts-java/src
  javac -cp ".:../lib/intersystems-jdbc-3.2.0.jar" nativeplaystocksTask5.java
  java -cp ".:../lib/intersystems-jdbc-3.2.0.jar" nativeplaystocksTask5
  End code.
  
  This code stores stock data in a custom data structure.
  Run option 2: Store the stock data in a custom structure.
  Run option 3: Retrieve and view the stock data from this custom structure.
  Run option 4: Call population methods within InterSystems IRIS to generate better information for trades (as seen in the XEP example above).
  Run option 5: Print the version of IRIS to the screen. This is retrieved by calling a routine within InterSystems IRIS.
  Run option 6: Quit.
  
  With the Native API, you can efficiently store data in your own custom data structure, allowing you to answer questions you could not answer using tables or objects. Additionally, you can call class methods and routines from within InterSystems IRIS using the Native API.
  
  Use JDBC, XEP, and Native access side-by-side, choosing the best model for each task
  
  Open multimodelplaystocksTask4.java to see how all APIs work together. You will notice the connection string uses these variables to connect:
  
  xepPersister.connect(ip, port, namespace, username, password);
  
  Notice this code connects using the XEP connection. Since EventPersister inherits from IRISConnection, all ways to connect leverage the same underlying connection to InterSystems IRIS.
  
  Run multimodelplaystocksTask4.java:
  Begin code:
  cd /home/project/quickstarts-java/src
  javac -cp ".:../lib/intersystems-jdbc-3.2.0.jar:../lib/intersystems-xep-3.2.0.jar" multimodelplaystocksTask4.java
  java -cp ".:../lib/intersystems-jdbc-3.2.0.jar:../lib/intersystems-xep-3.2.0.jar" multimodelplaystocksTask4
  End code.
  
  This code stores stock company information.
  JDBC is used to quickly retrieve all distinct stock names from the Demo.Stock table.
  Native API is used to call population methods within InterSystems IRIS for founder and mission statement.
  XEP is used to store these objects directly to the database, avoiding any translation back to tables.
  
  With InterSystems IRIS, you can use one connection to InterSystems IRIS and use the method that is best for each task, decreasing the time it takes to develop your applications while also increasing your application performance. XEP efficiently stores objects directly to InterSystems IRIS, requiring no translation to rows. It is worth it to mention that JDBC can also be used now to retrieve the data stored using XEP, reducing data redundancy.
What's Next?
What's Next?
- URLConnecting Java Applications to InterSystems Products (2h)
  Build the full application that you saw in this QuickStart, connecting to InterSystems IRIS using multiple APIs.
- URLJava Connectivity Documentation (5m)
  Learn the different options you have for connecting Java applications to InterSystems IRIS.
- URLInterSystems IRIS JDBC Driver Javadocs (5m)
  Refer to this set of documentation to view generated API documentation for the InterSystems JDBC driver.
- Share Your Feedback!
  
  You need an iframe-capable browser to view this.

Topic outline

Java QuickStart

Try It

Set up

Use the standard JDBC API for SQL-based access to relational tables

Use XEP for high performance, real-time object insertions

Use the Native API to store to a custom structure and call InterSystems IRIS methods or routines

Use JDBC, XEP, and Native access side-by-side, choosing the best model for each task

What's Next?

Share Your Feedback!