package scriptbuilder.structures;

/**
 *
 * @author Bryan McGuffin
 */
public class XMLWriter
{

    /**
     * XML-style opening tag. Example: if given string "my_tag", returns
     * "<my_tag>".
     *
     * @param s the XML element to be included in the tag.
     * @return the properly formatted tag
     */
    public static String openTag(String s)
    {
        return "<" + s + ">";
    }

    /**
     * XML-style closing tag. Example: if given string "my_tag", returns
     * "</my_tag>".
     *
     * @param s the XML element to be included in the tag.
     * @return the properly formatted tag
     */
    public static String closeTag(String s)
    {
        return "</" + s + ">\n";
    }

    /**
     * XML-style empty tag. Example: if given string "my_tag", returns
     * "<my_tag/>".
     *
     * @param s the XML element to be included in the tag.
     * @return the properly formatted tag
     */
    public static String emptyTag(String s)
    {
        return "<" + s + "/>\n";
    }

    /**
     * Creates a pair of XML open and close tags to wrap a simple line of data.
     * Useful if only one element need be enclosed in this particular tag.
     *
     * @param s the data to be wrapped
     * @param e the XML element represented by the data
     * @return an XML string of the format <my_tag>some_data_goes_here</my_tag>
     */
    public static String simpleTag(String s, ELEMENT e)
    {
        String output = "";
        if (s == null)
        {
            s = "";
        }

        output += openTag(e.tag);
        output += s;
        output += closeTag(e.tag);

        return output;
    }

    /**
     * Generates the internal DTD for XML script files.
     *
     * @return
     */
    public static String internalDTD()
    {
        String output = "";
        output += "<!DOCTYPE TMC_SCRIPT [\n";
        output += "<!ELEMENT TMC_SCRIPT (SCRIPT_DATA | SCRIPT_EVENT)*>\n"
                + "<!ATTLIST TMC_SCRIPT title CDATA #REQUIRED>\n"
                + "<!ELEMENT SCRIPT_DATA (NEW_UNIT*, CARDFILE*)>\n"
                + "<!ELEMENT NEW_UNIT (ID | STATUS | MASTER_INC_NUM | PRIMARY | OOS | TYPE | \n"
                + "CURR_LOC | DESTINATION | MISC_INFO | STACK | AREA | OFFICER | BADGE_NUM | TIMER | \n"
                + "OFFICE | P | AGY | ALIAS | UNIT_STATUS)*>\n"
                + "<!ATTLIST NEW_UNIT UnitNum CDATA #REQUIRED>\n"
                + "<!ELEMENT ID (#PCDATA)>\n"
                + "<!ELEMENT STATUS (#PCDATA)>\n"
                + "<!ELEMENT MASTER_INC_NUM (#PCDATA)>\n"
                + "<!ELEMENT PRIMARY (#PCDATA)>\n"
                + "<!ELEMENT OOS (#PCDATA)>\n"
                + "<!ELEMENT TYPE (#PCDATA)>\n"
                + "<!ELEMENT CURR_LOC (#PCDATA)>\n"
                + "<!ELEMENT DESTINATION (#PCDATA)>\n"
                + "<!ELEMENT MISC_INFO (#PCDATA)>\n"
                + "<!ELEMENT STACK (#PCDATA)>\n"
                + "<!ELEMENT AREA (#PCDATA)>\n"
                + "<!ELEMENT BADGE_NUM (#PCDATA)>\n"
                + "<!ELEMENT OFFICER (#PCDATA)>\n"
                + "<!ELEMENT OFFICE (#PCDATA)>\n"
                + "<!ELEMENT TIMER (#PCDATA)>\n"
                + "<!ELEMENT P (#PCDATA)>\n"
                + "<!ELEMENT AGY (#PCDATA)>\n"
                + "<!ELEMENT ALIAS (#PCDATA)>\n"
                + "<!ELEMENT UNIT_STATUS (#PCDATA)>\n"
                + "<!ELEMENT CARDFILE (NAME | ADDRESS | CITY | STATE | ZIP | PHONE | FAX | COMMENT)*>\n"
                + "<!ATTLIST CARDFILE Category CDATA #REQUIRED>\n"
                + "<!ELEMENT NAME (#PCDATA)>\n"
                + "<!ELEMENT ADDRESS (#PCDATA)>\n"
                + "<!ELEMENT CITY (#PCDATA)>\n"
                + "<!ELEMENT STATE (#PCDATA)>\n"
                + "<!ELEMENT ZIP (#PCDATA)>\n"
                + "<!ELEMENT PHONE (#PCDATA)>\n"
                + "<!ELEMENT FAX (#PCDATA)>\n"
                + "<!ELEMENT COMMENT (#PCDATA)>\n"
                + "<!ELEMENT SCRIPT_EVENT (TIME_INDEX | INCIDENT | COLOR | CAD_DATA | GENERAL_INFO |\n"
                + "ATMS_EVALUATION | CAD_EVALUATION | ACTIVITY_LOG_EVALUATION | FACILITATOR_EVALUATION |\n"
                + "RADIO_EVALUATION | CHP_RADIO | MAINTENANCE_RADIO | CMS_EVALUATION | TMT_RADIO | \n"
                + "TELEPHONE | CMS_EVALUATION)*>\n"
                + "<!ELEMENT TIME_INDEX (#PCDATA)>\n"
                + "<!ELEMENT INCIDENT (#PCDATA)>\n"
                + "<!ATTLIST INCIDENT LogNum CDATA #REQUIRED>\n"
                + "<!ELEMENT COLOR EMPTY>\n"
                + "<!ATTLIST COLOR r CDATA #REQUIRED>\n"
                + "<!ATTLIST COLOR g CDATA #REQUIRED>\n"
                + "<!ATTLIST COLOR b CDATA #REQUIRED>\n"
                + "<!ELEMENT CAD_DATA (HEADER_INFO | CAD_INCIDENT_EVENT | LOCATION_INFO | MASTER_INC_NUM |\n"
                + "P | ADDITIONAL_INFO | LOCATION | GENERAL)*>\n"
                + "<!ELEMENT HEADER_INFO (Type | Beat | TruncLoc | FullLoc)*>\n"
                + "<!ELEMENT Type (#PCDATA)>\n"
                + "<!ELEMENT Beat (#PCDATA)>\n"
                + "<!ELEMENT TruncLoc (#PCDATA)>\n"
                + "<!ELEMENT FullLoc (#PCDATA)>\n"
                + "<!ELEMENT CAD_INCIDENT_EVENT (DETAIL | AUDIO | UNIT | PARAMICS |\n"
                + "TOW | WITNESS | SERVICE | CCTV_INFO)*>\n"
                + "<!ELEMENT DETAIL (#PCDATA)>\n"
                + "<!ELEMENT AUDIO EMPTY>\n"
                + "<!ATTLIST AUDIO Length CDATA #REQUIRED>\n"
                + "<!ATTLIST AUDIO Path CDATA #REQUIRED>\n"
                + "<!ELEMENT UNIT EMPTY>\n"
                + "<!ATTLIST UNIT UnitNum CDATA #REQUIRED>\n"
                + "<!ATTLIST UNIT Status CDATA #REQUIRED>\n"
                + "<!ATTLIST UNIT Primary CDATA #REQUIRED>\n"
                + "<!ATTLIST UNIT Active CDATA #REQUIRED>\n"
                + "<!ELEMENT PARAMICS (Status | Incident_type | Lane_number)*>\n"
                + "<!ATTLIST PARAMICS LocationID CDATA #REQUIRED>\n"
                + "<!ELEMENT Status (#PCDATA)>\n"
                + "<!ELEMENT Incident_type (#PCDATA)>\n"
                + "<!ELEMENT Lane_number (#PCDATA)>\n"
                + "<!ELEMENT TOW EMPTY>\n"
                + "<!ATTLIST TOW Company CDATA #REQUIRED>\n"
                + "<!ATTLIST TOW ConfNum CDATA #REQUIRED>\n"
                + "<!ATTLIST TOW PubNum CDATA #REQUIRED>\n"
                + "<!ATTLIST TOW Beat CDATA #REQUIRED>\n"
                + "<!ELEMENT WITNESS EMPTY>\n"
                + "<!ATTLIST WITNESS Name CDATA #REQUIRED>\n"
                + "<!ATTLIST WITNESS Address CDATA #REQUIRED>\n"
                + "<!ATTLIST WITNESS PhoneNum CDATA #REQUIRED>\n"
                + "<!ELEMENT SERVICE (#PCDATA)>\n"
                + "<!ELEMENT CCTV_INFO (#PCDATA)>\n"
                + "<!ELEMENT LOCATION_INFO (Route | Direction | Postmile | Location_type)*>\n"
                + "<!ATTLIST LOCATION_INFO ID CDATA #REQUIRED>\n"
                + "<!ELEMENT Route (#PCDATA)>\n"
                + "<!ELEMENT Direction (#PCDATA)>\n"
                + "<!ELEMENT Postmile (#PCDATA)>\n"
                + "<!ELEMENT Location_type (#PCDATA)>\n"
                + "<!ELEMENT ADDITIONAL_INFO (TYPE_CODE, TYPE)>\n"
                + "<!ELEMENT TYPE_CODE (#PCDATA)>\n"
                + "<!ELEMENT LOCATION (#PCDATA | BEAT | ADDRESS | LOC | CITY | AREA | FIRE | LAW | EMS)*>\n"
                + "<!ELEMENT BEAT (#PCDATA)>\n"
                + "<!ELEMENT LOC (#PCDATA)>\n"
                + "<!ELEMENT FIRE (#PCDATA)>\n"
                + "<!ELEMENT LAW (#PCDATA)>\n"
                + "<!ELEMENT EMS (#PCDATA)>\n"
                + "<!ELEMENT GENERAL (AGY)>\n"
                + "<!ELEMENT GENERAL_INFO (TITLE, TEXT)>\n"
                + "<!ELEMENT TITLE (#PCDATA)>\n"
                + "<!ELEMENT TEXT (#PCDATA)>\n"
                + "<!ELEMENT ATMS_EVALUATION (EXPECTED_ACTION*)>\n"
                + "<!ELEMENT CAD_EVALUATION (EXPECTED_ACTION*)>\n"
                + "<!ELEMENT ACTIVITY_LOG_EVALUATION (EXPECTED_ACTION*)>\n"
                + "<!ELEMENT FACILITATOR_EVALUATION (EXPECTED_ACTION*)>\n"
                + "<!ELEMENT RADIO_EVALUATION (EXPECTED_ACTION*)>\n"
                + "<!ELEMENT EXPECTED_ACTION (#PCDATA)>\n"
                + "<!ELEMENT CHP_RADIO (DIALOG)>\n"
                + "<!ATTLIST CHP_RADIO RadioFile CDATA #REQUIRED>\n"
                + "<!ELEMENT DIALOG (LINE*)>\n"
                + "<!ELEMENT LINE (#PCDATA)>\n"
                + "<!ATTLIST LINE Role CDATA #REQUIRED>\n"
                + "<!ELEMENT MAINTENANCE_RADIO (#PCDATA)>\n"
                + "<!ELEMENT TMT_RADIO (#PCDATA)>\n"
                + "<!ELEMENT TELEPHONE (INSTRUCTOR | STUDENT)*>\n"
                + "<!ELEMENT INSTRUCTOR (#PCDATA)>\n"
                + "<!ATTLIST INSTRUCTOR Role CDATA #REQUIRED>\n"
                + "<!ELEMENT STUDENT (#PCDATA)>\n"
                + "<!ELEMENT CMS_EVALUATION (LOCATION | SAMPLE_MESSAGE)*>\n"
                + "<!ATTLIST CMS_EVALUATION cmsID CDATA #REQUIRED>\n"
                + "<!ATTLIST CMS_EVALUATION type CDATA #REQUIRED>\n"
                + "<!ELEMENT SAMPLE_MESSAGE (CMS_LINE*)>\n"
                + "<!ELEMENT CMS_LINE (#PCDATA)>";

        output += "]>\n";
        return output;
    }
}
