Package com.ibm.fhir.search.sort

Class Sort

java.lang.Object

com.ibm.fhir.search.sort.Sort

public class Sort
extends 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 List<String>	SYSTEM_LEVEL_SORT_PARAMETER_NAMES

Constructor Summary

Constructors

Constructor	Description
Sort()

Method Summary

Modifier and Type	Method	Description
String	buildNewInvalidSearchExceptionMessage(String sortParmCode)	builds exception message when the sort parameter used is undefined.
String	buildUndefinedSortParamMessage(String resourceTypeName, String sortParmCode)	builds exception message when the sort parameter used is undefined.
void	checkSystemLevel(String resourceTypeName, String code)	check system level searches with DESC/ASC are ONLY with _id and _lastUpdated
boolean	isUndefinedOrLenient(String resourceTypeName, String sortParmCode, SearchParameter sortParmProxy, boolean lenient)	checks to see if undefined as a SearchParameter or Lenient
void	parseSortParameter(Class<?> resourceType, FHIRSearchContext context, String sortParmValue, boolean lenient)	Parses the _sort parameter.
void	parseSortParameter(String resourceTypeName, FHIRSearchContext context, String sortParmValue, boolean lenient)	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 List<String> SYSTEM_LEVEL_SORT_PARAMETER_NAMES

Constructor Detail

Sort

public Sort()

Method Detail

parseSortParameter

public void parseSortParameter(Class<?> resourceType,
                               FHIRSearchContext context,
                               String sortParmValue,
                               boolean lenient)
                        throws Exception

Parses the _sort parameter.

Parameters:

resourceType - the resource type

context - the search context

sortParmValue - the parameter value

lenient - true if lenient, false if strict

Throws:

Exception - an exception

parseSortParameter

public void parseSortParameter(String resourceTypeName,
                               FHIRSearchContext context,
                               String sortParmValue,
                               boolean lenient)
                        throws Exception

Parses the _sort parameter.

Parameters:

resourceTypeName - the resource type name

context - the search context

sortParmValue - the parameter value

lenient - true if lenient, false if strict

Throws:

Exception - an exception

isUndefinedOrLenient

public boolean isUndefinedOrLenient(String resourceTypeName,
                                    String sortParmCode,
                                    SearchParameter sortParmProxy,
                                    boolean lenient)
                             throws FHIRSearchException

checks to see if undefined as a SearchParameter or Lenient

Parameters:

resourceTypeName -

sortParmCode -

sortParmProxy -

lenient -

Returns:

Throws:

FHIRSearchException

checkSystemLevel

public void checkSystemLevel(String resourceTypeName,
                             String code)
                      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.

Throws:

FHIRSearchException

buildNewInvalidSearchExceptionMessage

public final String buildNewInvalidSearchExceptionMessage(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 String buildUndefinedSortParamMessage(String resourceTypeName,
                                                   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