org.kie.workbench.common.dmn.api.editors.included

Interface DMNIncludedModelsService

public interface DMNIncludedModelsService

This service handles calls related to included DMN models.

Method Summary

Modifier and Type	Method and Description
List<ItemDefinition>	loadItemDefinitionsByNamespace(org.guvnor.common.services.project.model.WorkspaceProject workspaceProject, String modelName, String namespace) This method finds the list of ItemDefinitions for a given namespace.
List<IncludedModel>	loadModels(org.uberfire.backend.vfs.Path path, org.guvnor.common.services.project.model.WorkspaceProject workspaceProject) This method loads all models (DMN and PMML) from a given project.
List<DMNIncludedNode>	loadNodesFromImports(org.guvnor.common.services.project.model.WorkspaceProject workspaceProject, List<DMNIncludedModel> includedModels) This method loads all DMN nodes for the included DMN models.
List<PMMLDocumentMetadata>	loadPMMLDocumentsFromImports(org.uberfire.backend.vfs.Path path, org.guvnor.common.services.project.model.WorkspaceProject workspaceProject, List<PMMLIncludedModel> includedModels) This method loads all PMML documents for the included PMML models.

Method Detail

loadModels

List<IncludedModel> loadModels(org.uberfire.backend.vfs.Path path,
                               org.guvnor.common.services.project.model.WorkspaceProject workspaceProject)

This method loads all models (DMN and PMML) from a given project.

Parameters:

path - Path of the DMN file being edited.

workspaceProject - represents the project that will be scanned.

Returns:

all IncludedModels from a given project.

loadNodesFromImports

List<DMNIncludedNode> loadNodesFromImports(org.guvnor.common.services.project.model.WorkspaceProject workspaceProject,
                                           List<DMNIncludedModel> includedModels)

This method loads all DMN nodes for the included DMN models.

Parameters:

workspaceProject - represents the project that will be scanned.

includedModels - represents all DMN imports that provide the list of nodes.

Returns:

a list of DMNIncludedNodes.

loadPMMLDocumentsFromImports

List<PMMLDocumentMetadata> loadPMMLDocumentsFromImports(org.uberfire.backend.vfs.Path path,
                                                        org.guvnor.common.services.project.model.WorkspaceProject workspaceProject,
                                                        List<PMMLIncludedModel> includedModels)

This method loads all PMML documents for the included PMML models.

Parameters:

path - Path of the DMN file being edited.

workspaceProject - represents the project that will be scanned.

includedModels - represents all PMML imports that provide the list of nodes.

Returns:

a list of PMMLDocumentMetadatas.

loadItemDefinitionsByNamespace

List<ItemDefinition> loadItemDefinitionsByNamespace(org.guvnor.common.services.project.model.WorkspaceProject workspaceProject,
                                                    String modelName,
                                                    String namespace)

This method finds the list of ItemDefinitions for a given namespace.

Parameters:

workspaceProject - represents the project that will be scanned.

modelName - is the value used as the prefix for imported ItemDefinitions.

namespace - is the namespace of the model that provides the list of ItemDefinitions.

Returns:

a list of ItemDefinitions.