Package dev.dsf.fhir.search.parameters.basic

Class AbstractReferenceParameter<R extends org.hl7.fhir.r4.model.DomainResource>

java.lang.Object

dev.dsf.fhir.search.parameters.basic.AbstractSearchParameter<R>

dev.dsf.fhir.search.parameters.basic.AbstractReferenceParameter<R>

All Implemented Interfaces:

MatcherParameter, SearchQueryParameter<R>

Direct Known Subclasses:

AbstractCanonicalReferenceParameter, EndpointOrganization, OrganizationAffiliationEndpoint, OrganizationAffiliationParticipatingOrganization, OrganizationAffiliationPrimaryOrganization, OrganizationEndpoint, PractitionerRoleOrganization, PractitionerRolePractitioner, QuestionnaireResponseSubject, ResearchStudyEnrollment, ResearchStudyPrincipalInvestigator, TaskRequester

public abstract class AbstractReferenceParameter<R extends org.hl7.fhir.r4.model.DomainResource>
extends AbstractSearchParameter<R>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	AbstractReferenceParameter.ReferenceSearchType
protected static class	AbstractReferenceParameter.ReferenceValueAndSearchType

Nested classes/interfaces inherited from interface dev.dsf.fhir.search.SearchQueryParameter

SearchQueryParameter.SearchParameterDefinition

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractReferenceParameter.ReferenceValueAndSearchType	valueAndType

Fields inherited from class dev.dsf.fhir.search.parameters.basic.AbstractSearchParameter

parameterName

Constructor Summary

Constructors

Constructor	Description
AbstractReferenceParameter(Class<R> resourceType, String resourceTypeName, String parameterName, String... targetResourceTypeNames)

Method Summary

Modifier and Type	Method	Description
protected void	configureIncludeParameter(Map<String,List<String>> queryParameters)
protected void	configureSearchParameter(Map<String,List<String>> queryParameters)
protected abstract void	doResolveReferencesForMatching(R resource, DaoProvider daoProvider)
List<SearchQueryIncludeParameter>	getIncludeParameters()
protected abstract String	getIncludeSql(IncludeParts includeParts)
protected Stream<String>	getModifiedParameterNames()
boolean	isDefined()
void	modifyBundleUri(jakarta.ws.rs.core.UriBuilder bundleUri)	Will not be called if SearchQueryParameter.isDefined() returns false
protected abstract void	modifyIncludeResource(IncludeParts includeParts, org.hl7.fhir.r4.model.Resource resource, Connection connection)	Use this method to modify the include resources.
void	resolveReferencesForMatching(org.hl7.fhir.r4.model.Resource resource, DaoProvider daoProvider)

Methods inherited from class dev.dsf.fhir.search.parameters.basic.AbstractSearchParameter

addError, configure, getBaseAndModifiedParameterNames, getErrors, getFirst, getParameterName, getSortParameter, getSortSql, notDefined

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.dsf.fhir.search.MatcherParameter

matches

Methods inherited from interface dev.dsf.fhir.search.SearchQueryParameter

getFilterQuery, getSqlParameterCount, modifyStatement

Field Details

valueAndType

protected AbstractReferenceParameter.ReferenceValueAndSearchType valueAndType

Constructor Details

AbstractReferenceParameter

public AbstractReferenceParameter(Class<R> resourceType,
 String resourceTypeName,
 String parameterName,
 String... targetResourceTypeNames)

Method Details

getModifiedParameterNames

protected Stream<String> getModifiedParameterNames()

Overrides:

getModifiedParameterNames in class AbstractSearchParameter<R extends org.hl7.fhir.r4.model.DomainResource>

configureSearchParameter

protected void configureSearchParameter(Map<String,List<String>> queryParameters)

Specified by:

configureSearchParameter in class AbstractSearchParameter<R extends org.hl7.fhir.r4.model.DomainResource>

configureIncludeParameter

protected void configureIncludeParameter(Map<String,List<String>> queryParameters)

Overrides:

configureIncludeParameter in class AbstractSearchParameter<R extends org.hl7.fhir.r4.model.DomainResource>

isDefined

public boolean isDefined()

modifyBundleUri

public void modifyBundleUri(jakarta.ws.rs.core.UriBuilder bundleUri)

Description copied from interface: SearchQueryParameter

Will not be called if SearchQueryParameter.isDefined() returns false

Parameters:

bundleUri - never null

getIncludeParameters

public List<SearchQueryIncludeParameter> getIncludeParameters()

Specified by:

getIncludeParameters in interface SearchQueryParameter<R extends org.hl7.fhir.r4.model.DomainResource>

Overrides:

getIncludeParameters in class AbstractSearchParameter<R extends org.hl7.fhir.r4.model.DomainResource>

getIncludeSql

protected abstract String getIncludeSql(IncludeParts includeParts)

resolveReferencesForMatching

public void resolveReferencesForMatching(org.hl7.fhir.r4.model.Resource resource,
 DaoProvider daoProvider)
                                  throws SQLException

Throws:

SQLException

doResolveReferencesForMatching

protected abstract void doResolveReferencesForMatching(R resource,
 DaoProvider daoProvider)
                                                throws SQLException

Throws:

SQLException

modifyIncludeResource

protected abstract void modifyIncludeResource(IncludeParts includeParts,
 org.hl7.fhir.r4.model.Resource resource,
 Connection connection)

Use this method to modify the include resources. This method can be used if the resources returned by the include SQL are not complete and additional content needs to be retrieved from a not included column. For example the content of a Binary resource might not be stored in the json column.

Parameters:

includeParts - not null

resource - not null

connection - not null