7 Working with Design Studio Model Java API

About the Design Studio Model Java API

The Design Studio Model Java API wraps the published Exchange Format XML files produced by Design Studio. When combined with other public Eclipse APIs, the Design Studio Model Java API enables you to extend Design Studio with custom functionality and features. For example, when adding a new action to a Design Studio menu, you can use the Design Studio Model Java API to read information required from the published Exchange Format.

The Design Studio Action Command Examples project includes examples of how to use the Design Studio Model Java API and its utility classes and methods. See "About the design.studio.example.action.command Example Project" for more information. See "Working with the Design Studio Exchange Format" for more information about the Exchange Format.

Table 7-1 lists the top-level packages that you can browse to review Design Studio model information. These packages are located in the design.studio.example.action.command/Plug-in Dependencies folder:

About Design Studio Model Java API Utility Classes and Methods

Design Studio provides a utility class and methods that enable you to work with the information published by the Exchange Format.

The ModelLocator class is a helper class that you use to obtain the Design Studio resource and relation model information from the Exchange Format. You require the ModelLocator class and the following fully qualified class name to extend Design Studio using the Design Studio Model Java API:

oracle.communications.studio.model.modellocator.ModelLocator

The following methods are required when extending Design Studio using the ModelLocator class:

• loadModel

• getRelationTarget

About the loadModel Method

Consider the following when using the loadModel method:

• The loadModel method has the following signature:

  public Model loadModel(final IResource resource)

• You use the loadModel method to load a model referenced by the passed IResource.

• The loadModel method has the following input:

  org.eclipse.core.resources.IResource
  

• The loadModel method has the following output:

  oracle.communications.studio.model.Model
  

About the getRelationTarget Method

Consider the following when using the getRelationTarget method:

• The getRelationTarget method has the following signature:

  public Element getRelationTarget(final Relation relation)

• You use the getRelationTarget method to obtain the model from an element or entity relation.

• The getRelationTarget method has the following input:

  oracle.communications.studio.model.Relation
  

• The getRelationTarget method has the following output:

  oracle.communications.studio.model.Element
  

About the getReferencedBy Method

You can use the getReferencedBy method to find a set of entities that are associated with another entity. For example, you can find all technical actions associated with a specific resource facing service.

Consider the following when using the getReferencedBy method:

• The getReferencedBy method has the following signature:

  public List<Entity> getReferencedBy(final Entity entity)
  

• You use the getReferencedBy method to obtain the all the first-level referenced by and realized entities of given entity.

• The getReferencedBy method has the following input:

  oracle.communications.studio.model.Entity
  

• The getReferencedBy method has the following output:

  List<oracle.communications.studio.model.Entity> 
  

You can use two additional APIs to filter the getReferenceBy method:

• The first API enables you to return a list of entities based on the entity file extension:

  List<Entity> getReferenceBy(Entity entity, String fileExtension)

  For example, if you call:

  getReferenceBy(myEntity, "cmnAction")

  the API returns only the action entities that reference myEntity.

• The second API enables you to return a list of entities based on a list of file extensions:

  List<Entity> getReferenceBy(Entity entity, List<String> fileExtensions)

About Design Studio Model Java API Package Dependencies

Table 7-2 displays the plug-ins that are required in your Eclipse installation when using the Design Studio Model Java API to extend Design Studio.

Dependencies that you configure for a plug-in project are saved in the MANIFEST.MF file. You can configure these dependencies in the Plug-in Manifest editor using the fields on the Dependencies tab or by editing the file directly on the MANIFEST.MF tab.

Open the Design Studio Action Command Example project to review examples that illustrate how dependencies are configured in a plug-in project. See "About the design.studio.example.action.command Example Project" for more information.