com.saperion.ngc.resultset

Class ItemAnalyzer

java.lang.Object

com.saperion.ngc.resultset.ItemAnalyzer

public class ItemAnalyzer
extends Object

Utility class used to analyze an item that represents a document.

Constructor Summary

Constructors

Constructor and Description
ItemAnalyzer(DocumentService documentService, SettingsService settingsService) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
ItemAnalyzeResult	analyzeItem(ResultProperties props) Analyze the item.
ItemAnalyzeResult	analyzeItem(ResultProperties props, DocumentId docId) Analyze the item.
ItemAnalyzeResult	analyzeItems(List<ResultProperties> items) Analyzes the items.

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemAnalyzer

public ItemAnalyzer(DocumentService documentService,
            SettingsService settingsService)

Constructor.

Parameters:

documentService - document service

settingsService - settings service

Method Detail

analyzeItem

public ItemAnalyzeResult analyzeItem(ResultProperties props)
                              throws SystemException,
                                     AuthenticationException,
                                     DocumentIdentificationException

Analyze the item.

Parameters:

props - Properties

Returns:

Analyze result

Throws:

DocumentIdentificationException - document identification exception

AuthenticationException - authentication exception

SystemException - system exception

analyzeItem

public ItemAnalyzeResult analyzeItem(ResultProperties props,
                            DocumentId docId)
                              throws SystemException,
                                     AuthenticationException,
                                     DocumentIdentificationException

Analyze the item. docId attribute can be used if props does not contain a DocumentId with all required information or if the access rights of another document need to be checked (e.g. for workflow items).

Parameters:

props - Properties

docId - Document id

Returns:

Analyze result

Throws:

DocumentIdentificationException - document identification exception

AuthenticationException - authentication exception

SystemException - system exception

analyzeItems

public ItemAnalyzeResult analyzeItems(List<ResultProperties> items)
                               throws DocumentIdentificationException,
                                      SystemException,
                                      AuthenticationException

Analyzes the items.

Parameters:

items - items

Returns:

Analyze result

Throws:

DocumentIdentificationException - document identification exception

SystemException - system exception

AuthenticationException - authentication exception