org.treetank.service.jaxrx.util

Class WorkerHelper

java.lang.Object

org.treetank.service.jaxrx.util.WorkerHelper

public final class WorkerHelper
extends Object

This class contains methods that are respectively used by this worker classes (NodeIdRepresentation.java and DatabaseRepresentation.java)

Author:

Patrick Lang, Lukas Lewandowski, University of Konstanz

Method Summary

Methods

Modifier and Type	Method and Description
static void	closeRTX(INodeReadTrx rtx, ISession ses) This method closes all open treetank connections concerning a NodeReadTrx.
static void	closeWTX(boolean abortTransaction, INodeWriteTrx wtx, ISession ses) This method closes all open treetank connections concerning a NodeWriteTrx.
StringBuilder	createStringBuilderObject() This method creates a new StringBuilder reference
static WorkerHelper	getInstance() This method return the singleton instance.
static XMLSerializer	serializeXML(ISession session, OutputStream out, boolean serializeXMLDec, boolean serializeRest, Long revision) This method creates a new XMLSerializer reference
static XMLSerializer	serializeXML(ISession session, OutputStream out, boolean serializeXMLDec, boolean serializeRest, Long nodekey, Long revision) This method creates a new XMLSerializer reference
static void	shredInputStream(INodeWriteTrx wtx, InputStream value, EShredderInsert child) Shreds a given InputStream
EIdAccessType	validateAccessType(String accessType) This method checks the variable URL path after the node id resource (e.g.

Methods inherited from class java.lang.Object

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

Method Detail

shredInputStream

public static void shredInputStream(INodeWriteTrx wtx,
                    InputStream value,
                    EShredderInsert child)

Shreds a given InputStream

Parameters:

wtx - current write transaction reference

value - InputStream to be shred

serializeXML

public static XMLSerializer serializeXML(ISession session,
                         OutputStream out,
                         boolean serializeXMLDec,
                         boolean serializeRest,
                         Long revision)

This method creates a new XMLSerializer reference

Parameters:

session - Associated session.

out - OutputStream

serializeXMLDec - specifies whether XML declaration should be shown

serializeRest - specifies whether node id should be shown

Returns:

new XMLSerializer reference

serializeXML

public static XMLSerializer serializeXML(ISession session,
                         OutputStream out,
                         boolean serializeXMLDec,
                         boolean serializeRest,
                         Long nodekey,
                         Long revision)

This method creates a new XMLSerializer reference

Parameters:

session - Associated session.

out - OutputStream

serializeXMLDec - specifies whether XML declaration should be shown

serializeRest - specifies whether node id should be shown

Returns:

new XMLSerializer reference

createStringBuilderObject

public StringBuilder createStringBuilderObject()

This method creates a new StringBuilder reference

Returns:

new StringBuilder reference

closeWTX

public static void closeWTX(boolean abortTransaction,
            INodeWriteTrx wtx,
            ISession ses)
                     throws TTException

This method closes all open treetank connections concerning a NodeWriteTrx.

Parameters:

abortTransaction - true if the transaction has to be aborted, false otherwise.

wtx - INodeWriteTrx to be closed

ses - ISession to be closed

Throws:

TreetankException

TTException

closeRTX

public static void closeRTX(INodeReadTrx rtx,
            ISession ses)
                     throws TTException

This method closes all open treetank connections concerning a NodeReadTrx.

Parameters:

rtx - INodeReadTrx to be closed

ses - ISession to be closed

Throws:

TTException

validateAccessType

public EIdAccessType validateAccessType(String accessType)

This method checks the variable URL path after the node id resource (e.g. http://.../factbook/3/[ACCESSTYPE]) for the available access type to identify a node. The access types are defined in EIdAccessType.

Parameters:

accessType - The access type as String value encoded in the URL request.

Returns:

The valid access type or null otherwise.

getInstance

public static WorkerHelper getInstance()

This method return the singleton instance.

Returns:

The single instance.