Package com.im.df.api.dml

Class Operators.ShortcutOperator

java.lang.Object

com.im.df.api.dml.DFOperator

com.im.df.api.dml.Operators.SimpleFieldValuesOperator

com.im.df.api.dml.Operators.ShortcutOperator

Enclosing class:

Operators

public static final class Operators.ShortcutOperator
extends Operators.SimpleFieldValuesOperator

Shortcut operator is used to define a shortcut for existing operator with predefined operands.

Since:

6.4

Constructor Summary

Constructors

Constructor	Description
ShortcutOperator(java.lang.String persistName, java.lang.String displayName, java.lang.Class[] allowedCapabilities, DFOperator operator, java.lang.Object[] values)	Constructor for shortcut operator.

Method Summary

Modifier and Type	Method	Description
DFOperator	getOperator()	Returns the operator represented by shortcut.
java.lang.Object[]	getValues()	Returns the shortcut operators values.

Methods inherited from class com.im.df.api.dml.Operators.SimpleFieldValuesOperator

getValidFormatMsg, isEmptyStringAllowed, isFieldAcceptableAsOperand, parseOperands, validate

Methods inherited from class com.im.df.api.dml.DFOperator

correctNumberOfOperands, getDisplayName, getDisplayNameInExpression, getMaxOperands, getMinOperands, getPersistName, getStartingWith, getStartingWithOperator, getToStringPart, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ShortcutOperator

public ShortcutOperator(java.lang.String persistName,
                        java.lang.String displayName,
                        java.lang.Class[] allowedCapabilities,
                        DFOperator operator,
                        java.lang.Object[] values)
                 throws java.lang.IllegalArgumentException

Constructor for shortcut operator.

Parameters:

persistName - Name used to persist the operator.

displayName - Shortcuts display name.

allowedCapabilities - Fields where the shortcut is allowed.

operator - The represented operator.

values - The default values for operator - not tested whether the values are applicable.

Throws:

java.lang.IllegalArgumentException - when the shortcut is allowed in field where it's parent operator is not allowed.

Method Detail

getOperator

public DFOperator getOperator()

Returns the operator represented by shortcut.

Returns:

operator.

getValues

public java.lang.Object[] getValues()

Returns the shortcut operators values.

Returns:

The values for the operator.