com.microsoft.services.orc.core

Class OrcCollectionFetcher<TEntity,TFetcher extends OrcEntityFetcher,TOperations extends OrcOperations>

java.lang.Object

com.microsoft.services.orc.core.OrcExecutable

com.microsoft.services.orc.core.OrcFetcher<TEntity>

com.microsoft.services.orc.core.OrcCollectionFetcher<TEntity,TFetcher,TOperations>

Type Parameters:

TEntity - the type parameter

TFetcher - the type parameter

TOperations - the type parameter

All Implemented Interfaces:

Readable<java.util.List<TEntity>>

Direct Known Subclasses:

MultipartCollectionFetcher

public class OrcCollectionFetcher<TEntity,TFetcher extends OrcEntityFetcher,TOperations extends OrcOperations>
extends OrcFetcher<TEntity>
implements Readable<java.util.List<TEntity>>

The type OrcCollectionFetcher.

Field Summary

Fields inherited from class com.microsoft.services.orc.core.OrcFetcher

clazz, parent, urlComponent

Constructor Summary

Constructors

Constructor and Description
OrcCollectionFetcher(java.lang.String urlComponent, OrcExecutable parent, java.lang.Class<TEntity> clazz, java.lang.Class<TOperations> operationClazz) Instantiates a new OrcCollectionFetcher.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<TEntity>	add(TEntity entity) Add listenable future.
OrcCollectionFetcher<TEntity,TFetcher,TOperations>	addHeader(java.lang.String name, java.lang.String value) Add header.
OrcCollectionFetcher<TEntity,TFetcher,TOperations>	addParameter(java.lang.String name, java.lang.Object value) Add parameter.
com.google.common.util.concurrent.ListenableFuture<java.lang.String>	addRaw(java.lang.String payload) Add raw.
OrcCollectionFetcher<TEntity,TFetcher,TOperations>	expand(java.lang.String expand) Expand OrcCollectionFetcher.
OrcCollectionFetcher<TEntity,TFetcher,TOperations>	filter(java.lang.String filter) Filter OrcCollectionFetcher.
TFetcher	getById(java.lang.String id) Gets by id.
TOperations	getOperations() Gets operations.
protected com.google.common.util.concurrent.ListenableFuture<OrcResponse>	oDataExecute(Request request) OData execute.
OrcCollectionFetcher<TEntity,TFetcher,TOperations>	orderBy(java.lang.String orderBy) Order OrcCollectionFetcher.
com.google.common.util.concurrent.ListenableFuture<java.util.List<TEntity>>	read() Reads
com.google.common.util.concurrent.ListenableFuture<java.lang.String>	readRaw() Reads raw
void	reset() Reset void.
OrcCollectionFetcher<TEntity,TFetcher,TOperations>	select(java.lang.String select) Select OrcCollectionFetcher.
protected void	setPathForCollections(OrcURL url, java.lang.String urlComponent, int top, int skip, java.lang.String select, java.lang.String expand, java.lang.String filter, java.lang.String orderBy) Sets path for collections.
OrcCollectionFetcher<TEntity,TFetcher,TOperations>	skip(int skip) Skip OrcCollectionFetcher.
OrcCollectionFetcher<TEntity,TFetcher,TOperations>	top(int top) Top OrcCollectionFetcher.

Methods inherited from class com.microsoft.services.orc.core.OrcFetcher

addByteArrayResultCallback, getResolver, setSelectorUrl

Methods inherited from class com.microsoft.services.orc.core.OrcExecutable

addCustomHeader, addCustomParameter, as, getHeaders, getParameters, log

Methods inherited from class java.lang.Object

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

Constructor Detail

OrcCollectionFetcher

public OrcCollectionFetcher(java.lang.String urlComponent,
                    OrcExecutable parent,
                    java.lang.Class<TEntity> clazz,
                    java.lang.Class<TOperations> operationClazz)

Instantiates a new OrcCollectionFetcher.

Parameters:

urlComponent - the url component

parent - the parent

clazz - the clazz

operationClazz - the operation clazz

Method Detail

reset

public void reset()

Reset void.

top

public OrcCollectionFetcher<TEntity,TFetcher,TOperations> top(int top)

Top OrcCollectionFetcher.

Parameters:

top - the top

Returns:

the o data collection fetcher

skip

public OrcCollectionFetcher<TEntity,TFetcher,TOperations> skip(int skip)

Skip OrcCollectionFetcher.

Parameters:

skip - the skip

Returns:

the o data collection fetcher

select

public OrcCollectionFetcher<TEntity,TFetcher,TOperations> select(java.lang.String select)

Select OrcCollectionFetcher.

Parameters:

select - the select

Returns:

the o data collection fetcher

expand

public OrcCollectionFetcher<TEntity,TFetcher,TOperations> expand(java.lang.String expand)

Expand OrcCollectionFetcher.

Parameters:

expand - the expand

Returns:

the o data collection fetcher

filter

public OrcCollectionFetcher<TEntity,TFetcher,TOperations> filter(java.lang.String filter)

Filter OrcCollectionFetcher.

Parameters:

filter - the filter

Returns:

the o data collection fetcher

orderBy

public OrcCollectionFetcher<TEntity,TFetcher,TOperations> orderBy(java.lang.String orderBy)

Order OrcCollectionFetcher.

Parameters:

orderBy - the orderBy

Returns:

the o data collection fetcher

getById

public TFetcher getById(java.lang.String id)

Gets by id.

Parameters:

id - the id

Returns:

the by id

oDataExecute

protected com.google.common.util.concurrent.ListenableFuture<OrcResponse> oDataExecute(Request request)

Description copied from class: OrcExecutable

OData execute.

Specified by:

oDataExecute in class OrcExecutable

Parameters:

request - the request

Returns:

the listenable future

read

public com.google.common.util.concurrent.ListenableFuture<java.util.List<TEntity>> read()

Reads

Specified by:

read in interface Readable<java.util.List<TEntity>>

Returns:

the listenable future

readRaw

public com.google.common.util.concurrent.ListenableFuture<java.lang.String> readRaw()

Reads raw

Specified by:

readRaw in interface Readable<java.util.List<TEntity>>

Overrides:

readRaw in class OrcFetcher<TEntity>

Returns:

the listenable future

add

public com.google.common.util.concurrent.ListenableFuture<TEntity> add(TEntity entity)

Add listenable future.

Parameters:

entity - the entity

Returns:

the listenable future

addRaw

public com.google.common.util.concurrent.ListenableFuture<java.lang.String> addRaw(java.lang.String payload)

Add raw.

Parameters:

payload - the payload

Returns:

the listenable future

getOperations

public TOperations getOperations()

Gets operations.

Returns:

the operations

addParameter

public OrcCollectionFetcher<TEntity,TFetcher,TOperations> addParameter(java.lang.String name,
                                                              java.lang.Object value)

Add parameter.

Parameters:

name - the name

value - the value

Returns:

the OrcCollectionFetcher

addHeader

public OrcCollectionFetcher<TEntity,TFetcher,TOperations> addHeader(java.lang.String name,
                                                           java.lang.String value)

Add header.

Parameters:

name - the name

value - the value

Returns:

the OrcCollectionFetcher

setPathForCollections

protected void setPathForCollections(OrcURL url,
                         java.lang.String urlComponent,
                         int top,
                         int skip,
                         java.lang.String select,
                         java.lang.String expand,
                         java.lang.String filter,
                         java.lang.String orderBy)

Sets path for collections.

Parameters:

url - the url

urlComponent - the url component

top - the top

skip - the skip

select - the select

expand - the expand

filter - the filter

orderBy - the order by