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, SearchQuerySortParameter, SearchQueryIncludeParameter<R>, 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>
implements SearchQueryIncludeParameter<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, resourceType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SearchQueryIncludeParameterConfiguration	configureInclude(List<? super SearchQueryParameterError> errors, String queryParameterIncludeValue)
protected void	doConfigure(List<? super SearchQueryParameterError> errors, String queryParameterName, String queryParameterValue)
protected abstract void	doResolveReferencesForMatching(R resource, DaoProvider daoProvider)
String	getBundleUriQueryParameterName()	Only called if SearchQueryParameter.isDefined() returns true
String	getBundleUriQueryParameterValue()	Only called if SearchQueryParameter.isDefined() returns true
protected abstract String	getIncludeSql(IncludeParts includeParts)
static List<String>	getNameModifiers()
boolean	isDefined()
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

configure, configureSort, getParameterName, getSortSql, matches, notDefined, resourceMatches

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.SearchQueryParameter

getFilterQuery, getSqlParameterCount, modifyStatement

Field Details

valueAndType

protected AbstractReferenceParameter.ReferenceValueAndSearchType valueAndType

Constructor Details

AbstractReferenceParameter

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

Method Details

getNameModifiers

public static List<String> getNameModifiers()

doConfigure

protected void doConfigure(List<? super SearchQueryParameterError> errors,
 String queryParameterName,
 String queryParameterValue)

Specified by:

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

isDefined

public boolean isDefined()

Specified by:

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

getBundleUriQueryParameterName

public String getBundleUriQueryParameterName()

Description copied from interface: SearchQueryParameter

Only called if SearchQueryParameter.isDefined() returns true

Specified by:

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

Returns:

not null, not blank

getBundleUriQueryParameterValue

public String getBundleUriQueryParameterValue()

Description copied from interface: SearchQueryParameter

Only called if SearchQueryParameter.isDefined() returns true

Specified by:

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

Returns:

not null, not blank

resolveReferencesForMatching

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

Specified by:

resolveReferencesForMatching in interface MatcherParameter

Throws:

SQLException

doResolveReferencesForMatching

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

Throws:

SQLException

configureInclude

public SearchQueryIncludeParameterConfiguration configureInclude(List<? super SearchQueryParameterError> errors,
 String queryParameterIncludeValue)

Specified by:

configureInclude in interface SearchQueryIncludeParameter<R extends org.hl7.fhir.r4.model.DomainResource>

Parameters:

errors - not null

queryParameterIncludeValue - not null, not blank

Returns:

getIncludeSql

protected abstract String getIncludeSql(IncludeParts includeParts)

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