Package com.ibm.fhir.search.sort

Class Sort

java.lang.Object

com.ibm.fhir.search.sort.Sort

public class Sort
extends java.lang.Object

This class implements the _sort URL processing into internal SortParameters. FHIR Specification: _sort

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Sort.Direction	ascending and descending enumeration

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.List<java.lang.String>	SYSTEM_LEVEL_SORT_PARAMETER_NAMES

Constructor Summary

Constructors

Constructor	Description
Sort()

Method Summary

Modifier and Type	Method	Description
java.lang.String	buildNewInvalidSearchExceptionMessage(java.lang.String sortParmCode)	builds exception message when the sort parameter used is undefined.
java.lang.String	buildUndefinedSortParamMessage(java.lang.String resourceTypeName, java.lang.String sortParmCode)	builds exception message when the sort parameter used is undefined.
void	checkIfUndefined(java.lang.String resourceTypeName, java.lang.String sortParmCode, SearchParameter sortParmProxy, FHIRSearchContext context)	Checks to see if undefined as a SearchParameter.
void	checkSystemLevel(java.lang.String resourceTypeName, java.lang.String code, FHIRSearchContext context)	Check system level searches with DESC/ASC are ONLY with _id and _lastUpdated.
void	parseSortParameter(java.lang.Class<?> resourceType, FHIRSearchContext context, java.lang.String sortParmValue, SearchHelper searchHelper)	Parses the _sort parameter.
void	parseSortParameter(java.lang.String resourceTypeName, FHIRSearchContext context, java.lang.String sortParmValue, SearchHelper searchHelper)	Parses the _sort parameter.

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_LEVEL_SORT_PARAMETER_NAMES

public static final java.util.List<java.lang.String> SYSTEM_LEVEL_SORT_PARAMETER_NAMES

Constructor Detail

Sort

public Sort()

Method Detail

parseSortParameter

public void parseSortParameter(java.lang.Class<?> resourceType,
                               FHIRSearchContext context,
                               java.lang.String sortParmValue,
                               SearchHelper searchHelper)
                        throws java.lang.Exception

Parses the _sort parameter.

Parameters:

resourceType - the resource type

context - the search context

sortParmValue - the parameter value

searchHelper - a SearchUtil instance to retrieve filtered search params

Throws:

java.lang.Exception - an exception

parseSortParameter

public void parseSortParameter(java.lang.String resourceTypeName,
                               FHIRSearchContext context,
                               java.lang.String sortParmValue,
                               SearchHelper searchHelper)
                        throws java.lang.Exception

Parses the _sort parameter.

Parameters:

resourceTypeName - the resource type name

context - the search context

sortParmValue - the parameter value

searchHelper - a SearchUtil instance to retrieve filtered search params

Throws:

java.lang.Exception - an exception

checkIfUndefined

public void checkIfUndefined(java.lang.String resourceTypeName,
                             java.lang.String sortParmCode,
                             SearchParameter sortParmProxy,
                             FHIRSearchContext context)
                      throws FHIRSearchException

Checks to see if undefined as a SearchParameter.

Parameters:

resourceTypeName - the resource type

sortParmCode - the sort value

sortParmProxy - the search parameter

context - the context

Throws:

FHIRSearchException - if search parameter is undefined

checkSystemLevel

public void checkSystemLevel(java.lang.String resourceTypeName,
                             java.lang.String code,
                             FHIRSearchContext context)
                      throws FHIRSearchException

Check system level searches with DESC/ASC are ONLY with _id and _lastUpdated.

Parameters:

resourceTypeName - one of the FHIR Resources, and must be a non-null value

code - the code to check.

context - the context

Throws:

FHIRSearchException - if system level search and code is not system level

buildNewInvalidSearchExceptionMessage

public final java.lang.String buildNewInvalidSearchExceptionMessage(java.lang.String sortParmCode)

builds exception message when the sort parameter used is undefined.

Parameters:

sortParmCode - the code that is passed in

Returns:

String representing the exception message

buildUndefinedSortParamMessage

public final java.lang.String buildUndefinedSortParamMessage(java.lang.String resourceTypeName,
                                                             java.lang.String sortParmCode)

builds exception message when the sort parameter used is undefined.

Parameters:

resourceTypeName - the specific FHIR Resource passed in or general RESOURCE

sortParmCode - the code that is passed in

Returns:

String representing the exception message