org.thdl.tib.bibl
Class XMLDoc

java.lang.Object
  |
  +--org.jdom.Document
        |
        +--org.thdl.tib.bibl.XMLDoc
All Implemented Interfaces:
Cloneable, Serializable, TibConstants
Direct Known Subclasses:
TibDoc

public class XMLDoc
extends Document
implements TibConstants

This class extends org.jdom.Document to provide added XML functionality, such as locating specific elements. Some of its methods are specific to the TIBBIBL DTD, others are more general in function. XMLDoc is in turn extended by TibDoc, which adds more specific functionality and is the class used in the TiblEdit program. This class needs to be cleaned up so that only the most general XML functions remain and the functions that are specific to our DTD are relegated to TibDoc.

Author:
Than Garson, Tibetan and Himalayan Digital Library
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.jdom.Document
content, docType
 
Fields inherited from interface org.thdl.tib.bibl.TibConstants
ABBR, ABOUT, ADD_DOX, ALT, ANUYOGA, AP, AP_CHECK, APP_SUBMIT, ATIYOGA, BACK, BAD_PARA, BASE_FONT_NAME, BASE_FONT_SIZE, BG, BIN, BIN_LOGIN, BODY, BOLD, BOLD_FONT, BRIEF, BUT_MARGINS, BUTT_PANEL_SIZE, BUTTON_SIZE, CANC, CANCEL, CANCEL_NEW_APP, CATEG, CHANGE, CHAP_TITLES_HEAD, CHAPS, CHAPTER, CIT, CLASS, CLOSE_TITLE_HEAD, CLOSEFILE, CLOSING, CONTROL, CONTROL_SOURCE, CONTROLLER, CORRESP, CORRESP_NG, CREATE_FILE_LIST, CREATE_FILE_LIST_SPECS, CREATE_FILE_LIST_TITLE, CREATOR, CRIT_ED_DESC, CRIT_ED_LABEL, CRIT_TITLE, CROSSREF, CURR_DIR, DATA_DIRECTORY, DATE, DATE_DELIM, DATE_MESSAGE, DATE_TITLE, DEFAULT_BGCOLOR, DEFAULT_BUTTON_COLOR, DEFAULT_DIRECTORY, DEFAULT_FONT, DEFAULT_HEADER, DEFAULT_INSETS, DEFAULT_PANEL_SIZE, DEL_EDS_MESS, DEL_EDS_TITLE, DESIG, DG, DIA_DATA, DIAC, DISC, DISC_DIA_TITLE, DIV, DO_ALL_TITLES, DO_TRANS, DOX, DOX_CAT_DELIM, DOX_DELIM, DOX_WINDOW_TITLE, DOXTYPE, ED, ED_EXISTS, ED_EXISTS_MESSAGE, ED_EXISTS_SPECS, ED_EXISTS_TITLE, ED_ID_MESS, ED_ID_REQUIRED, ED_ID_TITLE, ED_INFO, ED_NAME, ED_SCROLL_SIZE, ED_SIG, ED_SIGLA, ED_STRING, ED_TEXT_NUM, ED_TITLE, ED_TITLE_REM, ED_VOL_LET, ED_VOL_NUM, EDCON, EDCONS, EDIT, EDITOR_NAME_MESSAGE, EDITOR_NAME_TITLE, EDITORS_INFO, EDITORS_INFO_SPECS, EDITORS_INITIALS, EDITORS_NAME, EDNAMES, EDS_CORR, ENG, ENTER, ENTER_NORM_TRANS_PHRASE, ENTER_NORMALIZED, ENTER_NORMALIZED_PHRASE, ENTER_PLACE, ENTER_TITLE_PHRASE, ENTER_TRANS, ENTER_TRANS_PHRASE, EOC, EOC_TITLES_HEAD, EX1, EX2, EXIT, EXPAN, EXPORT, FILE, FILE_EXISTS, FILE_EXISTS_SPECS, FILE_EXISTS_TITLE, FOREIGN, FRAME, FRONT, FULL, FULL_TEXT_PAGE, GEN, GET_DESIG, GET_DESIG_QUESTION, GET_DESIG_SPECS, HEAD, HEAD_FONT, HEAD_FONT_SIZE, HI, ID, INFO, INPUT_DATE_MESSAGE, INPUT_DATE_TITLE, INSERT, INSERT_APP, INTDECL, INV_TRANS, INV_TRANS_TITLE, INVALID_TRANS_SPECS, IS_FILE_LIST, ITALIC, ITEM, JOP_ERROR, JOP_INFO, JOP_QUEST, JOP_WARN, JOP_YESNOCANCEL, KG, LABEL_SIZE, LABEL_SPACE, LANG, LANG_ENG, LANG_TIB, LET, LIST, LIST_COLOR, LIST_INSETS, LM, LVL, MAHAYOGA, MAIN_MARGINS, MASTER_ID_VIEW, MASTER_SIGLA, MENU_FONT, MISC, N, NAME, NEW_AP, NEW_ED_INFO, NEW_ED_INFO_SPECS, NEW_ED_TITLE_INFO, NEW_ED_TITLE_INFO_SPECS, NEW_TITLE, NG, NGDIVS, NGSIGS, NO, NO_ELEM, NO_SELECT_TITLE, NO_SELECTION, NO_SELECTION_SPECS, NO_TITLE, NO_TITLE_MESSAGE, NO_TITLE_SPECS, NO_TITLE_TITLE, NON_TIB_HEAD, NON_TIB_TITLE_HEAD, NONTIB, NONTIBET, NORM, NORM_AP_ERROR, NORM_AP_MESS, NORM_AP_TITLE, NORM_EDIT, NORM_ENG_LABEL, NORM_TIB_LABEL, NORM_TITLE, NORM_TITLE_HEAD, NOT_SAVED_MESSAGE, NOT_SAVED_TITLE, NOT_SPEC, NOT_SPEC_MESSAGE, NOT_SPEC_SPECS, NOT_SPEC_TITLE, NOTE, NOTFOUND, NUM, NUMB, OPEN_ERROR, OPEN_TITLE, OPENFILE, ORIG_LANG, OTHER, OTHER_EDS, OUT_DIRECTORY, P, PAGE_RANGE, PAGIN, PERSNAME, PHYSDEC, PREFS, PREFS_DELIM, PROG_NAME, QUOTE, RDG, RECENT, RECENT_FILE_SIZE, REDISPLAY, RELAT, REMOVE_APP, REMOVE_APP_MESS, REMOVE_APP_SPECS, REMOVE_APP_TITLE, REMOVE_ED_ERROR_MESS, REMOVE_ED_ERROR_TITLE, REMOVE_ED_TITLE_ERROR, REMOVE_ED_TITLE_MESS, REMOVE_ED_TITLE_SPECS, REMOVE_ED_TITLE_TITLE, REMOVE_EDITION, REMOVE_TITLE, RENAME_FILE, RENAME_FILE_TITLE, RENAMING_FILE_SPECS, REND, RESP, RESPDECL, RESPSTM, REVDESC, RS, RUNTIME_ERROR, SAVE, SAVE_SPECS, SAVEAS, SAVED_FILE, SAVED_FILE_SPECS, SAVED_FILE_TITLE, SECTIONS, SELDIV, SEPARATOR, SHORT_LABEL_SIZE, SHOW_AP, SID, SIG, SIGLA_DELIM, SPACE, SRC, SRCS_LABEL, SUBMIT, SUBTYPE, SUMMARY, SYS, SYS_LET, SYS_NUM, SYS_SIG, TABLE, TB, TDECL, TDIV, TEMP_DIR, TEXT, TEXT_COLOR, TEXT_FIELD_SIZE, TEXT_HEAD, TEXT_HEAD_SIZE, TEXT_LIST_HEAD, TEXT_NUM, TIB, TIBANAL, TIBBIBL, TIBL, TIBPANEL_SIZE, TID, TIDDECL, TINFO, TITEM, TITLE, TITLE_DISC, TITLE_FONT, TITLE_LINE_HEAD, TITLE_PAGE, TITLEGRP, TITLELINE, TITLELN, TITLEOPENFILE, TITLES_VIEW, TK, TLIST, TLIST_ADD_ERROR, TLIST_ADD_MESS, TLIST_ADD_TITLE, TLIST_WARN, TLIST_WARN_TITLE, TLIST_WARNING, TRANS, TRANS_EDIT, TRANS_JOB, TTFCOLS, TTITLE_TITLE, TXT, TXTHEAD, TYPE, TYPE_CLASS, TYPE_DOX, TYPE_ED, TYPE_TEXT, TYPE_VOL, UNCLASSED, UNTITLED, USER_ID_VIEW, VIEW, VOL, VOL_LET, VOL_NUM, VOL_TEXT, VOL_TEXT_NUM, WIT, YES
 
Constructor Summary
XMLDoc(Element rootElement)
           
 
Method Summary
 Element findElement(String elName)
           
 Element findElement(String elName, String att, String val)
           
 Element[] findElements(String elName)
           
 Element[] findElements(String att, String val)
           
 Element findID(String fid)
           
static Element getAncestor(String elName, Element child)
           
 String getEditorID()
           This returns the id string for the editor currently set for this document.
 String getEditorName()
           
 String getID()
           
 Element getRoot()
           
 Element getSysid()
           
 Element[] getTagList()
           
 void processDoc(Element element)
           
 void refreshTagList()
           
 void setEditorInfo(String id, String name)
           
 void setID(String id)
           
 void setRoot()
           
 void setSysid(String sysidString)
           
 
Methods inherited from class org.jdom.Document
addContent, addContent, clone, detachRootElement, equals, getContent, getContent, getDocType, getRootElement, hashCode, hasRootElement, removeContent, removeContent, setContent, setDocType, setRootElement, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

XMLDoc

public XMLDoc(Element rootElement)
Method Detail

setRoot

public void setRoot()

getRoot

public Element getRoot()

setID

public void setID(String id)

getID

public String getID()

setSysid

public void setSysid(String sysidString)

getSysid

public Element getSysid()

getTagList

public Element[] getTagList()

setEditorInfo

public void setEditorInfo(String id,
                          String name)

getEditorID

public String getEditorID()

This returns the id string for the editor currently set for this document. This ID string is the same as the editor's initials referred to elsewhere, e.g ndg, gah...

Returns:
String - the editor's id string generally 3 letters long

getEditorName

public String getEditorName()

processDoc

public void processDoc(Element element)

findID

public Element findID(String fid)

getAncestor

public static Element getAncestor(String elName,
                                  Element child)

findElement

public Element findElement(String elName)

findElement

public Element findElement(String elName,
                           String att,
                           String val)

findElements

public Element[] findElements(String elName)

findElements

public Element[] findElements(String att,
                              String val)

refreshTagList

public void refreshTagList()


These API docs were created 02/02/2003 08:19 PM.
Copyright © 2001-2002 Tibetan and Himalayan Digital Library. All Rights Reserved.
Hosted by SourceForge_Logo