org.treetank.service.xml.shredder

Class XMLShredder

java.lang.Object

org.treetank.service.xml.shredder.XMLShredder

All Implemented Interfaces:

Callable<Void>

Direct Known Subclasses:

XMLUpdateShredder

public class XMLShredder
extends Object
implements Callable<Void>

This class appends a given XMLStreamReader to a INodeWriteTrx. The content of the stream is added as a subtree. Based on an enum which identifies the point of insertion, the subtree is either added as first child or as right sibling.

Author:

Marc Kramis, Seabix, Sebastian Graf, University of Konstanz, Johannes Lichtenberger, University of Konstanz

Field Summary

Fields

Modifier and Type	Field and Description
protected EShredderInsert	mFirstChildAppend Append as first child or not.
protected XMLEventReader	mReader XMLEventReader.
protected INodeWriteTrx	mWtx INodeWriteTrx-reference

Constructor Summary

Constructors

Constructor and Description
XMLShredder(INodeWriteTrx paramWtx, XMLEventReader paramReader, EShredderInsert paramAddAsFirstChild) Normal constructor to invoke a shredding process on a existing INodeWriteTrx.
XMLShredder(INodeWriteTrx paramWtx, XMLEventReader paramReader, EShredderInsert paramAddAsFirstChild, EShredderCommit paramCommit) Normal constructor to invoke a shredding process on a existing INodeWriteTrx.

Method Summary

Methods

Modifier and Type	Method and Description
protected Stack<Long>	addNewElement(Stack<Long> paramLeftSiblingKeyStack, StartElement paramEvent) Add a new element node.
protected Stack<Long>	addNewText(Stack<Long> paramLeftSiblingKeyStack, String paramText) Add a new text node.
Void	call() Invoking the shredder.
static XMLEventReader	createFileReader(File paramFile) Create a new StAX reader on a file.
static XMLEventReader	createListReader(List<XMLEvent> paramEvents) Create a new StAX reader based on a List of XMLEvents.
static XMLEventReader	createStringReader(String paramString) Create a new StAX reader on a string.
CountDownLatch	getLatch() Get latch.
protected void	insertNewContent() Insert new content based on a StAX parser XMLStreamReader.
static void	main(String... paramArgs) Main method.

Methods inherited from class java.lang.Object

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

Field Detail

mWtx

protected final transient INodeWriteTrx mWtx

INodeWriteTrx-reference

mReader

protected transient XMLEventReader mReader

XMLEventReader.

mFirstChildAppend

protected transient EShredderInsert mFirstChildAppend

Append as first child or not.

Constructor Detail

XMLShredder

public XMLShredder(INodeWriteTrx paramWtx,
           XMLEventReader paramReader,
           EShredderInsert paramAddAsFirstChild)
            throws TTException

Normal constructor to invoke a shredding process on a existing INodeWriteTrx.

Parameters:

paramWtx - where the new XML Fragment should be placed

paramReader - of the XML Fragment

paramAddAsFirstChild - if the insert is occuring on a node in an existing tree. false is not possible when wtx is on root node.

Throws:

TTUsageException - if insertasfirstChild && updateOnly is both true OR if wtx is not pointing to doc-root and updateOnly= true

TTException

XMLShredder

public XMLShredder(INodeWriteTrx paramWtx,
           XMLEventReader paramReader,
           EShredderInsert paramAddAsFirstChild,
           EShredderCommit paramCommit)
            throws TTException

Normal constructor to invoke a shredding process on a existing INodeWriteTrx.

Parameters:

paramWtx - INodeWriteTrx where the new XML Fragment should be placed

paramReader - XMLEventReader to parse the xml fragment, which should be inserted

paramAddAsFirstChild - determines if the insert is occuring on a node in an existing tree. false is not possible when wtx is on root node

paramCommit - determines if inserted nodes should be commited right afterwards

Throws:

TTUsageException - if insertasfirstChild && updateOnly is both true OR if wtx is not pointing to doc-root and updateOnly= true

TTException

Method Detail

call

public Void call()
          throws TTException

Invoking the shredder.

Specified by:

call in interface Callable<Void>

Returns:

revision of file

Throws:

TTException - if any kind of Treetank exception which has occured

insertNewContent

protected final void insertNewContent()
                               throws TTException

Insert new content based on a StAX parser XMLStreamReader.

Throws:

TTException - if something went wrong while inserting

addNewElement

protected final Stack<Long> addNewElement(Stack<Long> paramLeftSiblingKeyStack,
                        StartElement paramEvent)
                                   throws TTException

Add a new element node.

Parameters:

paramLeftSiblingKeyStack - stack used to determine if the new element has to be inserted as a right sibling or as a new child (in the latter case is NULL on top of the stack)

paramEvent - the current event from the StAX parser

Returns:

the modified stack

Throws:

TTException - if adding ElementNode fails

addNewText

protected final Stack<Long> addNewText(Stack<Long> paramLeftSiblingKeyStack,
                     String paramText)
                                throws TTException

Add a new text node.

Parameters:

paramLeftSiblingKeyStack - stack used to determine if the new element has to be inserted as a right sibling or as a new child (in the latter case is NULL on top of the stack)

paramText - the text string to add

Returns:

the modified stack

Throws:

TTException - if adding text fails

main

public static void main(String... paramArgs)
                 throws Exception

Main method.

Parameters:

paramArgs - input and output files

Throws:

Exception - if any exception occurs

createFileReader

public static XMLEventReader createFileReader(File paramFile)
                                       throws IOException,
                                              XMLStreamException

Create a new StAX reader on a file.

Parameters:

paramFile - the XML file to parse

Returns:

an XMLEventReader

Throws:

IOException - if I/O operation fails

XMLStreamException - if any parsing error occurs

createStringReader

public static XMLEventReader createStringReader(String paramString)
                                         throws IOException,
                                                XMLStreamException

Create a new StAX reader on a string.

Parameters:

paramString - the XML file as a string to parse

Returns:

an XMLEventReader

Throws:

IOException - if I/O operation fails

XMLStreamException - if any parsing error occurs

createListReader

public static XMLEventReader createListReader(List<XMLEvent> paramEvents)
                                       throws IOException,
                                              XMLStreamException

Create a new StAX reader based on a List of XMLEvents.

Parameters:

paramEvents - XMLEvents

Returns:

an XMLEventReader

Throws:

IOException - if I/O operation fails

XMLStreamException - if any parsing error occurs

getLatch

public final CountDownLatch getLatch()

Get latch.

Returns:

CountDownLatch reference