Changeset 4101

Timestamp:

Jan 28, 2008, 11:02:08 AM (15 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #904: Subclasses of AbstractFlatFileImporter? should be able to wrap the file inputstream

File:

• trunk/src/plugins/core/net/sf/basedb/plugins/AbstractFlatFileImporter.java (modified) (5 diffs)

trunk/src/plugins/core/net/sf/basedb/plugins/AbstractFlatFileImporter.java

@@ -500 +500 @@
   {
     FlatFileParser ffp = getInitializedFlatFileParser();
-    ffp.setInputStream(in, getCharset());
     ffp.setDefaultNumberFormat(getNumberFormat());
     try
     {
+      in = wrapInputStream(in);
+      ffp.setInputStream(in, getCharset());
       ffp.nextSection();
       FlatFileParser.LineType result = ffp.parseHeaders();
@@ -527 +528 @@
     FlatFileParser ffp = getInitializedFlatFileParser();
     FlatFileParser.Data dataline = null;
-    ffp.setInputStream(in, getCharset());
     ffp.setDefaultNumberFormat(getNumberFormat());
     boolean useNullIfException = "null".equals(job != null ? job.getValue("numberFormatError") : "");
@@ -534 +534 @@
     try
     {
+      in = wrapInputStream(in);
+      ffp.setInputStream(in, getCharset());
       skippedLines = 0;
       begin(ffp);
@@ -685 +687 @@
   // -------------------------------------------
 
-  private int getProgress(FlatFileParser ffp)
-  {
-    return (int) (100 * ffp.getParsedBytes() / fileSize);
+  /**
+    Get the progress of import as a percentage value. The default implementation
+    calls {@link #getNumBytes(FlatFileParser)} and divides it by the file size.
+    @param ffp The file parser that is used to parsed the file
+    @return A value between 0 and 100
+    @since 2.6
+  */
+  protected int getProgress(FlatFileParser ffp)
+  {
+    return (int) (100 * getNumBytes(ffp) / fileSize);
+  }
+  
+  
+  /**
+    Get the number of bytes read from the file. The value should indicate the
+    how far into the file parsing has proceeded. The default
+    implementation calls {@link FlatFileParser#getParsedBytes()}. If a subclass has 
+    wrapped the input stream the number of parsed byts may not correspond to the 
+    number of bytes read from the file.
+    For example, if the file is a compressed file the number of parsed bytes will
+    be higher than the number of bytes read from the file.
+    @param ffp The file parser that is used to parsed the file
+    @return The number of bytes read from the original file
+    @see #wrapInputStream(InputStream)
+    @see #getProgress(FlatFileParser)
+    @since 2.6
+  */
+  protected long getNumBytes(FlatFileParser ffp)
+  {
+    return ffp.getParsedBytes();
   }
 
@@ -705 +734 @@
   {
     return true;
+  }
+  
+  /**
+    This method is called before the parser starts reading from the
+    input stream. A subclass may override this method to wrap the inputstream
+    with a filtering stream, for example, a gzip input stream. The default
+    implementation of this method returns the original stream unmodified. If a subclass
+    overrides this methods it may also need to override one of the 
+    {@link #getNumBytes(FlatFileParser)} or {@link #getProgress(FlatFileParser)} 
+    methods.
+    @param in The input stream to wrap
+    @return The same or a different input stream
+    @since 2.6
+    @see #getNumBytes(FlatFileParser)
+  */
+  protected InputStream wrapInputStream(InputStream in)
+    throws IOException
+  {
+    return in;
   }