ca.uhn.fhir.model.api

Class Bundle

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseBundle

ca.uhn.fhir.model.api.Bundle

All Implemented Interfaces:

IElement, ISupportsUndeclaredExtensions, Serializable, IBase

public class Bundle
extends BaseBundle
implements IBase

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Bundle()

Method Summary

Modifier and Type	Method and Description
Tag	addCategory() Deprecated. Tags wil become immutable in a future release of HAPI, so addCategory(String, String, String) should be used instead
void	addCategory(String theScheme, String theTerm, String theLabel)
void	addCategory(Tag theTag)
BundleEntry	addEntry() Adds and returns a new bundle entry
void	addEntry(BundleEntry theBundleEntry) Adds a new entry
BundleEntry	addResource(IResource theResource, FhirContext theContext, String theServerBase) Creates a new entry using the given resource and populates it accordingly
StringDt	getBundleId()
TagList	getCategories()
List<BundleEntry>	getEntries()
StringDt	getLinkBase()
StringDt	getLinkFirst()
StringDt	getLinkLast()
StringDt	getLinkNext()
StringDt	getLinkPrevious()
StringDt	getLinkSelf()
IResource	getResourceById(IdDt theId) Retrieves a resource from a bundle given its logical ID.
ResourceMetadataMap	getResourceMetadata()
<T extends IResource> List<T>	getResources(Class<T> theClass) Returns a list containing all resources of the given type from this bundle
StringDt	getTitle()
IntegerDt	getTotalResults()
BoundCodeDt<BundleTypeEnum>	getType()
InstantDt	getUpdated()
boolean	isEmpty() Returns true if this bundle contains zero entries
void	setCategories(TagList theCategories)
int	size()
List<IResource>	toListOfResources()
String	toString()
static Bundle	withResources(List<IResource> theResources, FhirContext theContext, String theServerBase)
static Bundle	withSingleResource(IResource theResource)

Methods inherited from class ca.uhn.fhir.model.api.BaseBundle

getAuthorName, getAuthorUri, getId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object

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

Constructor Detail

Bundle

public Bundle()

Method Detail

addCategory

@Deprecated
public Tag addCategory()

Deprecated. Tags wil become immutable in a future release of HAPI, so addCategory(String, String, String) should be used instead

addCategory

public void addCategory(String theScheme,
                        String theTerm,
                        String theLabel)

addCategory

public void addCategory(Tag theTag)

addEntry

public BundleEntry addEntry()

Adds and returns a new bundle entry

addEntry

public void addEntry(BundleEntry theBundleEntry)

Adds a new entry

Parameters:

theBundleEntry - The entry to add

addResource

public BundleEntry addResource(IResource theResource,
                               FhirContext theContext,
                               String theServerBase)

Creates a new entry using the given resource and populates it accordingly

Parameters:

theResource - The resource to add

Returns:

Returns the newly created bundle entry that was added to the bundle

getBundleId

public StringDt getBundleId()

getCategories

public TagList getCategories()

getEntries

public List<BundleEntry> getEntries()

getLinkBase

public StringDt getLinkBase()

getLinkFirst

public StringDt getLinkFirst()

getLinkLast

public StringDt getLinkLast()

getLinkNext

public StringDt getLinkNext()

getLinkPrevious

public StringDt getLinkPrevious()

getLinkSelf

public StringDt getLinkSelf()

getResourceById

public IResource getResourceById(IdDt theId)

Retrieves a resource from a bundle given its logical ID.

Important usage notes: This method ignores base URLs (so passing in an ID of http://foo/Patient/123 will return a resource if it has the logical ID of http://bar/Patient/123. Also, this method is intended to be used for bundles which have already been populated. It will cache its results for fast performance, but that means that modifications to the bundle after this method is called may not be accurately reflected.

Parameters:

theId - The resource ID

Returns:

Returns the resource with the given ID, or null if none is found

getResourceMetadata

public ResourceMetadataMap getResourceMetadata()

getResources

public <T extends IResource> List<T> getResources(Class<T> theClass)

Returns a list containing all resources of the given type from this bundle

getTitle

public StringDt getTitle()

getTotalResults

public IntegerDt getTotalResults()

getType

public BoundCodeDt<BundleTypeEnum> getType()

getUpdated

public InstantDt getUpdated()

isEmpty

public boolean isEmpty()

Returns true if this bundle contains zero entries

Specified by:

isEmpty in interface IBase

Overrides:

isEmpty in class BaseBundle

setCategories

public void setCategories(TagList theCategories)

size

public int size()

toListOfResources

public List<IResource> toListOfResources()

toString

public String toString()

Overrides:

toString in class Object

withResources

public static Bundle withResources(List<IResource> theResources,
                                   FhirContext theContext,
                                   String theServerBase)

withSingleResource

public static Bundle withSingleResource(IResource theResource)