com.isti.util
Class IstiXmlLoader

java.lang.Object
  extended by com.isti.util.ErrorMessageMgr
      extended by com.isti.util.IstiXmlUtils
          extended by com.isti.util.IstiXmlLoader
All Implemented Interfaces:
ErrorMsgMgrIntf
Direct Known Subclasses:
IstiMenuLoader

public abstract class IstiXmlLoader
extends IstiXmlUtils

Class IstiMenuLoader implements a XML file loader.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.isti.util.IstiXmlUtils
IstiXmlUtils.RootElement
 
Field Summary
 
Fields inherited from class com.isti.util.IstiXmlUtils
ISO_8859_1_ENCODING_FORMAT, loadFileOpenedFlag, rootElement, useDocumentFlag, UTF_8_ENCODING_FORMAT, XML_FILE_EXTENSION, XML_STYLESHEET, XML_STYLESHEET_PROCESSING_INSTRUCTION, xmlBuilderObj, xmlFileOutputterObj, xmlFixedStrOutputterObj, xmlStrOutputterObj
 
Constructor Summary
IstiXmlLoader()
          Constructs a XML file loader.
 
Method Summary
protected  java.lang.Object processChildElement(org.jdom.Element parentElement, int childIndex, java.lang.Object parentObject)
          Gets the next child for the specified element.
protected  java.lang.Object processChildElement(org.jdom.Element parentElement, java.lang.String attribute, java.lang.String value, java.lang.Object parentObject)
          Gets the next child with the specifed attribute value for the specified element.
protected  void processChildren(org.jdom.Element parentElement, java.lang.Object parentObject)
          Processes the children for the specified element.
protected abstract  java.lang.Object processElement(org.jdom.Element element, java.lang.Object parentObject, org.jdom.Element parentElement)
          Processes the element for this document.
 
Methods inherited from class com.isti.util.IstiXmlUtils
addXmlFileExtension, clearErrorMessage, convertFromEscapedCodes, createCdata, createRootElement, ctrlCharsFromEscapedCodes, ctrlCharsToEscapedCodes, ctrlCharsToEscapedCodes, elementToFixedString, elementToString, elementToString, findElement, findElement, getAnyNSChild, getChildDataFixedStr, getChildDataStr, getChildDataStr, getChildDataStr, getComponentForClass, getEncodedString, getErrorFlag, getErrorMessage, getLoadFileOpenedFlag, getRootElement, loadFile, loadFile, loadStream, loadStream, loadStream, loadStream, saveToFile, saveToFile, saveToStream, saveToStream, setDocumentStylesheet, setElementNamespace, setElementNamespace, setErrorMessage, setFileLineSeparator, setFileOmitDeclaration, setFileOmitEncoding, setFileOutExpandEmptyElements, setFileOutIndent, setFileOutNewlines, setFileOutTextTrim, setLoadExternalDTDFeature, setRootElement, setStrOutExpandEmptyElements, setStrOutIndent, setStrOutNewlines, setStrOutTextTrim, stringToElement
 
Methods inherited from class com.isti.util.ErrorMessageMgr
clearErrorMessageString, clearFetchedErrorMessage, enterErrorMessageString, getErrorMessageFlag, getErrorMessageString, getUnfetchedMessageFlag, setErrorMessageString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IstiXmlLoader

public IstiXmlLoader()
Constructs a XML file loader.

Method Detail

processChildElement

protected java.lang.Object processChildElement(org.jdom.Element parentElement,
                                               int childIndex,
                                               java.lang.Object parentObject)
Gets the next child for the specified element.

Parameters:
parentElement - the parent element to process.
childIndex - index of child element to return.
parentObject - the parent object for the element.
Returns:
an object for the child element or null if no more children.

processChildElement

protected java.lang.Object processChildElement(org.jdom.Element parentElement,
                                               java.lang.String attribute,
                                               java.lang.String value,
                                               java.lang.Object parentObject)
Gets the next child with the specifed attribute value for the specified element.

Parameters:
parentElement - the parent element to process.
attribute - the attribute of the element to find.
value - the attribute value of the element to find.
parentObject - the parent object for the element.
Returns:
an object for the child element or null if no more children.

processChildren

protected void processChildren(org.jdom.Element parentElement,
                               java.lang.Object parentObject)
Processes the children for the specified element.

Parameters:
parentElement - the parent element to process
parentObject - the parent object for the element

processElement

protected abstract java.lang.Object processElement(org.jdom.Element element,
                                                   java.lang.Object parentObject,
                                                   org.jdom.Element parentElement)
Processes the element for this document. NOTE: Implement this function to process elements.

Parameters:
element - the element to process
parentObject - the parent object for the element
parentElement - the parent element for the element.
Returns:
an object for the element or null if no object is needed.