IncrementalSmartQuery (Nuxeo ECM Projects 10.1 API)

java.lang.Object
- org.nuxeo.ecm.platform.smart.query.IncrementalSmartQuery

All Implemented Interfaces:

Serializable, SmartQuery

Direct Known Subclasses:

IncrementalSmartNXQLQuery
```
public abstract class IncrementalSmartQuery
extends Object
implements SmartQuery
```
Smart query providing all the needed methods for UI interaction that will make it possible to build a query adding clauses step by step.
Specific getters and setters have been defined instead of a generic one for a better resolution of target types.

Since:

5.4

Author:

Anahide Tchertchian

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`addNotOperator` Boolean indicating if the query part to add should be negated (for instance by adding the 'NOT' marker before)
`protected Boolean`	`booleanValue` Boolean value binding.
`protected Boolean`	`closeParenthesis` Boolean indicating if an closed parenthesis should be added after the query part to add.
`protected String`	`conditionalOperator` String representing the conditional operator to use when building the query part to add (for instance '=', 'LIKE',...)
`protected Date`	`datetimeValue` Date and time value binding.
`protected Date`	`dateValue` Date value binding
`protected Boolean`	`escapeValue`
`protected String`	`existingQueryPart` Stores the current existing query part.
`protected Double`	`floatValue` Float value binding.
`protected Long`	`integerValue` Integer value binding.
`protected String`	`leftExpression` String typically representing the search index for the query part to add.
`protected String`	`logicalOperator` String containing the logical operator at start of the query part to add (for instance 'AND' or 'OR').
`protected Boolean`	`openParenthesis` Boolean indicating if an open parenthesis should be added prior to the query part to add.
`protected Date`	`otherDatetimeValue` Another date and time value binding (useful when using the 'BETWEEN' operator for instance)
`protected Date`	`otherDateValue` Another date value binding (useful when using the 'BETWEEN' operator for instance)
`protected String`	`selectedRowName` Marker for layout row selection that will make it possible to display only the widgets defined in this row for the rest of the query part definition.
`protected String[]`	`stringArrayValue` String array value binding.
`protected List<String>`	`stringListValue` String list value binding.
`protected String`	`stringValue` String value binding.
`protected Object`	`value` Generic set value for the new query part to add.

Constructor Summary

Constructors
Constructor and Description

IncrementalSmartQuery(String existingQueryPart)

Constructors
Constructor and Description
`IncrementalSmartQuery(String existingQueryPart)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`clear()` Clears all field values, except the existing quedry part.
`protected void`	`clearValues()` Clears all value bindings.
`Boolean`	`getAddNotOperator()`
`Boolean`	`getBooleanValue()`
`Boolean`	`getCloseParenthesis()`
`String`	`getConditionalOperator()`
`Date`	`getDatetimeValue()`
`Date`	`getDateValue()`
`Boolean`	`getEscapeValue()`
`String`	`getExistingQueryPart()`
`Double`	`getFloatValue()`
`Long`	`getIntegerValue()`
`String`	`getLeftExpression()`
`String`	`getLogicalOperator()`
`Boolean`	`getOpenParenthesis()`
`Date`	`getOtherDatetimeValue()`
`Date`	`getOtherDateValue()`
`String`	`getSelectedRowName()`
`List<String>`	`getSelectedRowNames()`
`boolean`	`getShowAddNotOperator()`
`boolean`	`getShowCloseParenthesis()` Returns true if there are strictly more open parenthesis in the existing query part than closed ones.
`boolean`	`getShowLogicalOperator()` Returns true if existing query part is not empty.
`boolean`	`getShowOpenParenthesis()` Returns true
`String[]`	`getStringArrayValue()`
`List<String>`	`getStringListValue()`
`String`	`getStringValue()`
`Object`	`getValue()`
`void`	`setAddNotOperator(Boolean addNotOperator)`
`void`	`setBooleanValue(Boolean booleanValue)`
`void`	`setCloseParenthesis(Boolean closeParenthesis)`
`void`	`setConditionalOperator(String conditionalOperator)` Sets the conditional operator.
`void`	`setDatetimeValue(Date datetimeValue)`
`void`	`setDateValue(Date dateValue)`
`void`	`setEscapeValue(Boolean escapeValue)`
`void`	`setExistingQueryPart(String existingQueryPart)`
`void`	`setFloatValue(Double floatValue)`
`void`	`setIntegerValue(Long integerValue)`
`void`	`setLeftExpression(String leftExpression)`
`void`	`setLogicalOperator(String logicalOperator)`
`void`	`setOpenParenthesis(Boolean openParenthesis)`
`void`	`setOtherDatetimeValue(Date otherDatetimeValue)`
`void`	`setOtherDateValue(Date otherDateValue)`
`void`	`setSelectedRowName(String selectedRowName)` Sets the selected row name.
`void`	`setStringArrayValue(String[] stringArrayValue)`
`void`	`setStringListValue(List<String> stringListValue)`
`void`	`setStringValue(String stringValue)`
`void`	`setValue(Object value)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.platform.smart.query.SmartQuery
buildQuery, isValid

- Field Detail
  - existingQueryPart
```
protected String existingQueryPart
```
    Stores the current existing query part.
    This does not need to be a valid query as it can still be refined after.
  - logicalOperator
```
protected String logicalOperator
```
    String containing the logical operator at start of the query part to add (for instance 'AND' or 'OR').
  - addNotOperator
```
protected Boolean addNotOperator
```
    Boolean indicating if the query part to add should be negated (for instance by adding the 'NOT' marker before)
  - openParenthesis
```
protected Boolean openParenthesis
```
    Boolean indicating if an open parenthesis should be added prior to the query part to add.
  - closeParenthesis
```
protected Boolean closeParenthesis
```
    Boolean indicating if an closed parenthesis should be added after the query part to add.
  - selectedRowName
```
protected String selectedRowName
```
    Marker for layout row selection that will make it possible to display only the widgets defined in this row for the rest of the query part definition.
  - leftExpression
```
protected String leftExpression
```
    String typically representing the search index for the query part to add.
  - conditionalOperator
```
protected String conditionalOperator
```
    String representing the conditional operator to use when building the query part to add (for instance '=', 'LIKE',...)
  - escapeValue
```
protected Boolean escapeValue
```
  - value
```
protected Object value
```
    Generic set value for the new query part to add.
    Holds the last value set on one of the specific value setters.
  - booleanValue
```
protected Boolean booleanValue
```
    Boolean value binding.
  - stringValue
```
protected String stringValue
```
    String value binding.
  - stringListValue
```
protected List<String> stringListValue
```
    String list value binding.
  - stringArrayValue
```
protected String[] stringArrayValue
```
    String array value binding.
  - datetimeValue
```
protected Date datetimeValue
```
    Date and time value binding.
  - otherDatetimeValue
```
protected Date otherDatetimeValue
```
    Another date and time value binding (useful when using the 'BETWEEN' operator for instance)
  - dateValue
```
protected Date dateValue
```
    Date value binding
  - otherDateValue
```
protected Date otherDateValue
```
    Another date value binding (useful when using the 'BETWEEN' operator for instance)
  - integerValue
```
protected Long integerValue
```
    Integer value binding.
  - floatValue
```
protected Double floatValue
```
    Float value binding.
- Constructor Detail
  - IncrementalSmartQuery
```
public IncrementalSmartQuery(String existingQueryPart)
```
- Method Detail
  - getExistingQueryPart
```
public String getExistingQueryPart()
```
  - setExistingQueryPart
```
public void setExistingQueryPart(String existingQueryPart)
```
  - getShowLogicalOperator
```
public boolean getShowLogicalOperator()
```
    Returns true if existing query part is not empty.
  - getLogicalOperator
```
public String getLogicalOperator()
```
  - setLogicalOperator
```
public void setLogicalOperator(String logicalOperator)
```
  - getShowAddNotOperator
```
public boolean getShowAddNotOperator()
```
  - getAddNotOperator
```
public Boolean getAddNotOperator()
```
  - setAddNotOperator
```
public void setAddNotOperator(Boolean addNotOperator)
```
  - getShowOpenParenthesis
```
public boolean getShowOpenParenthesis()
```
    Returns true
  - getOpenParenthesis
```
public Boolean getOpenParenthesis()
```
  - setOpenParenthesis
```
public void setOpenParenthesis(Boolean openParenthesis)
```
  - getShowCloseParenthesis
```
public boolean getShowCloseParenthesis()
```
    Returns true if there are strictly more open parenthesis in the existing query part than closed ones.
  - getCloseParenthesis
```
public Boolean getCloseParenthesis()
```
  - setCloseParenthesis
```
public void setCloseParenthesis(Boolean closeParenthesis)
```
  - getSelectedRowName
```
public String getSelectedRowName()
```
  - setSelectedRowName
```
public void setSelectedRowName(String selectedRowName)
```
    Sets the selected row name.
    Also resets the left expression, conditional operator, and all value bindings, as they may be set to values that are not relevant in this new row context.
  - getSelectedRowNames
```
public List<String> getSelectedRowNames()
```
  - getLeftExpression
```
public String getLeftExpression()
```
  - setLeftExpression
```
public void setLeftExpression(String leftExpression)
```
  - getConditionalOperator
```
public String getConditionalOperator()
```
  - setConditionalOperator
```
public void setConditionalOperator(String conditionalOperator)
```
    Sets the conditional operator.
    Also resets all the value bindings, as they may be set to values that are not relevant in this new conditional operator context.
  - getEscapeValue
```
public Boolean getEscapeValue()
```
  - setEscapeValue
```
public void setEscapeValue(Boolean escapeValue)
```
  - getValue
```
public Object getValue()
```
  - setValue
```
public void setValue(Object value)
```
  - getBooleanValue
```
public Boolean getBooleanValue()
```
  - setBooleanValue
```
public void setBooleanValue(Boolean booleanValue)
```
  - getStringValue
```
public String getStringValue()
```
  - setStringValue
```
public void setStringValue(String stringValue)
```
  - getStringListValue
```
public List<String> getStringListValue()
```
  - setStringListValue
```
public void setStringListValue(List<String> stringListValue)
```
  - getStringArrayValue
```
public String[] getStringArrayValue()
```
  - setStringArrayValue
```
public void setStringArrayValue(String[] stringArrayValue)
```
  - getDatetimeValue
```
public Date getDatetimeValue()
```
  - setDatetimeValue
```
public void setDatetimeValue(Date datetimeValue)
```
  - getOtherDatetimeValue
```
public Date getOtherDatetimeValue()
```
  - setOtherDatetimeValue
```
public void setOtherDatetimeValue(Date otherDatetimeValue)
```
  - getDateValue
```
public Date getDateValue()
```
  - setDateValue
```
public void setDateValue(Date dateValue)
```
  - getOtherDateValue
```
public Date getOtherDateValue()
```
  - setOtherDateValue
```
public void setOtherDateValue(Date otherDateValue)
```
  - getIntegerValue
```
public Long getIntegerValue()
```
  - setIntegerValue
```
public void setIntegerValue(Long integerValue)
```
  - getFloatValue
```
public Double getFloatValue()
```
  - setFloatValue
```
public void setFloatValue(Double floatValue)
```
  - clear
```
protected void clear()
```
    Clears all field values, except the existing quedry part.
  - clearValues
```
protected void clearValues()
```
    Clears all value bindings.

Class IncrementalSmartQuery

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.nuxeo.ecm.platform.smart.query.SmartQuery

Field Detail

existingQueryPart

logicalOperator

addNotOperator

openParenthesis

closeParenthesis

selectedRowName

leftExpression

conditionalOperator

escapeValue

value

booleanValue

stringValue

stringListValue

stringArrayValue

datetimeValue

otherDatetimeValue

dateValue

otherDateValue

integerValue

floatValue

Constructor Detail

IncrementalSmartQuery

Method Detail

getExistingQueryPart

setExistingQueryPart

getShowLogicalOperator

getLogicalOperator

setLogicalOperator

getShowAddNotOperator

getAddNotOperator

setAddNotOperator

getShowOpenParenthesis

getOpenParenthesis

setOpenParenthesis

getShowCloseParenthesis

getCloseParenthesis

setCloseParenthesis

getSelectedRowName

setSelectedRowName

getSelectedRowNames

getLeftExpression

setLeftExpression

getConditionalOperator

setConditionalOperator

getEscapeValue

setEscapeValue

getValue

setValue

getBooleanValue

setBooleanValue

getStringValue

setStringValue

getStringListValue

setStringListValue

getStringArrayValue

setStringArrayValue

getDatetimeValue

setDatetimeValue

getOtherDatetimeValue

setOtherDatetimeValue

getDateValue

setDateValue

getOtherDateValue

setOtherDateValue

getIntegerValue

setIntegerValue

getFloatValue

setFloatValue

clear

clearValues