Package org.imixs.workflow.dataview

Class DataViewService

java.lang.Object

org.imixs.workflow.dataview.DataViewService

All Implemented Interfaces:

Serializable

public class DataViewService
extends Object
implements Serializable

The OpenAIAPIService provides methods to post prompt templates to the OpenAI API supported by Llama-cpp http server. The service supports various processing events to update a prompt template and to evaluate a completion result

Author:

rsoika

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected jakarta.enterprise.event.Event<DataViewExportEvent>	dataViewExportEvents
protected org.imixs.workflow.engine.DocumentService	documentService
static final String	ERROR_API
static final String	ERROR_CONFIG
static final String	ERROR_MISSING_DATA
static final String	ITEM_WORKITEMREF
static final int	MAX_ROWS
protected org.imixs.archive.core.SnapshotService	snapshotService
protected org.imixs.workflow.engine.WorkflowService	workflowService

Constructor Summary

Constructors

Constructor	Description
DataViewService()

Method Summary

Modifier and Type	Method	Description
List<org.imixs.workflow.ItemCollection>	computeDataViewItemDefinitions(org.imixs.workflow.ItemCollection dataViewDefinition)	Returns a List of ItemCollection instances representing the view column description.
org.imixs.workflow.ItemCollection	loadDataViewDefinition(String dataView)	This method loads a DataView Definition for a given dataview
org.imixs.workflow.FileData	loadTemplate(org.imixs.workflow.ItemCollection dataViewDefinition)	This method returns the first excel poi template from the Data Definition
void	poiExport(List<org.imixs.workflow.ItemCollection> dataset, org.imixs.workflow.ItemCollection dataViewDefinition, List<org.imixs.workflow.ItemCollection> viewItemDefinitions, org.imixs.workflow.FileData fileData)	The method exports a dataset into a a POI XSSFWorkbook.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ITEM_WORKITEMREF

public static final String ITEM_WORKITEMREF

See Also:

• Constant Field Values

MAX_ROWS

public static final int MAX_ROWS

See Also:

• Constant Field Values

ERROR_API

public static final String ERROR_API

See Also:

• Constant Field Values

ERROR_CONFIG

public static final String ERROR_CONFIG

See Also:

• Constant Field Values

ERROR_MISSING_DATA

public static final String ERROR_MISSING_DATA

See Also:

• Constant Field Values

workflowService

@Inject
protected org.imixs.workflow.engine.WorkflowService workflowService

documentService

@Inject
protected org.imixs.workflow.engine.DocumentService documentService

snapshotService

@Inject
protected org.imixs.archive.core.SnapshotService snapshotService

dataViewExportEvents

@Inject
protected jakarta.enterprise.event.Event<DataViewExportEvent> dataViewExportEvents

Constructor Details

DataViewService

public DataViewService()

Method Details

loadDataViewDefinition

public org.imixs.workflow.ItemCollection loadDataViewDefinition(String dataView)

This method loads a DataView Definition for a given dataview

Parameters:

dataView - - name of a dataview

Returns:

ItemCollection

computeDataViewItemDefinitions

public List<org.imixs.workflow.ItemCollection> computeDataViewItemDefinitions(org.imixs.workflow.ItemCollection dataViewDefinition)

Returns a List of ItemCollection instances representing the view column description. Each column has the items: name,label,format,convert

Parameters:

dataViewDefinition -

Returns:

loadTemplate

public org.imixs.workflow.FileData loadTemplate(org.imixs.workflow.ItemCollection dataViewDefinition)
                                         throws org.imixs.workflow.exceptions.PluginException

This method returns the first excel poi template from the Data Definition

Parameters:

dataViewDefinition - with the attached fileData

Throws:

org.imixs.workflow.exceptions.PluginException - if no template was found

poiExport

public void poiExport(List<org.imixs.workflow.ItemCollection> dataset,
 org.imixs.workflow.ItemCollection dataViewDefinition,
 List<org.imixs.workflow.ItemCollection> viewItemDefinitions,
 org.imixs.workflow.FileData fileData)
               throws org.imixs.workflow.exceptions.PluginException

The method exports a dataset into a a POI XSSFWorkbook. The Workbook is loaded from a template data in a dataViewDefinition.

The export method sends a DataViewExportEvent. An observer CID bean can implement alternative exporters. With the event property 'completed' a client can signal that the export process is completed. Otherwise the default behavior will be adapted.

Throws:

org.imixs.workflow.exceptions.PluginException