com.imsweb.layout.LayoutFactory Maven / Gradle / Ivy
package com.imsweb.layout;
import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.TreeMap;
import java.util.concurrent.ConcurrentHashMap;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.lang3.StringUtils;
import com.imsweb.layout.hl7.NaaccrHl7Layout;
import com.imsweb.layout.naaccrxml.NaaccrXmlLayout;
import com.imsweb.layout.record.csv.CommaSeparatedLayout;
import com.imsweb.layout.record.fixed.FixedColumnsLayout;
import com.imsweb.layout.record.fixed.naaccr.NaaccrLayout;
/**
* This class is responsible for caching layouts and creating the internal ones. It also provides a file format discovery mechanism.
*
* Layouts can be used to read and write formatted files; the NAACCR formats are supported by default (those are the "internal" layouts)
* but other user-defined layouts can also be registered. Fixed columns and CSV layout types are fully supported.
*
* To read/write a file, the first thing to do is to determine which layout to use. This is accomplished using one of the discoverFormat methods.
* Once this is done, one of the LayoutInfo objects can be used to call getLayout using the correct layout ID. The returned
* Layout object can then be used for both reading and writing operations (it might have to be cast into a RecordLayout first).
*
* There are two ways to register a layout:
*
* - Build it programmatically (either a
FixedColumnsLayout or a CommaSeparatedLayout instance) and call the
* registerLayout() method from this class, passing the built layout as an argument.
* - Build it from an XML file using one of the
LayoutUtils utility methods, then create the layout instance by
* providing the XML object to its constructor; and finally call the registerLayout() method from this class, passing the built layout as an argument.
*
* This class caches the loaded layout, to clear the caches and free some memory, call one fo the unregisterLayout() or unregisterAllLayouts() method.
*
* Created on Jun 23, 2012 by Fabian Depry
*/
public final class LayoutFactory {
//XML Layouts - constants for the internal layout IDs
public static final String LAYOUT_ID_NAACCR_XML_22 = "naaccr-xml-22"; // shortcut for full abstract
public static final String LAYOUT_ID_NAACCR_XML_22_ABSTRACT = "naaccr-xml-22-abstract";
public static final String LAYOUT_ID_NAACCR_XML_22_MODIFIED = "naaccr-xml-22-modified";
public static final String LAYOUT_ID_NAACCR_XML_22_CONFIDENTIAL = "naaccr-xml-22-confidential";
public static final String LAYOUT_ID_NAACCR_XML_22_INCIDENCE = "naaccr-xml-22-incidence";
public static final String LAYOUT_ID_NAACCR_XML_21 = "naaccr-xml-21"; // shortcut for full abstract
public static final String LAYOUT_ID_NAACCR_XML_21_ABSTRACT = "naaccr-xml-21-abstract";
public static final String LAYOUT_ID_NAACCR_XML_21_MODIFIED = "naaccr-xml-21-modified";
public static final String LAYOUT_ID_NAACCR_XML_21_CONFIDENTIAL = "naaccr-xml-21-confidential";
public static final String LAYOUT_ID_NAACCR_XML_21_INCIDENCE = "naaccr-xml-21-incidence";
public static final String LAYOUT_ID_NAACCR_XML_18 = "naaccr-xml-18"; // shortcut for full abstract
public static final String LAYOUT_ID_NAACCR_XML_18_ABSTRACT = "naaccr-xml-18-abstract";
public static final String LAYOUT_ID_NAACCR_XML_18_MODIFIED = "naaccr-xml-18-modified";
public static final String LAYOUT_ID_NAACCR_XML_18_CONFIDENTIAL = "naaccr-xml-18-confidential";
public static final String LAYOUT_ID_NAACCR_XML_18_INCIDENCE = "naaccr-xml-18-incidence";
public static final String LAYOUT_ID_NAACCR_XML_16 = "naaccr-xml-16"; // shortcut for full abstract
public static final String LAYOUT_ID_NAACCR_XML_16_ABSTRACT = "naaccr-xml-16-abstract";
public static final String LAYOUT_ID_NAACCR_XML_16_MODIFIED = "naaccr-xml-16-modified";
public static final String LAYOUT_ID_NAACCR_XML_16_CONFIDENTIAL = "naaccr-xml-16-confidential";
public static final String LAYOUT_ID_NAACCR_XML_16_INCIDENCE = "naaccr-xml-16-incidence";
public static final String LAYOUT_ID_NAACCR_XML_15 = "naaccr-xml-15"; // shortcut for full abstract
public static final String LAYOUT_ID_NAACCR_XML_15_ABSTRACT = "naaccr-xml-15-abstract";
public static final String LAYOUT_ID_NAACCR_XML_15_MODIFIED = "naaccr-xml-15-modified";
public static final String LAYOUT_ID_NAACCR_XML_15_CONFIDENTIAL = "naaccr-xml-15-confidential";
public static final String LAYOUT_ID_NAACCR_XML_15_INCIDENCE = "naaccr-xml-15-incidence";
public static final String LAYOUT_ID_NAACCR_XML_14 = "naaccr-xml-14"; // shortcut for full abstract
public static final String LAYOUT_ID_NAACCR_XML_14_ABSTRACT = "naaccr-xml-14-abstract";
public static final String LAYOUT_ID_NAACCR_XML_14_MODIFIED = "naaccr-xml-14-modified";
public static final String LAYOUT_ID_NAACCR_XML_14_CONFIDENTIAL = "naaccr-xml-14-confidential";
public static final String LAYOUT_ID_NAACCR_XML_14_INCIDENCE = "naaccr-xml-14-incidence";
//Fixed column layouts
public static final String LAYOUT_ID_NAACCR_18 = "naaccr-18"; // shortcut for full abstract
public static final String LAYOUT_ID_NAACCR_18_ABSTRACT = "naaccr-18-abstract";
public static final String LAYOUT_ID_NAACCR_18_MODIFIED = "naaccr-18-modified";
public static final String LAYOUT_ID_NAACCR_18_CONFIDENTIAL = "naaccr-18-confidential";
public static final String LAYOUT_ID_NAACCR_18_INCIDENCE = "naaccr-18-incidence";
public static final String LAYOUT_ID_NAACCR_16 = "naaccr-16"; // shortcut for full abstract
public static final String LAYOUT_ID_NAACCR_16_ABSTRACT = "naaccr-16-abstract";
public static final String LAYOUT_ID_NAACCR_16_MODIFIED = "naaccr-16-modified";
public static final String LAYOUT_ID_NAACCR_16_CONFIDENTIAL = "naaccr-16-confidential";
public static final String LAYOUT_ID_NAACCR_16_INCIDENCE = "naaccr-16-incidence";
public static final String LAYOUT_ID_NAACCR_15 = "naaccr-15"; // shortcut for full abstract
public static final String LAYOUT_ID_NAACCR_15_ABSTRACT = "naaccr-15-abstract";
public static final String LAYOUT_ID_NAACCR_15_MODIFIED = "naaccr-15-modified";
public static final String LAYOUT_ID_NAACCR_15_CONFIDENTIAL = "naaccr-15-confidential";
public static final String LAYOUT_ID_NAACCR_15_INCIDENCE = "naaccr-15-incidence";
public static final String LAYOUT_ID_NAACCR_14 = "naaccr-14"; // shortcut for full abstract
public static final String LAYOUT_ID_NAACCR_14_ABSTRACT = "naaccr-14-abstract";
public static final String LAYOUT_ID_NAACCR_14_MODIFIED = "naaccr-14-modified";
public static final String LAYOUT_ID_NAACCR_14_CONFIDENTIAL = "naaccr-14-confidential";
public static final String LAYOUT_ID_NAACCR_14_INCIDENCE = "naaccr-14-incidence";
public static final String LAYOUT_ID_NAACCR_13 = "naaccr-13"; // shortcut for full abstract
public static final String LAYOUT_ID_NAACCR_13_ABSTRACT = "naaccr-13-abstract";
public static final String LAYOUT_ID_NAACCR_13_MODIFIED = "naaccr-13-modified";
public static final String LAYOUT_ID_NAACCR_13_CONFIDENTIAL = "naaccr-13-confidential";
public static final String LAYOUT_ID_NAACCR_13_INCIDENCE = "naaccr-13-incidence";
public static final String LAYOUT_ID_NAACCR_12 = "naaccr-12"; // shortcut for full abstract
public static final String LAYOUT_ID_NAACCR_12_ABSTRACT = "naaccr-12-abstract";
public static final String LAYOUT_ID_NAACCR_12_MODIFIED = "naaccr-12-modified";
public static final String LAYOUT_ID_NAACCR_12_CONFIDENTIAL = "naaccr-12-confidential";
public static final String LAYOUT_ID_NAACCR_12_INCIDENCE = "naaccr-12-incidence";
//Hl7 layouts
public static final String LAYOUT_ID_NAACCR_HL7_V5 = "naaccr-hl7-5.0";
public static final String LAYOUT_ID_NAACCR_HL7_V4 = "naaccr-hl7-4.0";
// regular expressions for some of the the internal IDs
private static final Pattern _REGEX_NAACCR_XML_IDS = Pattern.compile("naaccr-xml-(\\d\\d)-(abstract|modified|confidential|incidence)");
private static final Pattern _REGEX_NAACCR_FIXED_IDS = Pattern.compile("naaccr-(\\d\\d)-(abstract|modified|confidential|incidence)");
// internal alias IDs resolution, any of the keys will be translated into its value...
private static final Map _INTERNAL_LAYOUT_ID_ALIASES = new HashMap<>();
// make sure to put all the "aliases" in this list...
static {
_INTERNAL_LAYOUT_ID_ALIASES.put(LAYOUT_ID_NAACCR_XML_22, LAYOUT_ID_NAACCR_XML_22_ABSTRACT);
_INTERNAL_LAYOUT_ID_ALIASES.put(LAYOUT_ID_NAACCR_XML_21, LAYOUT_ID_NAACCR_XML_21_ABSTRACT);
_INTERNAL_LAYOUT_ID_ALIASES.put(LAYOUT_ID_NAACCR_XML_18, LAYOUT_ID_NAACCR_XML_18_ABSTRACT);
_INTERNAL_LAYOUT_ID_ALIASES.put(LAYOUT_ID_NAACCR_XML_16, LAYOUT_ID_NAACCR_XML_16_ABSTRACT);
_INTERNAL_LAYOUT_ID_ALIASES.put(LAYOUT_ID_NAACCR_XML_15, LAYOUT_ID_NAACCR_XML_15_ABSTRACT);
_INTERNAL_LAYOUT_ID_ALIASES.put(LAYOUT_ID_NAACCR_XML_14, LAYOUT_ID_NAACCR_XML_14_ABSTRACT);
_INTERNAL_LAYOUT_ID_ALIASES.put(LAYOUT_ID_NAACCR_18, LAYOUT_ID_NAACCR_18_ABSTRACT);
_INTERNAL_LAYOUT_ID_ALIASES.put(LAYOUT_ID_NAACCR_16, LAYOUT_ID_NAACCR_16_ABSTRACT);
_INTERNAL_LAYOUT_ID_ALIASES.put(LAYOUT_ID_NAACCR_15, LAYOUT_ID_NAACCR_15_ABSTRACT);
_INTERNAL_LAYOUT_ID_ALIASES.put(LAYOUT_ID_NAACCR_14, LAYOUT_ID_NAACCR_14_ABSTRACT);
_INTERNAL_LAYOUT_ID_ALIASES.put(LAYOUT_ID_NAACCR_13, LAYOUT_ID_NAACCR_13_ABSTRACT);
_INTERNAL_LAYOUT_ID_ALIASES.put(LAYOUT_ID_NAACCR_12, LAYOUT_ID_NAACCR_12_ABSTRACT);
}
// internal layouts information (IDs and names)
private static final Map _INTERNAL_LAYOUTS = new LinkedHashMap<>();
// make sure to add the most recent layouts first, they will be "tried" in that order (important for discovery mechanism)
static {
//NAACCR XML
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_22, "NAACCR XML 21 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_22_ABSTRACT, "NAACCR XML 22 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_22_MODIFIED, "NAACCR XML 22 Modified");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_22_CONFIDENTIAL, "NAACCR XML 22 Confidential");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_22_INCIDENCE, "NAACCR XML 22 Incidence");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_21, "NAACCR XML 21 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_21_ABSTRACT, "NAACCR XML 21 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_21_MODIFIED, "NAACCR XML 21 Modified");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_21_CONFIDENTIAL, "NAACCR XML 21 Confidential");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_21_INCIDENCE, "NAACCR XML 21 Incidence");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_18, "NAACCR XML 18 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_18_ABSTRACT, "NAACCR XML 18 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_18_MODIFIED, "NAACCR XML 18 Modified");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_18_CONFIDENTIAL, "NAACCR XML 18 Confidential");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_18_INCIDENCE, "NAACCR XML 18 Incidence");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_16, "NAACCR XML 16 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_16_ABSTRACT, "NAACCR XML 16 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_16_MODIFIED, "NAACCR XML 16 Modified");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_16_CONFIDENTIAL, "NAACCR XML 16 Confidential");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_16_INCIDENCE, "NAACCR XML 16 Incidence");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_15, "NAACCR XML 15 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_15_ABSTRACT, "NAACCR XML 15 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_15_MODIFIED, "NAACCR XML 15 Modified");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_15_CONFIDENTIAL, "NAACCR XML 15 Confidential");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_15_INCIDENCE, "NAACCR XML 15 Incidence");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_14, "NAACCR XML 14 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_14_ABSTRACT, "NAACCR XML 14 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_14_MODIFIED, "NAACCR XML 14 Modified");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_14_CONFIDENTIAL, "NAACCR XML 14 Confidential");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_XML_14_INCIDENCE, "NAACCR XML 14 Incidence");
// NAACCR FIXED_COLUMNS
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_18, "NAACCR 18 Abstract");// kept for backward compatibility...
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_18_ABSTRACT, "NAACCR 18 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_18_MODIFIED, "NAACCR 18 Modified");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_18_CONFIDENTIAL, "NAACCR 18 Confidential");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_18_INCIDENCE, "NAACCR 18 Incidence");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_16, "NAACCR 16 Abstract"); // kept for backward compatibility...
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_16_ABSTRACT, "NAACCR 16 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_16_MODIFIED, "NAACCR 16 Modified");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_16_CONFIDENTIAL, "NAACCR 16 Confidential");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_16_INCIDENCE, "NAACCR 16 Incidence");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_15, "NAACCR 15 Abstract"); // kept for backward compatibility...
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_15_ABSTRACT, "NAACCR 15 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_15_MODIFIED, "NAACCR 15 Modified");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_15_CONFIDENTIAL, "NAACCR 15 Confidential");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_15_INCIDENCE, "NAACCR 15 Incidence");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_14, "NAACCR 14 Abstract"); // kept for backward compatibility...
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_14_ABSTRACT, "NAACCR 14 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_14_MODIFIED, "NAACCR 14 Modified");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_14_CONFIDENTIAL, "NAACCR 14 Confidential");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_14_INCIDENCE, "NAACCR 14 Incidence");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_13, "NAACCR 13 Abstract"); // kept for backward compatibility...
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_13_ABSTRACT, "NAACCR 13 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_13_MODIFIED, "NAACCR 13 Modified");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_13_CONFIDENTIAL, "NAACCR 13 Confidential");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_13_INCIDENCE, "NAACCR 13 Incidence");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_12, "NAACCR 12 Abstract"); // kept for backward compatibility...
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_12_ABSTRACT, "NAACCR 12 Abstract");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_12_MODIFIED, "NAACCR 12 Modified");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_12_CONFIDENTIAL, "NAACCR 12 Confidential");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_12_INCIDENCE, "NAACCR 12 Incidence");
// NAACCR HL7
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_HL7_V4, "NAACCR HL7 v4.0");
_INTERNAL_LAYOUTS.put(LAYOUT_ID_NAACCR_HL7_V5, "NAACCR HL7 v5.0");
}
// registered layouts (internal and external)
private static final Map _LAYOUTS = new ConcurrentHashMap<>();
/**
* Helper method to load an internal layout. I am putting this method on the top so it's clear it has to be updated when adding support for new NAACCR versions.
*
* @param layoutId internal layout ID to load
* @param loadFields if false, the fields won't be loaded
* @return the loaded layout
*/
private static Layout loadInternalLayout(String layoutId, boolean loadFields, boolean useDeprecatedFieldNames) {
Layout layout = null;
// note that this method doesn't deal with ID aliases, and it's on purpose, we want to load only the true layouts...
// try NAACCR XML
Matcher matcher = _REGEX_NAACCR_XML_IDS.matcher(layoutId);
if (matcher.matches()) {
String version = matcher.group(1);
String type = StringUtils.capitalize(matcher.group(2));
String rType = type.substring(0, 1);
layout = new NaaccrXmlLayout(version + "0", rType, layoutId, _INTERNAL_LAYOUTS.get(layoutId), "Standard XML NAACCR " + version + " " + type + " layout", null, loadFields);
}
// try NAACCR flat
if (layout == null) {
matcher = _REGEX_NAACCR_FIXED_IDS.matcher(layoutId);
if (matcher.matches()) {
String version = matcher.group(1);
String type = StringUtils.capitalize(matcher.group(2));
String rType = type.substring(0, 1);
int lineLength;
if ("18".equals(version))
lineLength = "A".equals(rType) || "M".equals(rType) ? 24194 : "C".equals(rType) ? 6154 : 4048;
else
lineLength = "A".equals(rType) || "M".equals(rType) ? 22824 : "C".equals(rType) ? 5564 : 3339;
layout = new NaaccrLayout("12".equals(version) ? "122" : (version + "0"), type.substring(0, 1), lineLength, layoutId, loadFields, useDeprecatedFieldNames);
}
}
// try NAACCR HL7
if (layout == null) {
if (LAYOUT_ID_NAACCR_HL7_V5.equals(layoutId))
layout = new NaaccrHl7Layout(LAYOUT_ID_NAACCR_HL7_V5, "5.0", "2.5.1", loadFields);
else if (LAYOUT_ID_NAACCR_HL7_V4.equals(layoutId))
layout = new NaaccrHl7Layout(LAYOUT_ID_NAACCR_HL7_V4, "4.0", "2.5.1", loadFields);
}
if (layout == null)
throw new RuntimeException("Unknown internal layout: " + layoutId);
return layout;
}
/**
* Private constructor, no instancication...
*
* Created on Jun 23, 2012 by Fabian
*/
private LayoutFactory() {
}
/**
* Returns the requested NAACCR XML layout, throws a runtime exception if layout is not found or not a NAACCR XML layout.
* @param layoutId requested layout ID, cannot be null
* @return requested layout, never null
*/
public static NaaccrXmlLayout getNaaccrXmlLayout(String layoutId) {
Layout layout = getLayout(layoutId);
if (layout instanceof NaaccrXmlLayout)
return (NaaccrXmlLayout)layout;
throw new RuntimeException("Requested a NaaccrXmlLayout but it was a " + layout.getClass().getSimpleName());
}
/**
* Returns the requested NAACCR fixed-column layout, throws a runtime exception if layout is not found or not a NAACCR fixed-column layout.
* @param layoutId requested layout ID, cannot be null
* @return requested layout, never null
*/
public static NaaccrLayout getNaaccrFixedColumnsLayout(String layoutId) {
Layout layout = getLayout(layoutId);
if (layout instanceof NaaccrLayout)
return (NaaccrLayout)layout;
throw new RuntimeException("Requested a NaaccrLayout but it was a " + layout.getClass().getSimpleName());
}
/**
* Returns the requested NAACCR fixed-column layout, throws a runtime exception if layout is not found or not a NAACCR fixed-column layout.
* @param layoutId requested layout ID, cannot be null
* @return requested layout, never null
*/
public static NaaccrHl7Layout getNaaccrHl7Layout(String layoutId) {
Layout layout = getLayout(layoutId);
if (layout instanceof NaaccrHl7Layout)
return (NaaccrHl7Layout)layout;
throw new RuntimeException("Requested a NaaccrHl7Layout but it was a " + layout.getClass().getSimpleName());
}
/**
* Returns the requested fixed-columns layout, throws a runtime exception if layout is not found or not a fixed-columns layout.
* @param layoutId requested layout ID, cannot be null
* @return requested layout, never null
*/
public static FixedColumnsLayout getFixedColumnsLayout(String layoutId) {
Layout layout = getLayout(layoutId);
if (layout instanceof FixedColumnsLayout)
return (FixedColumnsLayout)layout;
throw new RuntimeException("Requested a FixedColumnsLayout but it was a " + layout.getClass().getSimpleName());
}
/**
* Returns the requested comma-separated layout, throws a runtime exception if layout is not found or not a comma-separated layout.
* @param layoutId requested layout ID, cannot be null
* @return requested layout, never null
*/
public static CommaSeparatedLayout getCommaSeparatedLayout(String layoutId) {
Layout layout = getLayout(layoutId);
if (layout instanceof CommaSeparatedLayout)
return (CommaSeparatedLayout)layout;
throw new RuntimeException("Requested a CommaSeparatedLayout but it was a " + layout.getClass().getSimpleName());
}
/**
* Returns the requested layout.
*
* Throws a RuntimeException if the layout ID doesn't exist; you should check whether the layout exists before calling this method by either
*
* - using the getAvailableLayouts() method
* - using one of the discoverFormat() methods
*
* This method will never throw an exception when using one of the layout IDs defined as constants in this class.
*
* @param layoutId requested layout ID, cannot be null
* @return requested layout, never null
*/
public static Layout getLayout(String layoutId) {
return getLayout(layoutId, false);
}
/**
* Returns the requested layout.
*
* Throws a RuntimeException if the layout ID doesn't exist; you should check whether the layout exists before calling this method by either
*
* - using the getAvailableLayouts() method
* - using one of the discoverFormat() methods
*
* This method will never throw an exception when using one of the layout IDs defined as constants in this class.
*
* @param layoutId requested layout ID, cannot be null
* @param useDeprecatedFieldNames if set to true, the old layout names will be used, otherwise the new XML-aligned ones will be used (only applicable to internal NAACCR layouts).
* @return requested layout, never null
*/
public static synchronized Layout getLayout(String layoutId, boolean useDeprecatedFieldNames) {
// check if an alias ID was requested (used for backward compatibility)
if (_INTERNAL_LAYOUT_ID_ALIASES.containsKey(layoutId))
layoutId = _INTERNAL_LAYOUT_ID_ALIASES.get(layoutId);
// if the layout is already registered, just return it
if (_LAYOUTS.containsKey(layoutId))
return _LAYOUTS.get(layoutId);
// if no registered layout is found, let's check the internal ones
if (_INTERNAL_LAYOUTS.containsKey(layoutId)) {
Layout layout = loadInternalLayout(layoutId, true, useDeprecatedFieldNames);
_LAYOUTS.put(layout.getLayoutId(), layout);
return layout;
}
throw new RuntimeException("Unknown layout ID: " + layoutId);
}
/**
* Registers the provided layout.
*
* If the layout is not valid in any way, a RuntimeException will be thrown (it is an unchecked excpetion because the validation
* already happens when the layout object is created, so this is a safety net; we don't expect any validation issues in this method.
*
* @param layout layout to register, cannot be null
*/
public static synchronized void registerLayout(Layout layout) {
// make sure the layout is valid
if (layout == null)
throw new RuntimeException("Provided layout instance is null");
//Layout ID's must be unique
if (_INTERNAL_LAYOUTS.containsKey(layout.getLayoutId()) || _LAYOUTS.containsKey(layout.getLayoutId()))
throw new RuntimeException("Layout ID must be unique: '" + layout.getLayoutId() + "' has already been registered");
if (layout instanceof FixedColumnsLayout)
((FixedColumnsLayout)layout).verify();
else if (layout instanceof CommaSeparatedLayout)
((CommaSeparatedLayout)layout).verify();
_LAYOUTS.put(layout.getLayoutId(), layout);
}
/**
* Unregisters the layout corresponding to the provided layout ID.
*
* @param layoutId layout ID to unregister
*/
public static synchronized void unregisterLayout(String layoutId) {
_LAYOUTS.remove(layoutId);
}
/**
* Unregisters all the registered layouts.
*/
public static synchronized void unregisterAllLayouts() {
_LAYOUTS.clear();
}
/**
* Returns true if the layout ID has been registered, false otherwise.
*
* @param layoutId requested layout ID
* @return true if the layout ID has been registered, false otherwise
*/
public static synchronized boolean isLayoutRegister(String layoutId) {
return _LAYOUTS.containsKey(layoutId);
}
/**
* Returns the IDs of all the layouts currently registered.
*
* @return the IDs of all the layouts currently registered
*/
public static synchronized Set getRegisterLayouts() {
return Collections.unmodifiableSet(_LAYOUTS.keySet());
}
/**
* Returns a map ID -> Name of the internal layouts.
*
* @return a map ID -> Name of the internal layouts
*/
public static Map getAvailableInternalLayouts() {
Map result = new HashMap<>(_INTERNAL_LAYOUTS);
// don't want to expose the aliases...
for (String alias : _INTERNAL_LAYOUT_ID_ALIASES.keySet())
result.remove(alias);
return result;
}
/**
* Returns a map ID -> Name of the available layouts (registered external plus any internal).
*
* @return a map ID -> Name of the registered layouts (registered external plus any internal)
*/
public static Map getAvailableLayouts() {
Map result = new HashMap<>();
// add registered layouts
for (Entry entry : _LAYOUTS.entrySet())
result.put(entry.getKey(), entry.getValue().getLayoutName());
// add internal layouts that have not been registered yet
for (Entry entry : _INTERNAL_LAYOUTS.entrySet())
if (!_INTERNAL_LAYOUT_ID_ALIASES.containsKey(entry.getKey()) && !result.containsKey(entry.getKey()))
result.put(entry.getKey(), entry.getValue());
return result;
}
/**
* Discovers the format of the given file.
*
* See other flavors of this method for full explanation.
*
* @param file file to analyze
* @return the list of layout info representing the layouts that can handle this data file.
*/
public static List discoverFormat(File file) {
return discoverFormat(file, null, new LayoutInfoDiscoveryOptions());
}
/**
* Discovers the format of the given file, using the given zip entry if the file is a zip file.
*
* See other flavors of this method for full explanation.
*
* @param file file to analyze
* @param zipEntryName zip entry to use if the file is a zip file, not used if the file is not a zip file
* @return the list of layout info representing the layouts that can handle this data file.
*/
public static List discoverFormat(File file, String zipEntryName) {
return discoverFormat(file, zipEntryName, null);
}
/**
* Discovers the format of the given file using the provided discovery options.
*
* See other flavors of this method for full explanation.
*
* @param file file to analyze
* @param options discovery options
* @return the list of layout info representing the layouts that can handle this data file.
*/
public static List discoverFormat(File file, LayoutInfoDiscoveryOptions options) {
return discoverFormat(file, null, options);
}
/**
* Discovers the format of the given file using the provided discovery options.
*
* The layouts are tried in the following order:
*
* - the registered external layouts (in alphabetical order on the layout ID, so the the order is deterministic)
* - the registered internal layouts
* - the internal layouts that have not been registered yet
*
* Interal NAACCR layouts are tried from most recent version to oldest one.
*
* Because of that particular order, the returned list of layout info will usually have the "best" layout as first element. If an application doesn't want to
* present all the possibilities to the user, then it can just use that first element and nothing else.
*
* @param file file to analyze
* @param zipEntryName optional zip entry to use if the file is a zip file, not used if the file is not a zip file
* @param options discovery options
* @return the list of layout info representing the layouts that can handle this data file.
*/
public static List discoverFormat(File file, String zipEntryName, LayoutInfoDiscoveryOptions options) {
List result = new ArrayList<>();
if (options == null)
options = new LayoutInfoDiscoveryOptions();
// try the registered external layout
for (Entry entry : new TreeMap<>(_LAYOUTS).entrySet()) {
if (!_INTERNAL_LAYOUTS.containsKey(entry.getKey())) {
LayoutInfo info = entry.getValue().buildFileInfo(file, zipEntryName, options);
if (info != null)
result.add(info);
}
}
// try the registered internal layout
for (String layoutId : _INTERNAL_LAYOUTS.keySet()) {
if (_LAYOUTS.containsKey(layoutId)) {
LayoutInfo info = _LAYOUTS.get(layoutId).buildFileInfo(file, zipEntryName, options);
if (info != null)
result.add(info);
}
}
// try the internal layout that have not been registered yet
for (String layoutId : _INTERNAL_LAYOUTS.keySet()) {
if (!_LAYOUTS.containsKey(layoutId) && !_INTERNAL_LAYOUT_ID_ALIASES.containsKey(layoutId)) {
Layout layout = loadInternalLayout(layoutId, false, false);
LayoutInfo info = layout.buildFileInfo(file, zipEntryName, options);
if (info != null)
result.add(info);
}
}
return result;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy