project35.io
Class XMLSubmissionFileWriter

java.lang.Object
  project35.io.XMLSubmissionFileWriter

public class XMLSubmissionFileWriter
extends java.lang.Object

Writes out a data file in an XML format that will validate against the original schema. Note that the output is an Unicode XML text file.

Copyright (c) 2008 Kevin Garwood for Project35. The original code was developed by Kevin Garwood for the University of Manchester. Revisions have been made for Project35, a project that is independent of that institution. This code is licensed under the Academic Free License version 3.0. The code attribution for the original code is included here:

Copyright (c) Kevin Garwood and University of Manchester 2007. All rights reserved. Licensed under the Academic Free License version 3.0. For more information on the terms and conditions, please see the file "LICENSE" that is included in this distribution.

Version:

1.0

Author:

Kevin Garwood (kgarwood@users.sourceforge.net)

Constructor Summary

XMLSubmissionFileWriter(Project35FormContext project35FormContext, boolean writeTemplate)

Method Summary

void	initialiseCommentFacility(ModelObjectCommentRegistry modelObjectCommentRegistry, java.lang.Object userObject)
void	omitModelStamp() model stamp is not written to the data file
void	setDocumentHeaderComment(java.lang.String documentHeaderComment) Set the value of documentHeaderComment.
void	writeFile(java.io.File file, RecordModel recordModel, boolean writeChildRecords)
void	writeFile(java.io.OutputStream stream, RecordModel recordModel, boolean writeChildRecords)
void	writeFile(java.net.URL url, RecordModel recordModel, boolean writeChildRecords)

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLSubmissionFileWriter

public XMLSubmissionFileWriter(Project35FormContext project35FormContext,
                               boolean writeTemplate)

Method Detail

initialiseCommentFacility

public void initialiseCommentFacility(ModelObjectCommentRegistry modelObjectCommentRegistry,
                                      java.lang.Object userObject)

setDocumentHeaderComment

public void setDocumentHeaderComment(java.lang.String documentHeaderComment)

Set the value of documentHeaderComment.

Parameters:

documentHeaderComment - Value to assign to documentHeaderComment.

omitModelStamp

public void omitModelStamp()

model stamp is not written to the data file

writeFile

public void writeFile(java.io.OutputStream stream,
                      RecordModel recordModel,
                      boolean writeChildRecords)
               throws java.io.IOException

Throws:

java.io.IOException

writeFile

public void writeFile(java.io.File file,
                      RecordModel recordModel,
                      boolean writeChildRecords)
               throws java.io.IOException

Throws:

java.io.IOException

writeFile

public void writeFile(java.net.URL url,
                      RecordModel recordModel,
                      boolean writeChildRecords)
               throws java.io.IOException

Throws:

java.io.IOException