Package ca.uhn.fhir.interceptor.model

Class RequestPartitionId

java.lang.Object

ca.uhn.fhir.interceptor.model.RequestPartitionId

All Implemented Interfaces:

IModelJson

public class RequestPartitionId
extends Object
implements IModelJson

Since:

5.0.0

Field Summary

Fields inherited from interface ca.uhn.fhir.model.api.IModelJson

SENSITIVE_DATA_FILTER_NAME

Method Summary

Modifier and Type	Method	Description
static RequestPartitionId	allPartitions()
String	asJson()
boolean	contains(RequestPartitionId theOther)	Returns true if this partition definition contains the other.
static RequestPartitionId	defaultPartition()	Deprecated. use defaultPartition(IDefaultPartitionSettings) instead
static RequestPartitionId	defaultPartition(IDefaultPartitionSettings theDefaultPartitionSettings)	Creates a RequestPartitionId for the default partition using the provided partition settings.
static RequestPartitionId	defaultPartition(LocalDate thePartitionDate)	Deprecated.
boolean	equals(Object theO)
static RequestPartitionId	forPartitionIdAndName(Integer thePartitionId, String thePartitionName, LocalDate thePartitionDate)
static RequestPartitionId	forPartitionIdsAndNames(List<String> thePartitionNames, List<Integer> thePartitionIds, LocalDate thePartitionDate)
static RequestPartitionId	fromJson(String theJson)
static RequestPartitionId	fromPartitionId(Integer thePartitionId)
static RequestPartitionId	fromPartitionId(Integer thePartitionId, LocalDate thePartitionDate)
static RequestPartitionId	fromPartitionIdAndName(Integer thePartitionId, String thePartitionName)
static RequestPartitionId	fromPartitionIds(Integer... thePartitionIds)
static RequestPartitionId	fromPartitionIds(Collection<Integer> thePartitionIds)
static RequestPartitionId	fromPartitionIds(Collection<Integer> thePartitionIds, LocalDate thePartitionDate)
static RequestPartitionId	fromPartitionName(String thePartitionName)
static RequestPartitionId	fromPartitionName(String thePartitionName, LocalDate thePartitionDate)
static RequestPartitionId	fromPartitionNames(String... thePartitionNames)
static RequestPartitionId	fromPartitionNames(List<String> thePartitionNames)
Integer	getFirstPartitionIdOrNull()
String	getFirstPartitionNameOrNull()
LocalDate	getPartitionDate()
List<Integer>	getPartitionIds()
List<Integer>	getPartitionIdsWithoutDefault()
static Optional<RequestPartitionId>	getPartitionIfAssigned(IBaseResource theFromResource)
List<String>	getPartitionNames()
boolean	hasDefaultPartitionId()	Deprecated. use hasDefaultPartitionId(Integer) or IDefaultPartitionSettings.hasDefaultPartitionId(ca.uhn.fhir.interceptor.model.RequestPartitionId) instead
boolean	hasDefaultPartitionId(Integer theDefaultPartitionId)	Test whether this request partition has the default partition as one of its targeted partitions.
int	hashCode()
boolean	hasPartitionId(Integer thePartitionId)
boolean	hasPartitionIds()
boolean	hasPartitionNames()
boolean	isAllPartitions()
boolean	isDefaultPartition()	Deprecated. use isPartition(Integer) or IDefaultPartitionSettings.isDefaultPartition(RequestPartitionId) instead .
boolean	isPartition(Integer thePartitionId)	Test whether this request partition is for the given partition ID.
boolean	isPartitionCovered(Integer thePartitionId)
RequestPartitionId	mergeIds(RequestPartitionId theOther)	Creates a new RequestPartitionId which includes all partition IDs from this RequestPartitionId but also includes all IDs from the given RequestPartitionId.
static String	stringifyForKey(RequestPartitionId theRequestPartitionId)	Create a string representation suitable for use as a cache key.
String	toJson()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getPartitionIfAssigned

@Nonnull
public static Optional<RequestPartitionId> getPartitionIfAssigned(IBaseResource theFromResource)

mergeIds

public RequestPartitionId mergeIds(RequestPartitionId theOther)

Creates a new RequestPartitionId which includes all partition IDs from this RequestPartitionId but also includes all IDs from the given RequestPartitionId. Any duplicates are only included once, and partition names and dates are ignored and not returned. This RequestPartitionId and theOther are not modified.

Since:

7.4.0

fromJson

public static RequestPartitionId fromJson(String theJson)
                                   throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

isAllPartitions

public boolean isAllPartitions()

isPartitionCovered

public boolean isPartitionCovered(Integer thePartitionId)

getPartitionDate

@Nullable
public LocalDate getPartitionDate()

getPartitionNames

@Nullable
public List<String> getPartitionNames()

getPartitionIds

@Nonnull
public List<Integer> getPartitionIds()

toString

public String toString()

Overrides:

toString in class Object

contains

public boolean contains(RequestPartitionId theOther)

Returns true if this partition definition contains the other. Compatible with equals: a.contains(b) && b.contains(a) ==> a.equals(b). We can't implement Comparable because this is only a partial order.

equals

public boolean equals(Object theO)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toJson

public String toJson()

getFirstPartitionIdOrNull

@Nullable
public Integer getFirstPartitionIdOrNull()

getFirstPartitionNameOrNull

public String getFirstPartitionNameOrNull()

isDefaultPartition

@Deprecated(since="2025.02.R01")
public boolean isDefaultPartition()

Deprecated.

use isPartition(Integer) or IDefaultPartitionSettings.isDefaultPartition(RequestPartitionId) instead .

Returns true if this request partition contains only one partition ID and it is the DEFAULT partition ID (null)

isPartition

public boolean isPartition(@Nullable
 Integer thePartitionId)

Test whether this request partition is for the given partition ID.

Parameters:

thePartitionId - is the partition id to be tested against

Returns:

true if the request partition contains exactly one partition ID and the partition ID is thePartitionId.

hasPartitionId

public boolean hasPartitionId(Integer thePartitionId)

hasPartitionIds

public boolean hasPartitionIds()

hasPartitionNames

public boolean hasPartitionNames()

hasDefaultPartitionId

@Deprecated(since="2025.02.R01")
public boolean hasDefaultPartitionId()

Deprecated.

use hasDefaultPartitionId(Integer) or IDefaultPartitionSettings.hasDefaultPartitionId(ca.uhn.fhir.interceptor.model.RequestPartitionId) instead

Verifies that one of the requested partition is the default partition which is assumed to have a default value of null.

Returns:

true if one of the requested partition is the default partition(null).

hasDefaultPartitionId

public boolean hasDefaultPartitionId(@Nullable
 Integer theDefaultPartitionId)

Test whether this request partition has the default partition as one of its targeted partitions. This method can be directly invoked on a requestPartition object providing that theDefaultPartitionId is known or through IDefaultPartitionSettings.hasDefaultPartitionId(ca.uhn.fhir.interceptor.model.RequestPartitionId) where the implementer of the interface will provide the default partition id (see IDefaultPartitionSettings.getDefaultPartitionId()).

Parameters:

theDefaultPartitionId - is the ID that was given to the default partition. The default partition ID can be NULL as per default or specifically assigned another value. See PartitionSettings#setDefaultPartitionId.

Returns:

true if the request partition has the default partition as one of the targeted partition.

getPartitionIdsWithoutDefault

public List<Integer> getPartitionIdsWithoutDefault()

allPartitions

@Nonnull
public static RequestPartitionId allPartitions()

defaultPartition

@Deprecated
@Nonnull
public static RequestPartitionId defaultPartition()

Deprecated.

use defaultPartition(IDefaultPartitionSettings) instead

defaultPartition

@Nonnull
public static RequestPartitionId defaultPartition(IDefaultPartitionSettings theDefaultPartitionSettings)

Creates a RequestPartitionId for the default partition using the provided partition settings. This method uses the default partition ID from the given settings to create the RequestPartitionId.

Parameters:

theDefaultPartitionSettings - the partition settings containing the default partition ID

Returns:

a RequestPartitionId for the default partition

defaultPartition

@Deprecated
@Nonnull
public static RequestPartitionId defaultPartition(@Nullable
 LocalDate thePartitionDate)

Deprecated.

fromPartitionId

@Nonnull
public static RequestPartitionId fromPartitionId(@Nullable
 Integer thePartitionId)

fromPartitionId

@Nonnull
public static RequestPartitionId fromPartitionId(@Nullable
 Integer thePartitionId,
 @Nullable
 LocalDate thePartitionDate)

fromPartitionIds

@Nonnull
public static RequestPartitionId fromPartitionIds(@Nonnull
 Collection<Integer> thePartitionIds)

fromPartitionIds

@Nonnull
public static RequestPartitionId fromPartitionIds(@Nonnull
 Collection<Integer> thePartitionIds,
 @Nullable
 LocalDate thePartitionDate)

fromPartitionIds

@Nonnull
public static RequestPartitionId fromPartitionIds(Integer... thePartitionIds)

fromPartitionName

@Nonnull
public static RequestPartitionId fromPartitionName(@Nullable
 String thePartitionName)

fromPartitionName

@Nonnull
public static RequestPartitionId fromPartitionName(@Nullable
 String thePartitionName,
 @Nullable
 LocalDate thePartitionDate)

fromPartitionNames

@Nonnull
public static RequestPartitionId fromPartitionNames(@Nullable
 List<String> thePartitionNames)

fromPartitionNames

@Nonnull
public static RequestPartitionId fromPartitionNames(String... thePartitionNames)

fromPartitionIdAndName

@Nonnull
public static RequestPartitionId fromPartitionIdAndName(@Nullable
 Integer thePartitionId,
 @Nullable
 String thePartitionName)

forPartitionIdAndName

@Nonnull
public static RequestPartitionId forPartitionIdAndName(@Nullable
 Integer thePartitionId,
 @Nullable
 String thePartitionName,
 @Nullable
 LocalDate thePartitionDate)

forPartitionIdsAndNames

@Nonnull
public static RequestPartitionId forPartitionIdsAndNames(List<String> thePartitionNames,
 List<Integer> thePartitionIds,
 LocalDate thePartitionDate)

stringifyForKey

public static String stringifyForKey(@Nonnull
 RequestPartitionId theRequestPartitionId)

Create a string representation suitable for use as a cache key. Null aware.

Returns the partition IDs (numeric) as a joined string with a space between, using the string "null" for any null values

asJson

public String asJson()
              throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException