Class FileSource
- java.lang.Object
-
- org.apache.torque.generator.source.SourceImpl
-
- org.apache.torque.generator.source.stream.FileSource
-
- All Implemented Interfaces:
Source
public class FileSource extends SourceImpl
A Source which uses a file as input.
-
-
Constructor Summary
Constructors Constructor Description FileSource(StreamSourceFormat format, File path, ControllerState controllerState)Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SourceElementcreateRootElement()Reads and parses the input file and creates the element tree from it.byte[]getContentChecksum()Returns the checksum of the content.StringgetDescription()Returns the path of the file as a description.DategetLastModified()Returns the date when the source was last modified.FilegetPath()Returns the path to the source file.FilegetSourceFile()Returns the source file, if it exists.StreamSourceFormatgetSourceFormat()Returns the format of the source.StringtoString()-
Methods inherited from class org.apache.torque.generator.source.SourceImpl
getRootElement
-
-
-
-
Constructor Detail
-
FileSource
public FileSource(StreamSourceFormat format, File path, ControllerState controllerState)
Constructor.- Parameters:
format- the source format, not null.path- the path to the file to read, not null.controllerState- the controller state, not null.- Throws:
NullPointerException- if path or format is null.
-
-
Method Detail
-
getSourceFormat
public StreamSourceFormat getSourceFormat()
Returns the format of the source.- Returns:
- the source format, not null.
-
getPath
public File getPath()
Returns the path to the source file.- Returns:
- the path to the source file, not null.
-
createRootElement
public SourceElement createRootElement() throws SourceException
Reads and parses the input file and creates the element tree from it.- Specified by:
createRootElementin classSourceImpl- 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 file as a description.- Returns:
- path of the file, not null.
- See Also:
Source.getDescription()
-
getSourceFile
public File getSourceFile()
Returns the source file, if it exists.- Returns:
- the source file, or null if the source is not read from a file.
-
getLastModified
public Date getLastModified()
Returns the date when the source was last modified.- Returns:
- the last modification date, or null when unknown.
-
getContentChecksum
public byte[] getContentChecksum()
Returns the checksum of the content.- Returns:
- the md5 sum of the content, or null if the implementation does not support creating the checksum, or if the source is unread and reading the source fails.
-
-