Interface Mapping

All Known Implementing Classes:

CompositeMapping, SimpleMapping

public sealed interface Mapping
permits SimpleMapping, CompositeMapping

A named translation from one code system into another, as Mappings serves it and a MappingLoader produces it. A lookup by name works the same for either kind:

• a SimpleMapping is a translation table - entries of its own and a fallback for either direction. Every mapping format reads into one and writes one;
• a CompositeMapping holds no entries but the names of simple mappings, its parts, and answers through them. Loaders create one where a source spreads a single translation over several tables, such as the groups of a FHIR ConceptMap.

Both kinds answer every accessor declared here, so a caller inspecting a mapping need not know its kind in advance. What only a table has - entries(), the fallbacks and reversible() - a composite cannot report, since it holds nothing but the names of its parts; it throws UnsupportedOperationException for these. To inspect what a mapping of either kind declares, ask Mappings.entries(String) by name, which resolves the parts.

Since:

6.0

Method Summary

Modifier and Type	Method	Description
List<Entry>	entries()
String	keySystem()
String	name()
boolean	override()
List<String>	parts()
Unmatched	reverseUnmatched()
boolean	reversible()
Unmatched	unmatched()
String	valueSystem()

Method Details

name

String name()

Returns:

mapping name, unique within a Mappings instance

keySystem

String keySystem()

Returns:

formal identifier (usually an OID or a URI) of the key code system, may be null

valueSystem

String valueSystem()

Returns:

formal identifier of the value code system, may be null

override

boolean override()

Returns:

whether this declaration is meant to replace a mapping of the same name loaded earlier. Without it, a duplicate name is a load-time error

entries

List<Entry> entries()

Returns:

the key/value pairs, in declaration order

Throws:

UnsupportedOperationException - for a CompositeMapping, whose entries are those of its parts; see Mappings.entries(String)

unmatched

Unmatched unmatched()

Returns:

what to answer when a key has no entry

Throws:

UnsupportedOperationException - for a CompositeMapping, which falls back through its parts

reverseUnmatched

Unmatched reverseUnmatched()

Returns:

what to answer when a value has no entry

Throws:

UnsupportedOperationException - for a CompositeMapping, which falls back through its parts

reversible

boolean reversible()

Returns:

whether a reverse index is built at all

Throws:

UnsupportedOperationException - for a CompositeMapping, whose parts decide this each for themselves

parts

List<String> parts()

Returns:

the names of the mappings a CompositeMapping asks, in order; empty for a SimpleMapping