writer2latex.xmerge

Class ConvertData

public class ConvertData extends Object implements ConverterResult

ConvertData is used as a container for passing OutputFile objects in and out of the Convert class. The ConvertData contains a String name and a Vector of OutputFile objects.

Author: Martin Maher

Method Summary
void	addDocument(OutputFile doc) Adds a `OutputFile` to the vector.
OutputFile	getMasterDocument() Get the master document
String	getName() Returns the `OutputFile` name.
int	getNumDocuments() Gets the number of `OutputFile` objects currently stored
boolean	isMasterDocument(OutputFile doc) Check if a given document is the master document
Iterator	iterator() Gets an `Iterator` to access the `Vector` of `OutputFile` objects
void	reset() Resets ConvertData.
void	setName(String docName) Sets the `OutputFile` name.
void	write(File dir)

Method Detail

addDocument

public void addDocument(OutputFile doc)

Adds a OutputFile to the vector.

Parameters: doc The OutputFile to add.

getMasterDocument

public OutputFile getMasterDocument()

Get the master document

Returns: OutputFile the master document

getName

public String getName()

Returns the OutputFile name.

Returns: The OutputFile name.

getNumDocuments

public int getNumDocuments()

Gets the number of OutputFile objects currently stored

Returns: The number of OutputFile objects currently stored.

isMasterDocument

public boolean isMasterDocument(OutputFile doc)

Check if a given document is the master document

Parameters: doc The OutputFile to check

Returns: true if this is the master document

iterator

public Iterator iterator()

Gets an Iterator to access the Vector of OutputFile objects

Returns: The Iterator to access the Vector of OutputFile objects.

reset

public void reset()

Resets ConvertData. This empties all OutputFile objects from this class. This allows reuse of a ConvertData.

setName

public void setName(String docName)

Sets the OutputFile name.

Parameters: docName The name of the OutputFile.

write

public void write(File dir)