VdexReload 1.1.3 API

uk.ac.reload.moonunit.schema
Class ReloadSchemaHelper

java.lang.Object
  extended byuk.ac.reload.moonunit.schema.ReloadSchemaHelper

public class ReloadSchemaHelper
extends java.lang.Object

The Reload Schema Helper - this provides a bunch of helper methods to the ReloadSchema class, like friendly names etc. It's a middleman class. It reads in the Helper XML File.


Field Summary
protected  org.jdom.Document _docHelper
          The JDOM Document of the XML Helper File
protected  java.io.File _fileHelper
          The File of the XML Helper File
static java.lang.String ELEMENT
           
static java.lang.String FNAME
           
static java.lang.String MAXLENGTH
           
static java.lang.String PATH
           
static java.lang.String SCHEMA
           
static java.lang.String TIP
           
static java.lang.String WIDGET
           
 
Method Summary
 java.lang.String getHelperValue(DomPath domPath, java.lang.String helperKey)
          Get a helper value for an element
static ReloadSchemaHelper getReloadSchemaHelper(java.io.File fileHelper)
          Factory method for getting a static re-usable ReloadSchemaHelper
protected  org.jdom.Document getSchemaHelperDocument()
          Get the JDOM Helper Document.
 java.lang.String getSchemaName()
          Get the name of the IMS XML Schema we are helping.
protected  org.jdom.Document loadSchemaHelperFile(java.io.File helperFile)
          Load the XML Schema File into a JDOM Document
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ELEMENT

public static final java.lang.String ELEMENT
See Also:
Constant Field Values

SCHEMA

public static final java.lang.String SCHEMA
See Also:
Constant Field Values

PATH

public static final java.lang.String PATH
See Also:
Constant Field Values

FNAME

public static final java.lang.String FNAME
See Also:
Constant Field Values

TIP

public static final java.lang.String TIP
See Also:
Constant Field Values

WIDGET

public static final java.lang.String WIDGET
See Also:
Constant Field Values

MAXLENGTH

public static final java.lang.String MAXLENGTH
See Also:
Constant Field Values

_docHelper

protected org.jdom.Document _docHelper
The JDOM Document of the XML Helper File


_fileHelper

protected java.io.File _fileHelper
The File of the XML Helper File

Method Detail

getReloadSchemaHelper

public static ReloadSchemaHelper getReloadSchemaHelper(java.io.File fileHelper)
                                                throws ReloadSchemaException
Factory method for getting a static re-usable ReloadSchemaHelper

Parameters:
fileHelper - The file of the Helper file to get
Returns:
The ReloadSchemaHelper or null if not found
Throws:
ReloadSchemaException

loadSchemaHelperFile

protected org.jdom.Document loadSchemaHelperFile(java.io.File helperFile)
                                          throws DweezilXMLException
Load the XML Schema File into a JDOM Document

Parameters:
helperFile - The XML Helper File to read in
Returns:
The JDOM Document
Throws:
DweezilXMLException

getSchemaHelperDocument

protected org.jdom.Document getSchemaHelperDocument()
Get the JDOM Helper Document.

Returns:
The JDOM Helper Document

getSchemaName

public java.lang.String getSchemaName()
Get the name of the IMS XML Schema we are helping.

Returns:
The name of the IMS XML Schema

getHelperValue

public java.lang.String getHelperValue(DomPath domPath,
                                       java.lang.String helperKey)
Get a helper value for an element

Parameters:
domPath - the path of the element concerned
helperKey - the helper key to be used for getting the helper value
Returns:
a helper value for an Element

VdexReload 1.1.3 API