compbio.engine

Class FilePuller

java.lang.Object

compbio.engine.FilePuller

All Implemented Interfaces:

java.lang.Comparable<java.util.concurrent.Delayed>, java.util.concurrent.Delayed

public class FilePuller
extends java.lang.Object
implements java.util.concurrent.Delayed

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	chunkSize
private static long	defaultDelay
(package private) long	delay
private java.io.File	file
private long	lastAccessTime
private static org.apache.log4j.Logger	log
private compbio.util.FileWatcher	watcher

Constructor Summary

Constructors

Modifier	Constructor and Description
private	FilePuller(java.lang.String file)
private	FilePuller(java.lang.String file, int size)

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.util.concurrent.Delayed o)
void	disconnect()
(package private) boolean	disconnected()
boolean	equals(java.lang.Object obj)
long	getDelay(java.util.concurrent.TimeUnit unit)
(package private) long	getDelayValue(java.util.concurrent.TimeUnit unit)
java.lang.String	getFile()
byte	getProgress()
int	hashCode()
boolean	hasMoreData()
private void	init()
void	initPull()
boolean	isFileCreated()
static FilePuller	newFilePuller(java.lang.String file, int chunkSize)
static FilePuller	newProgressPuller(java.lang.String file) Progress Puller is designed to read 3 characters from the beginning of the file, nothing more.
ChunkHolder	pull(long position)
(package private) static java.lang.String	removeInvalidXMLCharacters(java.lang.String str) This method ensures that the output String has only valid XML unicode characters as specified by the XML 1.0 standard.
(package private) void	setDelay(long delay, java.util.concurrent.TimeUnit unit)
java.lang.String	toString()
void	waitForFile(long maxWaitSeconds)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

log

private static final org.apache.log4j.Logger log

defaultDelay

private static long defaultDelay

file

private final java.io.File file

lastAccessTime

private long lastAccessTime

watcher

private compbio.util.FileWatcher watcher

chunkSize

final int chunkSize

delay

long delay

Constructor Detail

FilePuller

private FilePuller(java.lang.String file,
                   int size)

FilePuller

private FilePuller(java.lang.String file)

Method Detail

newFilePuller

public static FilePuller newFilePuller(java.lang.String file,
                                       int chunkSize)

newProgressPuller

public static FilePuller newProgressPuller(java.lang.String file)

Progress Puller is designed to read 3 characters from the beginning of the file, nothing more. Intended to be used in conjunction with a tool which output progress as a percent value from 0 to 100. In any cases progress could not be more than the largest byte value 255.

Parameters:

file -

Returns:

instance

pull

public ChunkHolder pull(long position)
                 throws java.io.IOException

Throws:

java.io.IOException

removeInvalidXMLCharacters

static java.lang.String removeInvalidXMLCharacters(java.lang.String str)

This method ensures that the output String has only valid XML unicode characters as specified by the XML 1.0 standard. For reference, please see the standard.

Parameters:

The - String whose non-valid characters we want to remove.

Returns:

The in String, stripped of non-valid characters.

initPull

public void initPull()

getFile

public java.lang.String getFile()

isFileCreated

public boolean isFileCreated()

waitForFile

public void waitForFile(long maxWaitSeconds)

hasMoreData

public boolean hasMoreData()
                    throws java.io.IOException

Throws:

java.io.IOException

init

private void init()

compareTo

public int compareTo(java.util.concurrent.Delayed o)

Specified by:

compareTo in interface java.lang.Comparable<java.util.concurrent.Delayed>

getDelay

public long getDelay(java.util.concurrent.TimeUnit unit)

Specified by:

getDelay in interface java.util.concurrent.Delayed

setDelay

void setDelay(long delay,
              java.util.concurrent.TimeUnit unit)

getDelayValue

long getDelayValue(java.util.concurrent.TimeUnit unit)

disconnect

public void disconnect()

disconnected

boolean disconnected()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getProgress

public byte getProgress()
                 throws java.io.IOException

Throws:

java.io.IOException