Package ca.uhn.fhir.jpa.searchparam.util

Enum Class JpaParamUtil

java.lang.Object

java.lang.Enum<JpaParamUtil>

ca.uhn.fhir.jpa.searchparam.util.JpaParamUtil

All Implemented Interfaces:

Serializable, Comparable<JpaParamUtil>, Constable

public enum JpaParamUtil
extends Enum<JpaParamUtil>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JpaParamUtil.ComponentAndCorrespondingParam	Return type for resolveCompositeComponents(ISearchParamRegistry, RuntimeSearchParam)

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Method Summary

Modifier and Type	Method	Description
static ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum	getParameterTypeForComposite(ca.uhn.fhir.rest.server.util.ISearchParamRegistry theSearchParamRegistry, JpaParamUtil.ComponentAndCorrespondingParam theComponentAndParam)	Given a component for a composite or combo SearchParameter (as returned by resolveCompositeComponents(ISearchParamRegistry, RuntimeSearchParam)) determines the type associated with the target parameter.
static ca.uhn.fhir.model.api.IQueryParameterAnd<?>	parseQueryParams(ca.uhn.fhir.context.FhirContext theContext, ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum paramType, String theUnqualifiedParamName, List<ca.uhn.fhir.rest.api.QualifiedParamList> theParameters)	This is a utility method intended provided to help the JPA module.
static ca.uhn.fhir.model.api.IQueryParameterAnd<?>	parseQueryParams(ca.uhn.fhir.rest.server.util.ISearchParamRegistry theSearchParamRegistry, ca.uhn.fhir.context.FhirContext theContext, ca.uhn.fhir.context.RuntimeSearchParam theParamDef, String theUnqualifiedParamName, List<ca.uhn.fhir.rest.api.QualifiedParamList> theParameters)	This is a utility method intended provided to help the JPA module.
static List<JpaParamUtil.ComponentAndCorrespondingParam>	resolveCompositeComponents(ca.uhn.fhir.rest.server.util.ISearchParamRegistry theSearchParamRegistry, ca.uhn.fhir.context.RuntimeSearchParam theCompositeParameter)	Given a composite or combo SearchParameter, this method will resolve the components in the order they appear in the composite parameter definition.
static JpaParamUtil	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JpaParamUtil[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

values

public static JpaParamUtil[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static JpaParamUtil valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

parseQueryParams

public static ca.uhn.fhir.model.api.IQueryParameterAnd<?> parseQueryParams(ca.uhn.fhir.context.FhirContext theContext,
 ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum paramType,
 String theUnqualifiedParamName,
 List<ca.uhn.fhir.rest.api.QualifiedParamList> theParameters)

This is a utility method intended provided to help the JPA module.

parseQueryParams

public static ca.uhn.fhir.model.api.IQueryParameterAnd<?> parseQueryParams(ca.uhn.fhir.rest.server.util.ISearchParamRegistry theSearchParamRegistry,
 ca.uhn.fhir.context.FhirContext theContext,
 ca.uhn.fhir.context.RuntimeSearchParam theParamDef,
 String theUnqualifiedParamName,
 List<ca.uhn.fhir.rest.api.QualifiedParamList> theParameters)

This is a utility method intended provided to help the JPA module.

resolveCompositeComponents

@Nonnull
public static List<JpaParamUtil.ComponentAndCorrespondingParam> resolveCompositeComponents(ca.uhn.fhir.rest.server.util.ISearchParamRegistry theSearchParamRegistry,
 ca.uhn.fhir.context.RuntimeSearchParam theCompositeParameter)

Given a composite or combo SearchParameter, this method will resolve the components in the order they appear in the composite parameter definition. The return objects are a record containing both the component from the composite parameter definition, but also the corresponding SearchParameter definition for the target of the component.

Parameters:

theSearchParamRegistry - The active SearchParameter registry

theCompositeParameter - The composite search parameter

getParameterTypeForComposite

public static ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum getParameterTypeForComposite(ca.uhn.fhir.rest.server.util.ISearchParamRegistry theSearchParamRegistry,
 JpaParamUtil.ComponentAndCorrespondingParam theComponentAndParam)

Given a component for a composite or combo SearchParameter (as returned by resolveCompositeComponents(ISearchParamRegistry, RuntimeSearchParam)) determines the type associated with the target parameter.