org.fhcrc.cpl.toolbox.commandline.arguments
Class FileToReadArgumentDefinition

java.lang.Object
  org.fhcrc.cpl.toolbox.commandline.arguments.BaseArgumentDefinitionImpl
      org.fhcrc.cpl.toolbox.commandline.arguments.FileArgumentDefinition
          org.fhcrc.cpl.toolbox.commandline.arguments.FileToReadArgumentDefinition

All Implemented Interfaces:

CommandLineArgumentDefinition

Direct Known Subclasses:

FastaFileArgumentDefinition, FeatureFileArgumentDefinition

public class FileToReadArgumentDefinition
extends FileArgumentDefinition
implements CommandLineArgumentDefinition

Nested Class Summary

Nested classes/interfaces inherited from class org.fhcrc.cpl.toolbox.commandline.arguments.FileArgumentDefinition

FileArgumentDefinition.GUIFileChooserButtonListener

Field Summary

Fields inherited from class org.fhcrc.cpl.toolbox.commandline.arguments.FileArgumentDefinition

FILE_TYPE_FEATURE, FILE_TYPE_IMAGE, FILE_TYPE_UNKNOWN, fileType

Fields inherited from class org.fhcrc.cpl.toolbox.commandline.arguments.BaseArgumentDefinitionImpl

mArgumentHelpText, mArgumentName, mDefaultValue, mDisplayName, mIsAdvanced, mRequired

Fields inherited from interface org.fhcrc.cpl.toolbox.commandline.arguments.CommandLineArgumentDefinition

UNNAMED_PARAMETER_VALUE_ARGUMENT, UNNAMED_PARAMETER_VALUE_SERIES_ARGUMENT

Constructor Summary

FileToReadArgumentDefinition(java.lang.String argumentName)

FileToReadArgumentDefinition(java.lang.String argumentName, boolean required, java.lang.String help)

FileToReadArgumentDefinition(java.lang.String argumentName, boolean required, java.lang.String help, int fileType)

FileToReadArgumentDefinition(java.lang.String argumentName, java.lang.String help)

Method Summary

javax.swing.JComponent	addComponentsForGUI(java.awt.Container parent, javax.swing.JDialog parentDialog, java.lang.String defaultValue) Same as base method, but resize the text field
javax.swing.JComponent	addComponentsForGUISeries(java.awt.Container parent, javax.swing.JDialog parentDialog, java.lang.String defaultValue, boolean isDir)
static void	checkFileForReading(java.io.File file)
java.lang.Object	convertArgumentValue(java.lang.String filePath) Create a file for the filepath and make sure we can read it

Methods inherited from class org.fhcrc.cpl.toolbox.commandline.arguments.FileArgumentDefinition

addComponentsForGUI, getFileType, getValueDescriptor, setFileType

Methods inherited from class org.fhcrc.cpl.toolbox.commandline.arguments.BaseArgumentDefinitionImpl

addComponentsForGUISeries, getArgumentDisplayName, getArgumentName, getDefaultValue, getDefaultValueAsString, getDisplayName, getHelpText, getValueFromGUIComponent, hasDefaultValue, isAdvanced, isRequired, setAdvanced, setArgumentDisplayName, setDefaultValue, setDisplayName, setHelpText, setRequired, valueToString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fhcrc.cpl.toolbox.commandline.arguments.CommandLineArgumentDefinition

addComponentsForGUISeries, getArgumentDisplayName, getArgumentName, getDefaultValue, getDefaultValueAsString, getHelpText, getValueDescriptor, getValueFromGUIComponent, hasDefaultValue, isAdvanced, isRequired, setAdvanced, setArgumentDisplayName, setDefaultValue, setHelpText, setRequired, valueToString

Constructor Detail

FileToReadArgumentDefinition

public FileToReadArgumentDefinition(java.lang.String argumentName)

FileToReadArgumentDefinition

public FileToReadArgumentDefinition(java.lang.String argumentName,
                                    java.lang.String help)

FileToReadArgumentDefinition

public FileToReadArgumentDefinition(java.lang.String argumentName,
                                    boolean required,
                                    java.lang.String help)

FileToReadArgumentDefinition

public FileToReadArgumentDefinition(java.lang.String argumentName,
                                    boolean required,
                                    java.lang.String help,
                                    int fileType)

Method Detail

convertArgumentValue

public java.lang.Object convertArgumentValue(java.lang.String filePath)
                                      throws ArgumentValidationException

Create a file for the filepath and make sure we can read it

Specified by:

convertArgumentValue in interface CommandLineArgumentDefinition

Specified by:

convertArgumentValue in class BaseArgumentDefinitionImpl

Parameters:

filePath -

Returns:

the argument as a File

Throws:

ArgumentValidationException - if the argument doesn't validate

checkFileForReading

public static void checkFileForReading(java.io.File file)
                                throws ArgumentValidationException

Throws:

ArgumentValidationException

addComponentsForGUI

public javax.swing.JComponent addComponentsForGUI(java.awt.Container parent,
                                                  javax.swing.JDialog parentDialog,
                                                  java.lang.String defaultValue)

Same as base method, but resize the text field

Specified by:

addComponentsForGUI in interface CommandLineArgumentDefinition

Overrides:

addComponentsForGUI in class BaseArgumentDefinitionImpl

Parameters:

parent -

parentDialog -

defaultValue -

Returns:

addComponentsForGUISeries

public javax.swing.JComponent addComponentsForGUISeries(java.awt.Container parent,
                                                        javax.swing.JDialog parentDialog,
                                                        java.lang.String defaultValue,
                                                        boolean isDir)

Overrides:

addComponentsForGUISeries in class FileArgumentDefinition