org.imixs.ml.workflow

Class MLController

java.lang.Object

org.imixs.ml.workflow.MLController

All Implemented Interfaces:

Serializable

@Named(value="mlController")
 @ConversationScoped
public class MLController
extends Object
implements Serializable

The MLController CDI Bean provides Front-End methods for the ml integration. The method getJSON returns a sringified JSON object providing the mls status and ml items.

The method search provides a suggest list searching a phrase within the document content of the current workitem.

Author:

rsoika

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected MLService	mlService
static List<String>	STOP_PHRASE_LIST
protected org.imixs.workflow.faces.data.WorkflowController	workflowController

Constructor Summary

Constructors

Constructor and Description
MLController()

Method Summary

Modifier and Type	Method and Description
static boolean	endsWithSpecialCharacter(String s) This helper method tests if a given string ends with a special character like '&', '
static List<String>	findMatches(String phrase, String _text) Returns a matching text sequences form a search phrase e.g.
static List<String>	findMatchesOld(String phrase, String _text) Deprecated.
String	getMLResult() Returns a JSON object containing the current ml result status and the item names collected by the MLAdatper.
List<String>	getSearchResult()
static int	indexOfStopPhrase(String searchText, int fromIndex) This method finds the earliest stop phrase in a given string.
boolean	isMLItem(String name) This method returns true if the item value for a given item was computed by the MLAdatper
void	reset() This method reset the search and input state.
void	search() This method searches a text phrase within the document content of attached documents.

Methods inherited from class java.lang.Object

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

Field Detail

STOP_PHRASE_LIST

public static List<String> STOP_PHRASE_LIST

workflowController

@Inject
protected org.imixs.workflow.faces.data.WorkflowController workflowController

mlService

@Inject
protected MLService mlService

Constructor Detail

MLController

public MLController()

Method Detail

isMLItem

public boolean isMLItem(String name)

This method returns true if the item value for a given item was computed by the MLAdatper

Parameters:

name -

Returns:

true if the item name contains a ml value

getMLResult

public String getMLResult()

Returns a JSON object containing the current ml result status and the item names collected by the MLAdatper.

 
  {"status":"suggest",
   "items": [
              "_invoicenumber",
              "_invoicetotal"
            ]
  }
 
 

The following stati are defined:

• suggest - not yet confirmed by the user
• confirmed - confirmed by the user
• training - workitem is ready for a training

Returns:

search

public void search()

This method searches a text phrase within the document content of attached documents. The textphrase is extracted from the RequestParamterMap.

JSF Integration: <h:commandScript name="imixsOfficeWorkflow.mlSearch" action= "#{mlController.search()}" rendered="#{mlController!=null}" render= "ml-results" />

JavaScript Example:

 
  imixsOfficeWorkflow.mlSearch({ item: '_invoicenumber' })
  
 

findMatches

public static List<String> findMatches(String phrase,
                                       String _text)

Returns a matching text sequences form a search phrase

e.g. 'cat' is found in 'Catalog'

The method also searches for computed phrases based on the first hit with spaces. The method combines words separated by spaces.

A so called stop-character-phrase indicates the end for a computed phrase. For example more than one space, \n, '. ' or ', '

Parameters:

data -

Returns:

endsWithSpecialCharacter

public static boolean endsWithSpecialCharacter(String s)

This helper method tests if a given string ends with a special character like '&', '.', ',', ...

Parameters:

s -

Returns:

true if a special character was found at the end of the string.

indexOfStopPhrase

public static int indexOfStopPhrase(String searchText,
                                    int fromIndex)

This method finds the earliest stop phrase in a given string.

Stop phrases are more than one space, '. ', ', ', '\n'

Returns:

findMatchesOld

@Deprecated
public static List<String> findMatchesOld(String phrase,
                                                      String _text)

Deprecated.

Returns a matching text sequence form a search phrase

e.g. 'cat' is found in 'Catalog'

The method also searches for computed phrases based on the first hit.

It seems that this kind of problem can not be solved with regex.

Parameters:

data -

Returns:

getSearchResult

public List<String> getSearchResult()

reset

public void reset()

This method reset the search and input state.