MapLiteral (DataNucleus RDBMS plugin 6.0.1-SNAPSHOT API)

java.lang.Object
- org.datanucleus.store.rdbms.sql.expression.SQLExpression
- - org.datanucleus.store.rdbms.sql.expression.MapExpression
  - - org.datanucleus.store.rdbms.sql.expression.MapLiteral

All Implemented Interfaces:

SQLLiteral
```
public class MapLiteral
extends MapExpression
implements SQLLiteral
```
An SQL expression that will test if a column of a table falls within the given Map. This is used for queries where a Map is passed in as a parameter.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`MapLiteral.MapKeyLiteral`	An SQL expression that will test if a column of a table falls within the given Map's keys.
`static class`	`MapLiteral.MapValueLiteral`	An SQL expression that will test if a column of a table falls within the given Map's values.

Nested classes/interfaces inherited from class org.datanucleus.store.rdbms.sql.expression.SQLExpression
SQLExpression.ColumnExpressionList

Field Summary
- Fields inherited from class org.datanucleus.store.rdbms.sql.expression.SQLExpression
  lowestOperator, mapping, parameterName, st, stmt, subExprs, table

Constructor Summary

Constructors
Constructor	Description
`MapLiteral(SQLStatement stmt, JavaTypeMapping mapping, Object value, String parameterName)`	Constructor for a map literal with a value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MapLiteral.MapKeyLiteral`	`getKeyLiteral()`
`Object`	`getValue()`	Accessor to the literal value
`MapLiteral.MapValueLiteral`	`getValueLiteral()`
`void`	`setNotParameter()`	Method to set this literal as not being a parameter.

Methods inherited from class org.datanucleus.store.rdbms.sql.expression.MapExpression
eq, getAliasForMapTable, invoke, ne, setAliasForMapTable

Methods inherited from class org.datanucleus.store.rdbms.sql.expression.SQLExpression
add, and, bitAnd, bitOr, cast, com, distinct, div, encloseInParentheses, eor, ge, getJavaTypeMapping, getLowestOperator, getNumberOfSubExpressions, getParameterName, getSQLStatement, getSQLTable, getSubExpression, gt, in, ior, is, isParameter, le, lt, mod, mul, neg, not, setJavaTypeMapping, sub, toSQLText, unDistinct

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

- Constructor Detail
  - MapLiteral
```
public MapLiteral(SQLStatement stmt,
                  JavaTypeMapping mapping,
                  Object value,
                  String parameterName)
```
    Constructor for a map literal with a value.
    
    Parameters:
    
    stmt - The SQLStatement the MapLiteral will be used in.
    
    mapping - The mapping to the Map
    
    value - The Map that is the value.
    
    parameterName - Name of the parameter that this represents if any (JDBC "?")
- Method Detail
  - getValue
```
public Object getValue()
```
    Description copied from interface: SQLLiteral
    
    Accessor to the literal value
    
    Specified by:
    
    getValue in interface SQLLiteral
    
    Returns:
    
    the value of the literal
  - getKeyLiteral
```
public MapLiteral.MapKeyLiteral getKeyLiteral()
```
  - getValueLiteral
```
public MapLiteral.MapValueLiteral getValueLiteral()
```
  - setNotParameter
```
public void setNotParameter()
```
    Description copied from interface: SQLLiteral
    
    Method to set this literal as not being a parameter. If the literal if not currently a parameter then does nothing. Updates any underlying SQL to have the value.
    
    Specified by:
    
    setNotParameter in interface SQLLiteral