com.netflix.astyanax.entitystore

Class NativeQuery<T,K>

java.lang.Object

com.netflix.astyanax.entitystore.NativeQuery<T,K>

Type Parameters:

T -

K -

public abstract class NativeQuery<T,K>
extends java.lang.Object

SQL'ish like fluent API for defining a query. This is mainly used by the various entity mappers to query for a subset of columns. Each entity mapper stores data differently and will use the predicates here to make the correct lower level query.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	NativeQuery.NativeColumnQuery Refine query for column range or slice
class	NativeQuery.NativeIdQuery Refine query for row key

Field Summary

Fields

Modifier and Type	Field and Description
protected int	columnLimit
protected java.util.Collection<java.lang.Object>	columnNames
protected java.util.List<K>	ids
protected java.util.List<com.netflix.astyanax.query.ColumnPredicate>	predicates

Constructor Summary

Constructors

Constructor and Description
NativeQuery()

Method Summary

Modifier and Type	Method and Description
abstract java.util.Collection<T>	getResultSet() Return a result set of entities
abstract java.util.Map<K,java.util.Collection<T>>	getResultSetById() Get the result set as a mapping of the id field to a collection of entities.
abstract java.util.Map<K,java.lang.Integer>	getResultSetCounts() Get the column count for each id in the query without sending data back to the client.
abstract T	getSingleResult() Return a single entity (or first) response
NativeQuery<T,K>	limit(int columnLimit)
NativeQuery.NativeColumnQuery	whereColumn(java.lang.String name)
NativeQuery.NativeIdQuery	whereId()

Methods inherited from class java.lang.Object

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

Field Detail

ids

protected java.util.List<K> ids

columnNames

protected java.util.Collection<java.lang.Object> columnNames

predicates

protected java.util.List<com.netflix.astyanax.query.ColumnPredicate> predicates

columnLimit

protected int columnLimit

Constructor Detail

NativeQuery

public NativeQuery()

Method Detail

whereId

public NativeQuery.NativeIdQuery whereId()

whereColumn

public NativeQuery.NativeColumnQuery whereColumn(java.lang.String name)

limit

public NativeQuery<T,K> limit(int columnLimit)

getSingleResult

public abstract T getSingleResult()
                           throws java.lang.Exception

Return a single entity (or first) response

Returns:

Throws:

java.lang.Exception

getResultSet

public abstract java.util.Collection<T> getResultSet()
                                              throws java.lang.Exception

Return a result set of entities

Returns:

Throws:

java.lang.Exception

getResultSetById

public abstract java.util.Map<K,java.util.Collection<T>> getResultSetById()
                                                                   throws java.lang.Exception

Get the result set as a mapping of the id field to a collection of entities. This is useful for a multi-get scenario where it is desirable to group all the 'entities' within a row.

Returns:

Throws:

java.lang.Exception

getResultSetCounts

public abstract java.util.Map<K,java.lang.Integer> getResultSetCounts()
                                                               throws java.lang.Exception

Get the column count for each id in the query without sending data back to the client.

Returns:

Throws:

Excerption

java.lang.Exception