Package writer2latex.xmerge

Class ConvertData

java.lang.Object
writer2latex.xmerge.ConvertData
All Implemented Interfaces:
ConverterResult
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

  • Constructor Details

    • ConvertData

      public ConvertData()

  • Method Details

    • reset

      public void reset()
      Resets ConvertData. This empties all OutputFile objects from this class. This allows reuse of a ConvertData.

    • getName

      public String getName()
      Returns the OutputFile name.
      Returns:
      The OutputFile name.

    • setName

      public void setName(String docName)
      Sets the OutputFile name.
      Parameters:
      docName - The name of the OutputFile.

    • 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
      Specified by:
      getMasterDocument in interface ConverterResult
      Returns:
      OutputFile the master document

    • 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
      Specified by:
      iterator in interface ConverterResult
      Returns:
      The Iterator to access the Vector of OutputFile objects.

    • getNumDocuments

      public int getNumDocuments()
      Gets the number of OutputFile objects currently stored
      Returns:
      The number of OutputFile objects currently stored.

    • write

      public void write(File dir) throws IOException
      Description copied from interface: ConverterResult
      Write all files of the ConverterResult to a directory. Subdirectories are created as required by the individual OutputFiles.
      Specified by:
      write in interface ConverterResult
      Parameters:
      dir - the directory to write to (this directory must exist). If the parameter is null, the default directory is used
      Throws:
      IOException - if the directory does not exist or one or more files could not be written