Class CombinedFileSource

java.lang.Object
org.apache.torque.generator.source.SourceImpl
org.apache.torque.generator.source.stream.CombinedFileSource
All Implemented Interfaces:
Source

public class CombinedFileSource extends SourceImpl
A source which uses several files as input and combines them into one file. The source tree will look as follows: <source> <file path="path/to/file1"> <rootOfFile1> ... </rootOfFile1> </file> <file path="path/to/file2"> <rootOfFile2> ... </rootOfFile2> </file> ... </source>
  • Field Details

    • ROOT_ELEMENT_NAME

      public static final String ROOT_ELEMENT_NAME
      The name of the root element of the produced source tree.
      See Also:
    • FILE_ELEMENT_NAME

      public static final String FILE_ELEMENT_NAME
      The name of the root element's children of the produced source tree.
      See Also:
    • PATH_ATTRIBUTE_NAME

      public static final String PATH_ATTRIBUTE_NAME
      The name of the path attribute of the file elements.
      See Also:
  • Constructor Details

    • CombinedFileSource

      public CombinedFileSource(Collection<FileSource> fileSources)
      Constructor.
      Parameters:
      fileSources - the file sources, not null.
      Throws:
      NullPointerException - if path or format is null.
  • Method Details

    • createRootElement

      public SourceElement createRootElement() throws SourceException
      Reads and parses the input file and creates the element tree from it.
      Specified by:
      createRootElement in class SourceImpl
      Returns:
      the root element of the element tree.
      Throws:
      SourceException - if the input file cannot be read or parsed.
    • getDescription

      public String getDescription()
      Returns the path of the files as a description.
      Returns:
      path of the files,separated by a semicolon, not null.
      See Also:
    • getSourceFile

      public File getSourceFile()
      Returns the source file, if applicable. As no single source file exists, the method returns always null.
      Returns:
      null.
    • getLastModified

      public Date getLastModified()
      Returns the earliest date when any of the source files was last modified.
      Returns:
      the last modification date, or null when unknown for at least one of the files.
    • getContentChecksum

      public byte[] getContentChecksum()
      Returns the checksum of all files. All bytes are added so order of the files does not matter.
      Returns:
      a checksum for all files, or null if one of the checksums of the file sources is null.
    • toString

      public String toString()
      Overrides:
      toString in class Object