avcl

Class XsltConverter

java.lang.Object

avcl.Converter

avcl.XsltConverter

All Implemented Interfaces:

Runnable

public class XsltConverter
extends Converter

Description : Class to be used for converting AVCL files to another text-based format (XML or not) using an XSLT transformation. Input and output sources can be in the form of String pathnames, Java File objects or AvclMission objects (for the input source).

Since:

17 May 2004 Program : AUV Workbench Platform : Windows 2000/Windows XP

Version:

$Id: XsltConverter.java 9109 2015-07-29 22:39:46Z brutzman $

Author:

Duane Davis

Field Summary

Fields

Modifier and Type	Field and Description
protected InputStream	avclStream Stream from which AVCL file will be read

Fields inherited from class avcl.Converter

autoStreamClose, outStream

Constructor Summary

Constructors

Constructor and Description
XsltConverter(File xslFile, AvclMission avcl, File outFile) Creates the input streams and assigns the local variables assigning conversion output sources
XsltConverter(File xslFile, File outFile) Creates the input streams and assigns the local variables assigning conversion output sources
XsltConverter(File xslFile, File avclFile, File outFile) Creates the input streams and assigns the local variables assigning conversion output sources
XsltConverter(File xslFile, OutputStream outStream) Creates the input streams and assigns the local variables assigning conversion output sources
XsltConverter(String xslFile, AvclMission avcl, String outFile) Creates the input streams and assigns the local variables assigning conversion output sources
XsltConverter(String xslFile, String avclFile, String outFile) Creates the input streams and assigns the local variables from which

Method Summary

Modifier and Type	Method and Description
void	closeStream() Manually closes the output stream of the converter Separated from the run method to allow the stream to remain open if required for multiple conversions over the same pipe (e.g., communications or high level vehicle control)
void	commenceMarshal() Commences marshalling the AVCL mission to the pipedOutputStream once the reading thread has been spawned.
static void	main(String[] args) Used to run XSLT transformations The command line arguments should be the input file, the xslt file, and the output file in order
void	resetAvcl(AvclMission newAvclMission) Resets the AVCL mission object to be converted
boolean	runConversion() Conducts the XSLT transformation and writes the result to the designated output stream
void	setParameter(String name, Object value) General-purpose method to set a parameter name and corresponding (object) value

Methods inherited from class avcl.Converter

run, setAutoStreamClose

Methods inherited from class java.lang.Object

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

Field Detail

avclStream

protected InputStream avclStream

Stream from which AVCL file will be read

Constructor Detail

XsltConverter

public XsltConverter(String xslFile,
                     String avclFile,
                     String outFile)
              throws FileNotFoundException

Creates the input streams and assigns the local variables from which

Parameters:

xslFile - path to XSLT to be used in conversion

avclFile - path to the AVCL input file to be converted

outFile - destination

Throws:

FileNotFoundException

XsltConverter

public XsltConverter(File xslFile,
                     File avclFile,
                     File outFile)
              throws FileNotFoundException

Creates the input streams and assigns the local variables assigning conversion output sources

Parameters:

xslFile - path to XSLT to be used in conversion

avclFile - path to the AVCL input file to be converted

outFile - destination

Throws:

FileNotFoundException

XsltConverter

public XsltConverter(String xslFile,
                     AvclMission avcl,
                     String outFile)
              throws FileNotFoundException

Creates the input streams and assigns the local variables assigning conversion output sources

Parameters:

xslFile - path to XSLT to be used in conversion

avcl - path to the AVCL input file to be converted

outFile - destination

Throws:

FileNotFoundException

XsltConverter

public XsltConverter(File xslFile,
                     AvclMission avcl,
                     File outFile)
              throws FileNotFoundException

Creates the input streams and assigns the local variables assigning conversion output sources

Parameters:

xslFile - path to XSLT to be used in conversion

avcl - path to the AVCL input file to be converted

outFile - destination

Throws:

FileNotFoundException

XsltConverter

public XsltConverter(File xslFile,
                     File outFile)
              throws FileNotFoundException

Creates the input streams and assigns the local variables assigning conversion output sources

Parameters:

xslFile - path to XSLT to be used in conversion

outFile - destination

Throws:

FileNotFoundException

XsltConverter

public XsltConverter(File xslFile,
                     OutputStream outStream)

Creates the input streams and assigns the local variables assigning conversion output sources

Parameters:

xslFile - path to XSLT to be used in conversion

outStream - destination

Method Detail

resetAvcl

public void resetAvcl(AvclMission newAvclMission)

Resets the AVCL mission object to be converted

Parameters:

newAvclMission -

runConversion

public boolean runConversion()

Conducts the XSLT transformation and writes the result to the designated output stream

Specified by:

runConversion in class Converter

Returns:

true iif a complete transform was accomplished

commenceMarshal

public void commenceMarshal()

Commences marshalling the AVCL mission to the pipedOutputStream once the reading thread has been spawned. This method should not be called from the XsltConverter's own thread to prevent it from deadlocking (PipedStreams should not be read and written from within the same thread)

closeStream

public void closeStream()

Manually closes the output stream of the converter Separated from the run method to allow the stream to remain open if required for multiple conversions over the same pipe (e.g., communications or high level vehicle control)

Overrides:

closeStream in class Converter

setParameter

public void setParameter(String name,
                         Object value)

General-purpose method to set a parameter name and corresponding (object) value

Parameters:

name -

value -

main

public static void main(String[] args)

Used to run XSLT transformations The command line arguments should be the input file, the xslt file, and the output file in order

Parameters:

args - command line arguments must be the input file, output file, and xslt file in order