/*
The contents of this file are subject to the THDL Open Community License
Version 1.0 (the "License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License on the THDL web site 
(http://www.thdl.org/).

Software distributed under the License is distributed on an "AS IS" basis, 
WITHOUT WARRANTY OF ANY KIND, either express or implied. See the 
License for the specific terms governing rights and limitations under the 
License. 

The Initial Developer of this software is the Tibetan and Himalayan Digital
Library (THDL). Portions created by the THDL are Copyright 2003 THDL.
All Rights Reserved. 

Contributor(s): ______________________________________.
*/

package org.thdl.tib.text.ttt;

/**
* An ACIPString is some Latin text and a type, the type stating
* whether said text is Latin (usually English) or transliteration of
* Tibetan and which particular kind.  Scanning errors are also encoded
* as ACIPStrings using a special type.
*
* @author David Chandler
*/
public class ACIPString {
    private int type;
    private String text;

    /** Returns true if and only if an ACIPString with type type is to
     *  be converted to Latin, not Tibetan, text. */
    public static boolean isLatin(int type) {
        return (type != TIBETAN_NON_PUNCTUATION
                && type != TIBETAN_PUNCTUATION
                && type != START_SLASH
                && type != END_SLASH);
    }

    /** For [#COMMENTS] */
    public static final int COMMENT = 0;
    /** For Folio markers like @012B */
    public static final int FOLIO_MARKER = 1;
    /** For Latin letters and numbers etc.  [*LINE BREAK?] uses this,
     *  for example. */
    public static final int LATIN = 2;
    /** For Tibetan letters and numbers etc. */
    public static final int TIBETAN_NON_PUNCTUATION = 3;
    /** For tshegs, whitespace and the like, but not combining
     *  punctutation like %, o, :, m, and x */
    public static final int TIBETAN_PUNCTUATION = 4;
    /** For the start of a [*probable correction] or [*possible correction?] */
    public static final int CORRECTION_START = 5;
    /** Denotes the end of a [*probable correction] */
    public static final int PROBABLE_CORRECTION = 6;
    /** Denotes the end of a [*possible correction?] */
    public static final int POSSIBLE_CORRECTION = 7;
    /** For [BP] -- blank page */
    public static final int BP = 8;
    /** For [LS] -- Lanycha script on page */
    public static final int LS = 9;
    /** For [DR] -- picture (without caption) on page */
    public static final int DR = 10;
    /** For [DD], [DDD], [DD1], [DD2], etc. -- picture with caption on page */
    public static final int DD = 11;
    /** For [?] */
    public static final int QUESTION = 12;
    /** For the first / in /NYA/ */
    public static final int START_SLASH = 13;
    /** For the last / in /NYA/ */
    public static final int END_SLASH = 14;
    /** For the opening ( in (NYA) */
    public static final int START_PAREN = 15;
    /** For the closing ) in (NYA) */
    public static final int END_PAREN = 16;
    /** For things that are not legal syntax, such as a file that
     * contains just "[# HALF A COMMEN" */
    public static final int ERROR = 17;

    /** Returns true if and only if this string is Latin (usually
     *  English).  Returns false if this string is transliteration of
     *  Tibetan. */
    public int getType() {
        return type;
    }

    /** Returns the non-null, non-empty String of text associated with
     *  this string. */
    public String getText() {
        return text;
    }

    private void setType(int t) {
        if (t < COMMENT || t > ERROR)
            throw new IllegalArgumentException("Bad type");
        type = t;
    }

    private void setText(String t) {
        if (t == null || "".equals(t))
            throw new IllegalArgumentException("null or empty text, DD should have text [DD] e.g.");
        text = t;
    }

    /** Don't instantiate me. */
    private ACIPString() { }

    /** Creates a new ACIPString with source text <i>text</i> and type
     *  <i>type</i> being a characterization like {@link DD}. */
    public ACIPString(String text, int type) {
        setType(type);
        setText(text);
    }
    public String toString() {
        String typeString = "HUH?????";
        if (type == COMMENT) typeString = "COMMENT";
        if (type == FOLIO_MARKER) typeString = "FOLIO_MARKER";
        if (type == LATIN) typeString = "LATIN";
        if (type == TIBETAN_NON_PUNCTUATION) typeString = "TIBETAN_NON_PUNCTUATION";
        if (type == TIBETAN_PUNCTUATION) typeString = "TIBETAN_PUNCTUATION";
        if (type == CORRECTION_START) typeString = "CORRECTION_START";
        if (type == PROBABLE_CORRECTION) typeString = "PROBABLE_CORRECTION";
        if (type == POSSIBLE_CORRECTION) typeString = "POSSIBLE_CORRECTION";
        if (type == BP) typeString = "BP";
        if (type == LS) typeString = "LS";
        if (type == DR) typeString = "DR";
        if (type == DD) typeString = "DD";
        if (type == QUESTION) typeString = "QUESTION";
        if (type == START_SLASH) typeString = "START_SLASH";
        if (type == END_SLASH) typeString = "END_SLASH";
        if (type == START_PAREN) typeString = "START_PAREN";
        if (type == END_PAREN) typeString = "END_PAREN";
        if (type == ERROR) typeString = "ERROR";
        return typeString + ":{" + getText() + "}";
    }
}