org.biolegato.core.menu.variables
Class EZTempFile

java.lang.Object
  org.biolegato.core.menu.variables.EZTempFile

All Implemented Interfaces:

EZVariable

public class EZTempFile
extends java.lang.Object
implements EZVariable

Stores information about the file fields used by the command

Author:

Graham Alvare, Brian Fristensky

Constructor Summary

EZTempFile(java.util.Map data)
Creates a new instance of EZTempFile.

Method Summary

void	close() Releases any files currently in use by this class
java.lang.String	getName() Returns the name of the variable.
static java.lang.String	getType() Returns the type name
java.lang.Object	getValue() Gets the current filename corresponding to this variable If the file does not exists, then this function creates a file to use for IO and writes any initial contents
boolean	isWidget() Returns the widget status of the variable (i.e., is the variable displayable)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EZTempFile

public EZTempFile(java.util.Map data)

Creates a new instance of EZTempFile.

Parameters:

data - the data to create the temporary file variable with.

Method Detail

getName

public java.lang.String getName()

Returns the name of the variable.

Returns:

the name of the variable

getValue

public java.lang.Object getValue()

Gets the current filename corresponding to this variable If the file does not exists, then this function creates a file to use for IO and writes any initial contents

Specified by:

getValue in interface EZVariable

Returns:

the filename to use for command line substitution.

close

public void close()

Releases any files currently in use by this class

Specified by:

close in interface EZVariable

getType

public static java.lang.String getType()

Returns the type name

Returns:

"tempfile"

isWidget

public boolean isWidget()

Returns the widget status of the variable (i.e., is the variable displayable)

Returns:

true if the variable contains a displayable component.