Getting Started with the API
The Model Manager API for use with the Java® programming language enables you to perform various tasks in a Model Manager database by writing and running custom code. Many of the Model Manager Tools available from the COMSOL Desktop have direct counterparts in the form of methods in the API. There is even functionality in the API that enables you to perform tasks that are not possible in the COMSOL Desktop. You can use the Model Manager API in the Application Builder’s Method Editor, from a standalone Java® application, and from the LiveLink™ for MATLAB® interface.
The Model Manager API is not available when running an application via COMSOL Server™ or in a standalone application compiled using COMSOL Compiler™.
If the Enforce security restrictions check box is selected on the Security>Methods and Java Libraries page in the Preferences dialog box, you must select Allow access to Model Manager databases to allow the use of the Model Manager API.
The Java documentation for all types and methods in the Model Manager API is available at https://doc.comsol.com — see COMSOL API for use with Java®>Java Documentation at the bottom of the page.
All code examples in this and other sections are written in a method editor window in the Application Builder workspace. You may need to adapt the code if used in another context.
In this section:
•
Accessing the Model Manager API
•
Connecting to Model Manager Databases
•
Navigating a Model Manager Database
•
Reading Settings
•
Creating and Updating Database Objects
•
Advanced Database Operations Using Parameter Objects
•
Querying Database Objects