NativeSQLQueryNonScalarReturn (hibernate-core JavaDocs)

java.lang.Object
- org.hibernate.engine.query.spi.sql.NativeSQLQueryNonScalarReturn

All Implemented Interfaces:

java.io.Serializable, NativeSQLQueryReturn

Direct Known Subclasses:

NativeSQLQueryCollectionReturn, NativeSQLQueryJoinReturn, NativeSQLQueryRootReturn
```
public abstract class NativeSQLQueryNonScalarReturn
extends java.lang.Object
implements NativeSQLQueryReturn, java.io.Serializable
```
Represents the base information for a non-scalar return defined as part of a native sql query.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.hibernate.engine.query.spi.sql.NativeSQLQueryReturn
  NativeSQLQueryReturn.TraceLogger

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`NativeSQLQueryNonScalarReturn(java.lang.String alias, java.util.Map<java.lang.String,java.lang.String[]> propertyResults, LockMode lockMode)`	Constructs some form of non-scalar return descriptor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getAlias()`	Retrieve the defined result alias
`LockMode`	`getLockMode()`	Retrieve the lock-mode to apply to this return
`java.util.Map<java.lang.String,java.lang.String[]>`	`getPropertyResultsMap()`	Retrieve the user-supplied column->property mappings.
`int`	`hashCode()`
`void`	`traceLog(NativeSQLQueryReturn.TraceLogger logger)`

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

- Constructor Detail
  - NativeSQLQueryNonScalarReturn
```
protected NativeSQLQueryNonScalarReturn(java.lang.String alias,
                                        java.util.Map<java.lang.String,java.lang.String[]> propertyResults,
                                        LockMode lockMode)
```
    Constructs some form of non-scalar return descriptor
    
    Parameters:
    
    alias - The result alias
    
    propertyResults - Any user-supplied column->property mappings
    
    lockMode - The lock mode to apply to the return.
- Method Detail
  - getAlias
```
public java.lang.String getAlias()
```
    Retrieve the defined result alias
    
    Returns:
    
    The result alias.
  - getLockMode
```
public LockMode getLockMode()
```
    Retrieve the lock-mode to apply to this return
    
    Returns:
    
    The lock mode
  - getPropertyResultsMap
```
public java.util.Map<java.lang.String,java.lang.String[]> getPropertyResultsMap()
```
    Retrieve the user-supplied column->property mappings.
    
    Returns:
    
    The property mappings.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - traceLog
```
public void traceLog(NativeSQLQueryReturn.TraceLogger logger)
```
    Specified by:
    
    traceLog in interface NativeSQLQueryReturn