Package org.gorpipe.querydialogs.argument

Class FileArgument

java.lang.Object

org.gorpipe.querydialogs.BasicBean

org.gorpipe.querydialogs.AbstractListBean

org.gorpipe.querydialogs.Argument

org.gorpipe.querydialogs.argument.FileArgument

All Implemented Interfaces:

Serializable, ListModel

public class FileArgument
extends Argument

Represents an argument that expects a file path.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.gorpipe.querydialogs.Argument

allowedValues, defaultValue, DEFERRED_LIST, path2LoadedValues, path2LoadedValuesHeader, PROPERTY_OPERATOR, PROPERTY_VALUE, type, value

Constructor Summary

Constructors

Constructor	Description
FileArgument(FileArgument arg)	Constructor that copies the input file argument.
FileArgument(ArgumentDescription argDescr, Boolean optional, Object defaultValue, Boolean advanced, Integer displayWidth, String filterFileSuffixes)	Constructor.

Method Summary

Modifier and Type	Method	Description
FileArgument	copyArgument()	Make a copy of the argument.
String[]	getFileFilterComponents()	Get components for file filters (for example ['*.txt', '*.gor']).

Methods inherited from class org.gorpipe.querydialogs.Argument

checkAllowed, deferredValuesLoaded, getDefaultValue, getDescription, getDisplayName, getDisplayWidth, getElementAt, getName, getOperator, getOperators, getSize, getTooltip, getType, getValue, getValuesHeader, getValuesPath, hasDeferredValues, isAdvanced, isEmpty, isOptional, loadDeferredValues, parseValue, setDisplayWidth, setOperator, setValue, setValue, setValuesHeader, toString

Methods inherited from class org.gorpipe.querydialogs.AbstractListBean

addListDataListener, fireContentsChanged, removeListDataListener

Methods inherited from class org.gorpipe.querydialogs.BasicBean

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Constructor Details

FileArgument

public FileArgument(ArgumentDescription argDescr,
 Boolean optional,
 Object defaultValue,
 Boolean advanced,
 Integer displayWidth,
 String filterFileSuffixes)

Constructor.

Parameters:

argDescr - argument description

optional - true if argument is optional, otherwise false

defaultValue - default value

advanced - true if an advanced argument (displayed in advanced section), otherwise false

displayWidth - the width of the argument when displayed

filterFileSuffixes - the file suffixes to use when filtering files to select

FileArgument

public FileArgument(FileArgument arg)

Constructor that copies the input file argument.

Parameters:

arg - the file argument to copy

Method Details

copyArgument

public FileArgument copyArgument()

Description copied from class: Argument

Make a copy of the argument.

Specified by:

copyArgument in class Argument

Returns:

the argument copy

getFileFilterComponents

public String[] getFileFilterComponents()

Get components for file filters (for example ['*.txt', '*.gor']).

Returns:

array of file filter components