Package org.gorpipe.querydialogs.argument

Class StringArgument

java.lang.Object

org.gorpipe.querydialogs.BasicBean

org.gorpipe.querydialogs.AbstractListBean

org.gorpipe.querydialogs.Argument

org.gorpipe.querydialogs.argument.StringArgument

All Implemented Interfaces:

java.io.Serializable, javax.swing.ListModel

Direct Known Subclasses:

GridArgument

public class StringArgument
extends Argument

Represents an argument that expects a string value.

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
StringArgument(StringArgument arg)
StringArgument(ArgumentDescription argDescr, boolean quoted, java.lang.Boolean optional, java.lang.Object defaultValue, java.util.List<? extends java.lang.Object> allowedValues, java.net.URI valuesPath, ValueFormatter formatter, java.util.List<java.lang.String> operators, java.lang.Boolean advanced, java.lang.Integer displayWidth, ArgumentType argType, java.lang.Boolean singleSelection)	Constructor.

Method Summary

Modifier and Type	Method	Description
StringArgument	copyArgument()	Make a copy of the argument.
java.lang.String	getFormat()	Get the format for the string argument.
java.lang.String	getFormattedValue()
ValueFormatter	getFormatter()
FilteringColumnDefinition	getHelpDefinition()	Get help definition for argument.
java.lang.Object	getPersistingValueObject()	Get the persisting value.
boolean	isEmpty()	Get if argument is empty.
boolean	isSingleSelection()	Check if only single selection is allowed for argument.
void	setFormat(java.lang.String format)
void	setHelpDefinition(FilteringColumnDefinition helpDefinition)	Set help definition for argument.
void	setPersistingValueObject(SubjectLists persistingValueObject)	Set the persisting value.

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, isOptional, loadDeferredValues, parseValue, setDisplayWidth, setOperator, setValue, setValue, 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 Detail

StringArgument

public StringArgument(ArgumentDescription argDescr,
                      boolean quoted,
                      java.lang.Boolean optional,
                      java.lang.Object defaultValue,
                      java.util.List<? extends java.lang.Object> allowedValues,
                      java.net.URI valuesPath,
                      ValueFormatter formatter,
                      java.util.List<java.lang.String> operators,
                      java.lang.Boolean advanced,
                      java.lang.Integer displayWidth,
                      ArgumentType argType,
                      java.lang.Boolean singleSelection)

Constructor.

StringArgument

public StringArgument(StringArgument arg)

Method Detail

getFormat

public java.lang.String getFormat()

Get the format for the string argument.

Returns:

the format for the string argument

setFormat

public void setFormat(java.lang.String format)

getFormattedValue

public java.lang.String getFormattedValue()

getHelpDefinition

public FilteringColumnDefinition getHelpDefinition()

Get help definition for argument.

Returns:

the help definition

setHelpDefinition

public void setHelpDefinition(FilteringColumnDefinition helpDefinition)

Set help definition for argument.

Parameters:

helpDefinition - the help definition to set

getPersistingValueObject

public java.lang.Object getPersistingValueObject()

Get the persisting value.

Returns:

the persisting value

setPersistingValueObject

public void setPersistingValueObject(SubjectLists persistingValueObject)

Set the persisting value.

Parameters:

persistingValueObject - the persisting value

copyArgument

public StringArgument copyArgument()

Description copied from class: Argument

Make a copy of the argument.

Specified by:

copyArgument in class Argument

Returns:

the argument copy

isSingleSelection

public boolean isSingleSelection()

Check if only single selection is allowed for argument.

Returns:

true if only single selection is allowed for argument, otherwise false

isEmpty

public boolean isEmpty()

Description copied from class: Argument

Get if argument is empty.

Overrides:

isEmpty in class Argument

Returns:

true if argument is empty, otherwise false

getFormatter

public ValueFormatter getFormatter()