Constructor
new module:caplin/grid/filter/LogicalFilterExpression(logicalOperator)
Constructs a new
LogicalFilterExpression
with the specified operator.
Parameters:
Name | Type | Description |
---|---|---|
logicalOperator |
module:caplin/grid/filter/LogicalFilterExpression/Operator | The operator that determines whether this logical filter expression will perform a logical AND or OR. |
- Implements:
Throws:
-
If the specified operator is not
module:caplin/grid/filter/LogicalFilterExpression/Operator.AND
ormodule:caplin/grid/filter/LogicalFilterExpression/Operator.OR
Methods
-
(static) clone(oFilterExpression) → {module:caplin/grid/filter/LogicalFilterExpression}
-
Clones a LogicalFilterExpression
Parameters:
Name Type Description oFilterExpression
module:caplin/grid/filter/FilterExpression The expression to be cloned. Returns:
a new instance of a LogicalFilterExpression with exactly the same state as the passed oFilterExpression. -
addFilterExpression(oFilterExpression)
-
Adds the specified
FilterExpression
to thisLogicalFilterExpression
.Parameters:
Name Type Description oFilterExpression
module:caplin/grid/filter/FilterExpression The expression to be added. -
clone() → {module:caplin/grid/filter/LogicalFilterExpression}
-
Clones this instance of the LogicalFilterExpression
Returns:
a new instance of a LogicalFilterExpression with exactly the same state. -
getFilterExpressions() → {Array}
-
Returns a list of the filter expressions added using
module:caplin/grid/filter/LogicalFilterExpression#addFilterExpression
.The array returned by this method must not be added to or removed from directly — in the future, the array returned may instead be a copy of the internally held array. Instead, the methods on this class should be used to add filter expressions.
Returns:
A list ofmodule:caplin/grid/filter/FilterExpression
items.- Type
- Array
-
getNumberOfFilterExpressions() → {Number}
-
Gets the number of logical filter expressions that have been placed inside the LogicalFilterExpression.
Returns:
Number of Filter expressions added to date.- Type
- Number
-
getOperator() → {module:caplin/grid/filter/LogicalFilterExpression/Operator}
-
Gets the operator for this LogicalFilterExpression
Returns:
The operator for this LogicalFilterExpression -
getRttpState() → {String}
-
Gets the serialized representation of this
LogicalFilterExpression
which is understood by the Container Filtering Module used by Transformer.- Implements:
- See:
Returns:
A serialized representation of this expression.- Type
- String
-
getSerializedState(sIndent) → {String}
-
Gets the XML representation of this
LogicalFilterExpression
that will be used to save it within a serialized component and/or layout.Parameters:
Name Type Description sIndent
String The number of characters the caller would like the expression to indent the XML it returns to make it easily human readable. - Implements:
- See:
Returns:
An XML representation of this expression.- Type
- String
-
toMap()
-
Construct map representing the filter
- Implements:
-
toString() → {String}
-
Gets a text representation of the logical filter expression.
- Implements:
- See:
Returns:
A text representation of the expression.- Type
- String