uk.ac.ox.cs.diadem.oxpath.output

Class ACustomOutputHandler

java.lang.Object

uk.ac.ox.cs.diadem.oxpath.output.ACustomOutputHandler

All Implemented Interfaces:

IAbstractOutputHandler, IOutputHandler

Direct Known Subclasses:

AAdvancedCustomOutputHandler, JsonOutputHandler, NodeOutputHandler, RecStreamOutputHandler, RelationOutputHandler, SimpleConsoleOutputHandler, XMLOutputHandler

public abstract class ACustomOutputHandler
extends Object
implements IOutputHandler

This class implements basic functionality for handling the OXPath output and can be sub-classed by specific implementations, processing OXPathExtractionNode.

Author:

Giovanni Grasso , Ruslan Fayzrakhmanov

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_WRAPPER_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ACustomOutputHandler() Only one value is allowed per attribute
protected	ACustomOutputHandler(boolean allowMultipleValuesPerAttribute)
protected	ACustomOutputHandler(String wrapperId, boolean allowMultipleValuesPerAttribute)

Method Summary

Modifier and Type	Method and Description
protected boolean	getAllowMultipleValuesPerAttribute()
protected Set<String>	getAttributesSeenPerTuple()
List<Throwable>	getOuterExceptions()
String	getOuterExceptionStackTracesAsString()
String	getWrapperId()
boolean	hasOuterException()
boolean	isEndNodeReceived()
protected void	logInfo(String message, org.slf4j.Logger logger) Helper function: Log message with wrapper id attached
void	processNode(OXPathExtractionNode node) The OXPath engine invokes this method to output extraction nodes.
protected abstract void	processNodeImpl(OXPathExtractionNode node)
void	receiveOuterException(Throwable e) This method is called by the OXPath engine if the exception affecting the output has been received.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WRAPPER_ID

public static final String DEFAULT_WRAPPER_ID

See Also:

Constant Field Values

Constructor Detail

ACustomOutputHandler

protected ACustomOutputHandler()

Only one value is allowed per attribute

ACustomOutputHandler

protected ACustomOutputHandler(boolean allowMultipleValuesPerAttribute)

Parameters:

allowMultipleValuesPerAttribute - true: multiple values are allowed per attribute

ACustomOutputHandler

protected ACustomOutputHandler(String wrapperId,
                               boolean allowMultipleValuesPerAttribute)

Parameters:

wrapperId - The ID of the execution.

allowMultipleValuesPerAttribute - true: multiple values are allowed per attribute

Method Detail

isEndNodeReceived

public boolean isEndNodeReceived()

Specified by:

isEndNodeReceived in interface IOutputHandler

Returns:

true if the "end node" has been received.

getAttributesSeenPerTuple

protected Set<String> getAttributesSeenPerTuple()

getAllowMultipleValuesPerAttribute

protected boolean getAllowMultipleValuesPerAttribute()

processNode

public void processNode(OXPathExtractionNode node)

Description copied from interface: IAbstractOutputHandler

The OXPath engine invokes this method to output extraction nodes. The first node is <result> node, the root. The last node is the "end node".

Specified by:

processNode in interface IAbstractOutputHandler

processNodeImpl

protected abstract void processNodeImpl(OXPathExtractionNode node)

getWrapperId

public String getWrapperId()

Specified by:

getWrapperId in interface IOutputHandler

Returns:

the id of the execution.

receiveOuterException

public void receiveOuterException(Throwable e)

Description copied from interface: IAbstractOutputHandler

This method is called by the OXPath engine if the exception affecting the output has been received.

Specified by:

receiveOuterException in interface IAbstractOutputHandler

hasOuterException

public boolean hasOuterException()

Specified by:

hasOuterException in interface IAbstractOutputHandler

getOuterExceptions

public List<Throwable> getOuterExceptions()

Specified by:

getOuterExceptions in interface IOutputHandler

getOuterExceptionStackTracesAsString

public String getOuterExceptionStackTracesAsString()

Specified by:

getOuterExceptionStackTracesAsString in interface IOutputHandler

logInfo

protected void logInfo(String message,
                       org.slf4j.Logger logger)

Helper function: Log message with wrapper id attached

Parameters:

string -