Enum GuideParameterCode.ValueSet

    • Enum Constant Detail

      • APPLY

        public static final GuideParameterCode.ValueSet APPLY
        Apply Metadata Value

        If the value of this string 0..* parameter is one of the metadata fields then all conformance resources will have any specified [Resource].[field] overwritten with the ImplementationGuide.[field], where field is one of: version, date, status, publisher, contact, copyright, experimental, jurisdiction, useContext.

      • PATH_RESOURCE

        public static final GuideParameterCode.ValueSet PATH_RESOURCE
        Resource Path

        The value of this string 0..* parameter is a subfolder of the build context's location that is to be scanned to load resources. Scope is (if present) a particular resource type.

      • PATH_PAGES

        public static final GuideParameterCode.ValueSet PATH_PAGES
        Pages Path

        The value of this string 0..1 parameter is a subfolder of the build context's location that contains files that are part of the html content processed by the builder.

      • PATH_TX_CACHE

        public static final GuideParameterCode.ValueSet PATH_TX_CACHE
        Terminology Cache Path

        The value of this string 0..1 parameter is a subfolder of the build context's location that is used as the terminology cache. If this is not present, the terminology cache is on the local system, not under version control.

      • EXPANSION_PARAMETER

        public static final GuideParameterCode.ValueSet EXPANSION_PARAMETER
        Expansion Profile

        The value of this string 0..* parameter is a parameter (name=value) when expanding value sets for this implementation guide. This is particularly used to specify the versions of published terminologies such as SNOMED CT.

      • RULE_BROKEN_LINKS

        public static final GuideParameterCode.ValueSet RULE_BROKEN_LINKS
        Broken Links Rule

        The value of this string 0..1 parameter is either "warning" or "error" (default = "error"). If the value is "warning" then IG build tools allow the IG to be considered successfully build even when there is no internal broken links.

      • GENERATE_XML

        public static final GuideParameterCode.ValueSet GENERATE_XML
        Generate XML

        The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in XML format. If not present, the Publication Tool decides whether to generate XML.

      • GENERATE_JSON

        public static final GuideParameterCode.ValueSet GENERATE_JSON
        Generate JSON

        The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in JSON format. If not present, the Publication Tool decides whether to generate JSON.

      • GENERATE_TURTLE

        public static final GuideParameterCode.ValueSet GENERATE_TURTLE
        Generate Turtle

        The value of this boolean 0..1 parameter specifies whether the IG publisher creates examples in Turtle format. If not present, the Publication Tool decides whether to generate Turtle.

      • HTML_TEMPLATE

        public static final GuideParameterCode.ValueSet HTML_TEMPLATE
        HTML Template

        The value of this string singleton parameter is the name of the file to use as the builder template for each generated page (see templating).

    • Method Detail

      • values

        public static GuideParameterCode.ValueSet[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (GuideParameterCode.ValueSet c : GuideParameterCode.ValueSet.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static GuideParameterCode.ValueSet valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • value

        public String value()
        Returns:
        The java.lang.String value of the code represented by this enum
      • from

        public static GuideParameterCode.ValueSet from​(String value)
        Factory method for creating GuideParameterCode.ValueSet values from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value