com.attivio.sdk.esb

Class ProcessingResult

java.lang.Object

com.attivio.sdk.esb.ProcessingResult

All Implemented Interfaces:

Serializable

public class ProcessingResult
extends Object
implements Serializable

A ProcessingResult at a minimum contains the result Code of a document processing step. The ProcessingResult may contain an arbitrary status message. Additionally a ProcessingResult may contain new auxiliary messages ( ProcessingResult#addMessage(PlatformMessage) or new documents derived from the processing step ( ProcessingResult#addDocument(IngestDocument).

Generally a processing step will only set a Code however more complex stages such as those that process archive files may produce new documents and messages.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProcessingResult.Data
static class	ProcessingResult.DocData
static class	ProcessingResult.MsgData

Constructor Summary

Constructors

Constructor and Description
ProcessingResult() Convenience constructor.
ProcessingResult(UUID clientId, String component) Creates a new Processing result.

Method Summary

Modifier and Type	Method and Description
void	add(ProcessingResult.DocData dd)
void	addDocumentData(ProcessingResult.DocData dd)
void	addMessageData(ProcessingResult.MsgData md)
void	completed(IngestDocument doc)
void	completed(PlatformMessage pm)
void	created(PlatformMessage pm) Deprecated.
void	debug(IngestDocument doc, String msg)
void	drop(IngestDocument doc)
void	drop(IngestDocument doc, ErrorCode errorCode)
void	drop(IngestDocument doc, String msg)
void	drop(IngestDocument doc, Throwable t)
void	drop(PlatformMessage pm)
void	drop(PlatformMessage pm, ErrorCode errorCode, String msg)
void	drop(PlatformMessage pm, ErrorCode errorCode, Throwable t)
void	drop(PlatformMessage pm, ErrorCode errorCode, Throwable t, String msg)
boolean	equals(Object obj)
void	error(IngestDocument doc, Throwable e, String msg)
static String[]	errorContexts(String message)
void	fail(IngestDocument doc)
void	fail(IngestDocument doc, ErrorCode errorCode, Throwable e)
void	fail(IngestDocument doc, ErrorCode defaultErrorCode, Throwable e, String msg)
void	fail(IngestDocument doc, String msg)
void	fail(IngestDocument doc, Throwable e)
void	fail(PlatformMessage pm, AttivioException ex)
void	fail(PlatformMessage pm, ErrorCode errorCode, String msg)
void	fail(PlatformMessage pm, ErrorCode errorCode, Throwable t, String msg)
void	fail(PlatformMessage pm, Throwable t)
static String	formatError(ErrorCode error, String message) Format context-aware message for error.
UUID	getClientId()
ProcessingResultCode	getCode(String docId) Returns the worst code as determined by the ordinal of the ProcessingResultCode.
String	getComponent()
List<ProcessingResult.DocData>	getDocData()
List<ProcessingResult.MsgData>	getMsgData()
int	hashCode()
void	lost(IngestDocument doc)
void	merge(ProcessingResult pr)
void	notHandled(IngestDocument doc)
void	notHandled(PlatformMessage pm)
void	notHandled(PlatformMessage pm, ErrorCode errorCode, Throwable t)
void	reset()
void	setClientId(UUID value)
void	setCurrentDocument(IngestDocument currentDocument) Convenience function to set the current document context.
String	toString()
void	warn(IngestDocument doc, ErrorCode errorCode, String msg, Object... args)
void	warn(IngestDocument doc, ErrorCode defaultErrorCode, Throwable e, String msg)
void	warn(IngestDocument doc, Throwable e)
void	warn(IngestDocument doc, Throwable e, String msg, Object... args)
void	warn(PlatformMessage pm, ErrorCode errorCode, Throwable t, String msg)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProcessingResult

public ProcessingResult()

Convenience constructor.

This form should only be used when it will be merged with another result which has the clientId and component set.

ProcessingResult

public ProcessingResult(UUID clientId,
                        String component)

Creates a new Processing result. A processing result with no message or document actions will be treated as an OK result.

Method Detail

formatError

public static String formatError(ErrorCode error,
                                 String message)

Format context-aware message for error.

errorContexts

public static String[] errorContexts(String message)

created

@Deprecated
public void created(PlatformMessage pm)

Deprecated.

drop

public void drop(PlatformMessage pm)

drop

public void drop(PlatformMessage pm,
                 ErrorCode errorCode,
                 Throwable t)

drop

public void drop(PlatformMessage pm,
                 ErrorCode errorCode,
                 String msg)

drop

public void drop(PlatformMessage pm,
                 ErrorCode errorCode,
                 Throwable t,
                 String msg)

fail

public void fail(PlatformMessage pm,
                 ErrorCode errorCode,
                 String msg)

fail

public void fail(PlatformMessage pm,
                 Throwable t)

fail

public void fail(PlatformMessage pm,
                 AttivioException ex)

fail

public void fail(PlatformMessage pm,
                 ErrorCode errorCode,
                 Throwable t,
                 String msg)

warn

public void warn(PlatformMessage pm,
                 ErrorCode errorCode,
                 Throwable t,
                 String msg)

notHandled

public void notHandled(PlatformMessage pm)

notHandled

public void notHandled(PlatformMessage pm,
                       ErrorCode errorCode,
                       Throwable t)

completed

public void completed(PlatformMessage pm)

debug

public void debug(IngestDocument doc,
                  String msg)

drop

public void drop(IngestDocument doc)

drop

public void drop(IngestDocument doc,
                 ErrorCode errorCode)

drop

public void drop(IngestDocument doc,
                 String msg)

lost

public void lost(IngestDocument doc)

drop

public void drop(IngestDocument doc,
                 Throwable t)

notHandled

public void notHandled(IngestDocument doc)

error

public void error(IngestDocument doc,
                  Throwable e,
                  String msg)

warn

public void warn(IngestDocument doc,
                 Throwable e)

warn

public void warn(IngestDocument doc,
                 Throwable e,
                 String msg,
                 Object... args)

warn

public void warn(IngestDocument doc,
                 ErrorCode errorCode,
                 String msg,
                 Object... args)

warn

public void warn(IngestDocument doc,
                 ErrorCode defaultErrorCode,
                 Throwable e,
                 String msg)

fail

public void fail(IngestDocument doc)

fail

public void fail(IngestDocument doc,
                 String msg)

fail

public void fail(IngestDocument doc,
                 Throwable e)

fail

public void fail(IngestDocument doc,
                 ErrorCode errorCode,
                 Throwable e)

fail

public void fail(IngestDocument doc,
                 ErrorCode defaultErrorCode,
                 Throwable e,
                 String msg)

completed

public void completed(IngestDocument doc)

reset

public void reset()

merge

public void merge(ProcessingResult pr)

addDocumentData

public void addDocumentData(ProcessingResult.DocData dd)

addMessageData

public void addMessageData(ProcessingResult.MsgData md)

getClientId

public UUID getClientId()

setClientId

public void setClientId(UUID value)

getComponent

public String getComponent()

getMsgData

public List<ProcessingResult.MsgData> getMsgData()

getDocData

public List<ProcessingResult.DocData> getDocData()

getCode

public ProcessingResultCode getCode(String docId)

Returns the worst code as determined by the ordinal of the ProcessingResultCode.

Parameters:

docId -

Returns:

the "worst" code for the docId in the results or ProcessingResultCode.OK.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

add

public void add(ProcessingResult.DocData dd)

setCurrentDocument

public void setCurrentDocument(IngestDocument currentDocument)

Convenience function to set the current document context. This is useful in cases where the code providing feedback or warnings is not passed the document but perhaps a part of it such as a field. If any of the document oriented methods is passed a null in place of the document, the currentDocument is used. The currentDocument is cleared when the reset() method is called.

A null parameter sets the current values to null.

Parameters:

currentDocument - may be null