org.hl7.fhir.instance.utils

Class ProfileUtilities

java.lang.Object

org.hl7.fhir.instance.utils.ProfileUtilities

public class ProfileUtilities
extends Object

This class provides a set of utility operations for working with Profiles. Key functionality: * getChildMap --? * getChildList * generateSnapshot: Given a base (snapshot) profile structure, and a differential profile, generate a new snapshot profile * generateExtensionsTable: generate the HTML for a hierarchical table presentation of the extensions * generateTable: generate the HTML for a hierarchical table presentation of a structure * summarise: describe the contents of a profile

Author:

Grahame

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProfileUtilities.ElementDefinitionComparer
static class	ProfileUtilities.ElementDefinitionHolder
class	ProfileUtilities.ExtensionContext
static interface	ProfileUtilities.ProfileKnowledgeProvider

Field Summary

Fields

Modifier and Type	Field and Description
static String	DERIVATION_POINTER
static String	IS_DERIVED
static int	STATUS_ERROR
static int	STATUS_FATAL
static int	STATUS_HINT
static int	STATUS_OK
static int	STATUS_WARNING
static String	UD_ERROR_STATUS

Constructor Summary

Constructors

Constructor and Description
ProfileUtilities(IWorkerContext context)

Method Summary

Modifier and Type	Method and Description
static String	describeExtensionContext(StructureDefinition ext)
String	describeSlice(ElementDefinition.ElementDefinitionSlicingComponent slicing)
XhtmlNode	generateExtensionTable(String defFile, StructureDefinition ed, String imageFolder, boolean inlineGraphics, ProfileUtilities.ProfileKnowledgeProvider pkp, boolean full, String corePath)
void	generateSchematrons(OutputStream dest, StructureDefinition structure)
void	generateSnapshot(StructureDefinition base, StructureDefinition derived, String url, String profileName, ProfileUtilities.ProfileKnowledgeProvider pkp, List<ValidationMessage> messages) Given a base (snapshot) profile structure, and a differential profile, generate a new snapshot profile
XhtmlNode	generateTable(String defFile, StructureDefinition profile, boolean diff, String imageFolder, boolean inlineGraphics, ProfileUtilities.ProfileKnowledgeProvider pkp, String profileBaseFileName, boolean snapshot, String corePath)
static List<ElementDefinition>	getChildList(StructureDefinition structure, ElementDefinition element)
static List<ElementDefinition>	getChildList(StructureDefinition profile, String path) Given a Structure, navigate to the element given by the path and return the direct children of that element
static List<ElementDefinition>	getChildMap(StructureDefinition profile, ElementDefinition element)
static List<ElementDefinition>	getChildMap(StructureDefinition profile, String name, String path, String nameReference) Given a Structure, navigate to the element given by the path and return the direct children of that element
StructureDefinition	getProfile(StructureDefinition source, String url)
static boolean	isPrimitive(String value)
void	sortDifferential(StructureDefinition base, StructureDefinition diff, String name, ProfileUtilities.ProfileKnowledgeProvider pkp, List<String> errors)
static String	typeCode(List<ElementDefinition.TypeRefComponent> types)

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_OK

public static final int STATUS_OK

See Also:

Constant Field Values

STATUS_HINT

public static final int STATUS_HINT

See Also:

Constant Field Values

STATUS_WARNING

public static final int STATUS_WARNING

See Also:

Constant Field Values

STATUS_ERROR

public static final int STATUS_ERROR

See Also:

Constant Field Values

STATUS_FATAL

public static final int STATUS_FATAL

See Also:

Constant Field Values

DERIVATION_POINTER

public static final String DERIVATION_POINTER

See Also:

Constant Field Values

IS_DERIVED

public static final String IS_DERIVED

See Also:

Constant Field Values

UD_ERROR_STATUS

public static final String UD_ERROR_STATUS

See Also:

Constant Field Values

Constructor Detail

ProfileUtilities

public ProfileUtilities(IWorkerContext context)

Method Detail

getChildMap

public static List<ElementDefinition> getChildMap(StructureDefinition profile,
                                                  String name,
                                                  String path,
                                                  String nameReference)
                                           throws Exception

Given a Structure, navigate to the element given by the path and return the direct children of that element

Parameters:

structure - The structure to navigate into

path - The path of the element within the structure to get the children for

Returns:

A Map containing the name of the element child (not the path) and the child itself (an Element)

Throws:

Exception

getChildMap

public static List<ElementDefinition> getChildMap(StructureDefinition profile,
                                                  ElementDefinition element)
                                           throws Exception

Throws:

Exception

getChildList

public static List<ElementDefinition> getChildList(StructureDefinition profile,
                                                   String path)

Given a Structure, navigate to the element given by the path and return the direct children of that element

Parameters:

structure - The structure to navigate into

path - The path of the element within the structure to get the children for

Returns:

A List containing the element children (all of them are Elements)

getChildList

public static List<ElementDefinition> getChildList(StructureDefinition structure,
                                                   ElementDefinition element)

generateSnapshot

public void generateSnapshot(StructureDefinition base,
                             StructureDefinition derived,
                             String url,
                             String profileName,
                             ProfileUtilities.ProfileKnowledgeProvider pkp,
                             List<ValidationMessage> messages)
                      throws Exception

Given a base (snapshot) profile structure, and a differential profile, generate a new snapshot profile

Parameters:

base - - the base structure on which the differential will be applied

differential - - the differential to apply to the base

url - - where the base has relative urls for profile references, these need to be converted to absolutes by prepending this URL

trimDifferential - - if this is true, then the snap short generator will remove any material in the element definitions that is not different to the base

Throws:

Exception

typeCode

public static String typeCode(List<ElementDefinition.TypeRefComponent> types)

generateExtensionTable

public XhtmlNode generateExtensionTable(String defFile,
                                        StructureDefinition ed,
                                        String imageFolder,
                                        boolean inlineGraphics,
                                        ProfileUtilities.ProfileKnowledgeProvider pkp,
                                        boolean full,
                                        String corePath)
                                 throws Exception

Throws:

Exception

describeExtensionContext

public static String describeExtensionContext(StructureDefinition ext)

generateTable

public XhtmlNode generateTable(String defFile,
                               StructureDefinition profile,
                               boolean diff,
                               String imageFolder,
                               boolean inlineGraphics,
                               ProfileUtilities.ProfileKnowledgeProvider pkp,
                               String profileBaseFileName,
                               boolean snapshot,
                               String corePath)
                        throws Exception

Throws:

Exception

describeSlice

public String describeSlice(ElementDefinition.ElementDefinitionSlicingComponent slicing)

isPrimitive

public static boolean isPrimitive(String value)

getProfile

public StructureDefinition getProfile(StructureDefinition source,
                                      String url)
                               throws Exception

Throws:

Exception

sortDifferential

public void sortDifferential(StructureDefinition base,
                             StructureDefinition diff,
                             String name,
                             ProfileUtilities.ProfileKnowledgeProvider pkp,
                             List<String> errors)
                      throws EOperationOutcome,
                             Exception

Throws:

EOperationOutcome

Exception

generateSchematrons

public void generateSchematrons(OutputStream dest,
                                StructureDefinition structure)
                         throws Exception

Throws:

Exception