ca.uhn.fhir.rest.server

Class SimpleBundleProvider

java.lang.Object

ca.uhn.fhir.rest.server.SimpleBundleProvider

All Implemented Interfaces:

IBundleProvider

public class SimpleBundleProvider
extends Object
implements IBundleProvider

Constructor Summary

Constructors

Constructor and Description
SimpleBundleProvider() Create an empty bundle
SimpleBundleProvider(IBaseResource theResource)
SimpleBundleProvider(List<IBaseResource> theList)

Method Summary

Modifier and Type	Method and Description
InstantDt	getPublished() Returns the instant as of which this result was valid
List<IBaseResource>	getResources(int theFromIndex, int theToIndex) Load the given collection of resources by index, plus any additional resources per the server's processing rules (e.g.
Integer	preferredPageSize() Optionally may be used to signal a preferred page size to the server, e.g.
int	size() Returns the total number of results which match the given query (exclusive of any _include's or OperationOutcome)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleBundleProvider

public SimpleBundleProvider(List<IBaseResource> theList)

SimpleBundleProvider

public SimpleBundleProvider(IBaseResource theResource)

SimpleBundleProvider

public SimpleBundleProvider()

Create an empty bundle

Method Detail

getResources

public List<IBaseResource> getResources(int theFromIndex,
                                        int theToIndex)

Description copied from interface: IBundleProvider

Load the given collection of resources by index, plus any additional resources per the server's processing rules (e.g. _include'd resources, OperationOutcome, etc.). For example, if the method is invoked with index 0,10 the method might return 10 search results, plus an additional 20 resources which matched a client's _include specification.

Specified by:

getResources in interface IBundleProvider

Parameters:

theFromIndex - The low index (inclusive) to return

theToIndex - The high index (exclusive) to return

Returns:

A list of resources. The size of this list must be at least theToIndex - theFromIndex.

size

public int size()

Description copied from interface: IBundleProvider

Returns the total number of results which match the given query (exclusive of any _include's or OperationOutcome)

Specified by:

size in interface IBundleProvider

getPublished

public InstantDt getPublished()

Description copied from interface: IBundleProvider

Returns the instant as of which this result was valid

Specified by:

getPublished in interface IBundleProvider

preferredPageSize

public Integer preferredPageSize()

Description copied from interface: IBundleProvider

Optionally may be used to signal a preferred page size to the server, e.g. because the implementing code recognizes that the resources which will be returned by this implementation are expensive to load so a smaller page size should be used. The value returned by this method will only be used if the client has not explicitly requested a page size.

Specified by:

preferredPageSize in interface IBundleProvider

Returns:

Returns the preferred page size or null