Interface ParameterDAO
-
- All Superinterfaces:
FHIRDbDAO
- All Known Implementing Classes:
ParameterDAOImpl
public interface ParameterDAO extends FHIRDbDAO
This Data Access Object interface defines methods for creating, updating, and retrieving rows in the IBM FHIR Server parameter-related tables.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
acquireParameterNameId(java.lang.String parameterName)
Acquire and return the id associated with the passed parameter name.java.util.Map<java.lang.String,java.lang.Integer>
readAllCodeSystems()
Reads all rows in the Code_Systems table and returns the data as a Mapjava.util.Map<java.lang.String,java.lang.Integer>
readAllSearchParameterNames()
Reads all rows in the Parameter_Names table and returns the data as a Mapjava.lang.Integer
readCodeSystemId(java.lang.String systemName)
Read the id for the given code system name, but do not create a new record if it doesn't exist.int
readOrAddCodeSystemId(java.lang.String systemName)
Reads the id associated with the name of the passed code system name from the Code_Systems table.int
readOrAddParameterNameId(java.lang.String parameterName)
Reads the id associated with the name of the passed Parameter from the Parameter_Names table.java.lang.Integer
readParameterNameId(java.lang.String parameterName)
Read the id for the given parameter name, but do not create a new record if it doesn't exist.-
Methods inherited from interface org.linuxforhealth.fhir.persistence.jdbc.dao.api.FHIRDbDAO
getConnection, getFlavor
-
-
-
-
Method Detail
-
readAllSearchParameterNames
java.util.Map<java.lang.String,java.lang.Integer> readAllSearchParameterNames() throws FHIRPersistenceDBConnectException, FHIRPersistenceDataAccessException
Reads all rows in the Parameter_Names table and returns the data as a Map- Returns:
- Map
- A map containing key=parameter-name, value=parameter-name-id - Throws:
FHIRPersistenceDBConnectException
FHIRPersistenceDataAccessException
-
readAllCodeSystems
java.util.Map<java.lang.String,java.lang.Integer> readAllCodeSystems() throws FHIRPersistenceDBConnectException, FHIRPersistenceDataAccessException
Reads all rows in the Code_Systems table and returns the data as a Map- Returns:
- Map
- A map containing key=system-name, value=system-id - Throws:
FHIRPersistenceDBConnectException
FHIRPersistenceDataAccessException
-
readOrAddParameterNameId
int readOrAddParameterNameId(java.lang.String parameterName) throws FHIRPersistenceDBConnectException, FHIRPersistenceDataAccessException
Reads the id associated with the name of the passed Parameter from the Parameter_Names table. If the id for the passed name is not present in the database, an id is generated, persisted, and returned.- Parameters:
String
- A valid FHIR search parameter name.- Returns:
- Integer - the id associated with the name of the passed Parameter.
- Throws:
FHIRPersistenceDBConnectException
FHIRPersistenceDataAccessException
-
readParameterNameId
java.lang.Integer readParameterNameId(java.lang.String parameterName) throws FHIRPersistenceDBConnectException, FHIRPersistenceDataAccessException
Read the id for the given parameter name, but do not create a new record if it doesn't exist.- Parameters:
parameterName
-- Returns:
- the id for the parameter name, or null not found
- Throws:
FHIRPersistenceDBConnectException
FHIRPersistenceDataAccessException
-
readOrAddCodeSystemId
int readOrAddCodeSystemId(java.lang.String systemName) throws FHIRPersistenceDBConnectException, FHIRPersistenceDataAccessException
Reads the id associated with the name of the passed code system name from the Code_Systems table. If the id for the passed system name is not present in the database, an id is generated, persisted, and returned.- Parameters:
systemName
- - The name of a FHIR code system.- Returns:
- Integer - The id associated with the passed code system name.
- Throws:
FHIRPersistenceDBConnectException
FHIRPersistenceDataAccessException
-
readCodeSystemId
java.lang.Integer readCodeSystemId(java.lang.String systemName) throws FHIRPersistenceDBConnectException, FHIRPersistenceDataAccessException
Read the id for the given code system name, but do not create a new record if it doesn't exist.- Parameters:
systemName
-- Returns:
- Integer - The id associated with the passed code system name, or null if it doesn't exist
- Throws:
FHIRPersistenceDBConnectException
FHIRPersistenceDataAccessException
-
acquireParameterNameId
int acquireParameterNameId(java.lang.String parameterName) throws FHIRPersistenceException
Acquire and return the id associated with the passed parameter name.- Parameters:
parameterName
- The name of a valid FHIR search parameter.- Returns:
- Integer A parameter id.
- Throws:
FHIRPersistenceException
-
-