Package org.ehrbase.service

Class KnowledgeCacheService

java.lang.Object

org.ehrbase.service.KnowledgeCacheService

All Implemented Interfaces:

I_KnowledgeCache, IntrospectService

@Service
public class KnowledgeCacheService
extends Object
implements I_KnowledgeCache, IntrospectService

Look up and caching for archetypes, openEHR showTemplates and Operational Templates. Search in path defined as

• 1. System environment ETHERCIS_ARCHETYPE_DIR, ETHERCIS_TEMPLATE_DIR, ETHERCIS_OPT_DIR
• 2. Application path %USER_HOME%/.ethercis/archetype, %USER_HOME%/.ethercis/template, %USER_HOME%/.ethercis/opt
• 3. User can also include a source directory by invoking addXYZPath method

The resources extensions are defined by the following default:

• ADL: archetype
• OET: openehr template
• OPT: operational template

Author:

C. Chevalley

Nested Class Summary

Nested classes/interfaces inherited from interface org.ehrbase.ehr.knowledge.I_KnowledgeCache

I_KnowledgeCache.ConceptValue, I_KnowledgeCache.LanguageValue, I_KnowledgeCache.TerritoryValue

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELEMENT

Fields inherited from interface org.ehrbase.ehr.knowledge.I_KnowledgeCache

TEMPLATE_ID

Constructor Summary

Constructors

Constructor	Description
KnowledgeCacheService(TemplateStorage templateStorage, org.springframework.cache.CacheManager cacheManager, CacheOptions cacheOptions, TenantService tenantService)

Method Summary

Modifier and Type	Method	Description
String	addOperationalTemplate(InputStream inputStream, String tenantIdentifier)	Adds operational template to system and also in current cache.
String	addOperationalTemplate(org.openehr.schemas.v1.OPERATIONALTEMPLATE template, String tenantIdentifier)
String	addOperationalTemplateIntern(org.openehr.schemas.v1.OPERATIONALTEMPLATE template, boolean overwrite, String tenantIdentifier)
String	adminUpdateOperationalTemplate(InputStream content)
int	deleteAllOperationalTemplates()
boolean	deleteOperationalTemplate(org.openehr.schemas.v1.OPERATIONALTEMPLATE template)	Deletes a given operational template physically from cache and from template storage and from cache.
Set<String>	getAllTemplateIds()
I_KnowledgeCache.ConceptValue	getConceptByConceptId(int conceptId, String language, BiFunction<Integer,String,I_KnowledgeCache.ConceptValue> provider)
I_KnowledgeCache.ConceptValue	getConceptByDescription(String description, String language, BiFunction<String,String,I_KnowledgeCache.ConceptValue> provider)
I_KnowledgeCache.ConceptValue	getConceptById(UUID id, Function<UUID,I_KnowledgeCache.ConceptValue> provider)
ItemInfo	getInfo(String templateId, String aql)
I_KnowledgeCache	getKnowledge()
I_KnowledgeCache.LanguageValue	getLanguageByCode(String languageCode, Function<String,I_KnowledgeCache.LanguageValue> provider)
org.ehrbase.webtemplate.model.WebTemplate	getQueryOptMetaData(String templateId)
org.ehrbase.webtemplate.model.WebTemplate	getQueryOptMetaData(UUID uuid)
I_KnowledgeCache.TerritoryValue	getTerritoryCodeByTwoLetterCode(String territoryAsString, Function<String,I_KnowledgeCache.TerritoryValue> provider)
List<TemplateMetaData>	listAllOperationalTemplates()
List<String>	multiValued(String templateId)
JsonPathQueryResult	resolveForTemplate(String templateId, Collection<org.ehrbase.webtemplate.parser.NodeId> nodeIds)
Optional<org.openehr.schemas.v1.OPERATIONALTEMPLATE>	retrieveOperationalTemplate(String key)	retrieve an operational template document instance
Optional<org.openehr.schemas.v1.OPERATIONALTEMPLATE>	retrieveOperationalTemplate(UUID uuid)	retrieve a cached operational template document instance using its unique Id

Methods inherited from class java.lang.Object

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

Field Details

ELEMENT

public static final String ELEMENT

See Also:

• Constant Field Values

Constructor Details

KnowledgeCacheService

public KnowledgeCacheService(TemplateStorage templateStorage,
 org.springframework.cache.CacheManager cacheManager,
 CacheOptions cacheOptions,
 TenantService tenantService)
                      throws InterruptedException

Throws:

InterruptedException

Method Details

getAllTemplateIds

public Set<String> getAllTemplateIds()

Specified by:

getAllTemplateIds in interface I_KnowledgeCache

addOperationalTemplate

public String addOperationalTemplate(InputStream inputStream,
 String tenantIdentifier)

Description copied from interface: I_KnowledgeCache

Adds operational template to system and also in current cache.

Specified by:

addOperationalTemplate in interface I_KnowledgeCache

Parameters:

inputStream - operational template input

Returns:

resulting template ID, when successful

addOperationalTemplate

public String addOperationalTemplate(org.openehr.schemas.v1.OPERATIONALTEMPLATE template,
 String tenantIdentifier)

Specified by:

addOperationalTemplate in interface I_KnowledgeCache

addOperationalTemplateIntern

public String addOperationalTemplateIntern(org.openehr.schemas.v1.OPERATIONALTEMPLATE template,
 boolean overwrite,
 String tenantIdentifier)

adminUpdateOperationalTemplate

public String adminUpdateOperationalTemplate(InputStream content)

listAllOperationalTemplates

public List<TemplateMetaData> listAllOperationalTemplates()

Specified by:

listAllOperationalTemplates in interface I_KnowledgeCache

retrieveOperationalTemplate

public Optional<org.openehr.schemas.v1.OPERATIONALTEMPLATE> retrieveOperationalTemplate(String key)

Description copied from interface: I_KnowledgeCache

retrieve an operational template document instance

Specified by:

retrieveOperationalTemplate in interface I_KnowledgeCache

Parameters:

key - the name of the operational template

Returns:

an OPERATIONALTEMPLATE document instance or null

See Also:

• OPERATIONALTEMPLATE

retrieveOperationalTemplate

public Optional<org.openehr.schemas.v1.OPERATIONALTEMPLATE> retrieveOperationalTemplate(UUID uuid)

Description copied from interface: I_KnowledgeCache

retrieve a cached operational template document instance using its unique Id

Specified by:

retrieveOperationalTemplate in interface I_KnowledgeCache

Parameters:

uuid - the name of the operational template

Returns:

an OPERATIONALTEMPLATE document instance or null

See Also:

• OPERATIONALTEMPLATE

deleteOperationalTemplate

public boolean deleteOperationalTemplate(org.openehr.schemas.v1.OPERATIONALTEMPLATE template)

Deletes a given operational template physically from cache and from template storage and from cache. Should only be executed if the template is no longer referenced by any Composition. Make sure you check for references before deleting a template otherwise this causes inconsistencies and no longer deliverable Composition entries.

Specified by:

deleteOperationalTemplate in interface I_KnowledgeCache

Parameters:

template - - The template instance to delete

Returns:

- Template has been deleted

getQueryOptMetaData

public org.ehrbase.webtemplate.model.WebTemplate getQueryOptMetaData(UUID uuid)

Specified by:

getQueryOptMetaData in interface IntrospectService

getQueryOptMetaData

public org.ehrbase.webtemplate.model.WebTemplate getQueryOptMetaData(String templateId)

Specified by:

getQueryOptMetaData in interface IntrospectService

deleteAllOperationalTemplates

public int deleteAllOperationalTemplates()

resolveForTemplate

public JsonPathQueryResult resolveForTemplate(String templateId,
 Collection<org.ehrbase.webtemplate.parser.NodeId> nodeIds)

Specified by:

resolveForTemplate in interface I_KnowledgeCache

getInfo

public ItemInfo getInfo(String templateId,
 String aql)

Specified by:

getInfo in interface IntrospectService

multiValued

public List<String> multiValued(String templateId)

Specified by:

multiValued in interface IntrospectService

getKnowledge

public I_KnowledgeCache getKnowledge()

Specified by:

getKnowledge in interface IntrospectService

getConceptByConceptId

public I_KnowledgeCache.ConceptValue getConceptByConceptId(int conceptId,
 String language,
 BiFunction<Integer,String,I_KnowledgeCache.ConceptValue> provider)

Specified by:

getConceptByConceptId in interface I_KnowledgeCache

getConceptById

public I_KnowledgeCache.ConceptValue getConceptById(UUID id,
 Function<UUID,I_KnowledgeCache.ConceptValue> provider)

Specified by:

getConceptById in interface I_KnowledgeCache

getConceptByDescription

public I_KnowledgeCache.ConceptValue getConceptByDescription(String description,
 String language,
 BiFunction<String,String,I_KnowledgeCache.ConceptValue> provider)

Specified by:

getConceptByDescription in interface I_KnowledgeCache

getTerritoryCodeByTwoLetterCode

public I_KnowledgeCache.TerritoryValue getTerritoryCodeByTwoLetterCode(String territoryAsString,
 Function<String,I_KnowledgeCache.TerritoryValue> provider)

Specified by:

getTerritoryCodeByTwoLetterCode in interface I_KnowledgeCache

getLanguageByCode

public I_KnowledgeCache.LanguageValue getLanguageByCode(String languageCode,
 Function<String,I_KnowledgeCache.LanguageValue> provider)

Specified by:

getLanguageByCode in interface I_KnowledgeCache