org.kie.workbench.common.dmn.api.marshalling

Interface DMNMarshallerImportsHelper<IMPORT,DEFINITIONS,DRGELEMENT,ITEMDEFINITION>

public interface DMNMarshallerImportsHelper<IMPORT,DEFINITIONS,DRGELEMENT,ITEMDEFINITION>

This helper provides methods to handle imports into the DMNMarshaller.

Method Summary

Modifier and Type	Method and Description
org.uberfire.backend.vfs.Path	getDMNModelPath(Metadata metadata, String modelNamespace, String modelName) This method finds the Path of DMN model.
Map<IMPORT,DEFINITIONS>	getImportDefinitions(Metadata metadata, List<IMPORT> imports) This method loads all imported DMN definitions from a list of imports.
List<DRGELEMENT>	getImportedDRGElements(Map<IMPORT,DEFINITIONS> importDefinitions) This method extract a list of DRGELEMENTs from the importDefinitions map.
List<ITEMDEFINITION>	getImportedItemDefinitions(Map<IMPORT,DEFINITIONS> importDefinitions) This method extract a list of ITEMDEFINITION from the importDefinitions map.
List<ITEMDEFINITION>	getImportedItemDefinitionsByNamespace(org.guvnor.common.services.project.model.WorkspaceProject workspaceProject, String modelName, String namespace) This method finds the list of ITEMDEFINITIONs for a given namespace.
Map<IMPORT,String>	getImportXML(Metadata metadata, List<IMPORT> imports) This method loads String of all imported XML files from a list of imports.
Map<IMPORT,PMMLDocumentMetadata>	getPMMLDocuments(Metadata metadata, List<IMPORT> imports) This method loads all imported PMML documents from a list of imports.
Optional<InputStream>	loadPath(org.uberfire.backend.vfs.Path path) This method loads the InputStream from a given Path.

Method Detail

getImportDefinitions

Map<IMPORT,DEFINITIONS> getImportDefinitions(Metadata metadata,
                                             List<IMPORT> imports)

This method loads all imported DMN definitions from a list of imports.

Parameters:

metadata - represents the metadata from the main DMN model.

imports - represent the list of imported files.

Returns:

a map DEFINITIONS indexed by IMPORTs.

getPMMLDocuments

Map<IMPORT,PMMLDocumentMetadata> getPMMLDocuments(Metadata metadata,
                                                  List<IMPORT> imports)

This method loads all imported PMML documents from a list of imports.

Parameters:

metadata - represents the metadata from the main DMN model.

imports - represent the list of imported files.

Returns:

a map PMMLDocumentMetadata indexed by IMPORTs.

getImportXML

Map<IMPORT,String> getImportXML(Metadata metadata,
                                List<IMPORT> imports)

This method loads String of all imported XML files from a list of imports.

Parameters:

metadata - represents the metadata from the main DMN model.

imports - represent the list of imported files.

Returns:

a map String indexed by IMPORTs.

getImportedDRGElements

List<DRGELEMENT> getImportedDRGElements(Map<IMPORT,DEFINITIONS> importDefinitions)

This method extract a list of DRGELEMENTs from the importDefinitions map.

Parameters:

importDefinitions - is a map of DEFINITIONS indexed by IMPORT.

Returns:

a list of imported DRGELEMENTs.

getImportedItemDefinitions

List<ITEMDEFINITION> getImportedItemDefinitions(Map<IMPORT,DEFINITIONS> importDefinitions)

This method extract a list of ITEMDEFINITION from the importDefinitions map.

Parameters:

importDefinitions - is a map of DEFINITIONS indexed by IMPORT.

Returns:

a list of imported ITEMDEFINITIONs.

getImportedItemDefinitionsByNamespace

List<ITEMDEFINITION> getImportedItemDefinitionsByNamespace(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 imported ITEMDEFINITIONs.

getDMNModelPath

org.uberfire.backend.vfs.Path getDMNModelPath(Metadata metadata,
                                              String modelNamespace,
                                              String modelName)

This method finds the Path of DMN model.

Parameters:

metadata - represents the metadata from the a DMN model from the scanned project.

modelNamespace - represents the namespace of the desired DMN model.

modelName - represents the mode name of the desired DMN model.

Returns:

the Path of the desired DMN model.

loadPath

Optional<InputStream> loadPath(org.uberfire.backend.vfs.Path path)

This method loads the InputStream from a given Path.

Parameters:

path - to be loaded.

Returns:

the InputStream when the path is valid, otherwise is returns empty.