VdexReload 1.1.3 API

uk.ac.reload.editor
Class ReloadHelperProfile

java.lang.Object
  extended byuk.ac.reload.editor.ReloadHelperProfile
Direct Known Subclasses:
ContentPackageHelperProfile, MetadataHelperProfile, VocabularyHelperProfile

public abstract class ReloadHelperProfile
extends java.lang.Object

The Profile for a given editing View - this contains the schemahelper and the vocab file to use for a given type of IMS document


Field Summary
protected  org.jdom.Document _docProfile
          The JDOM Document of the XML Helper File
protected  java.io.File _fileProfile
          The File of the Profile File
 
Constructor Summary
ReloadHelperProfile()
          Default Constructor
ReloadHelperProfile(java.io.File fileProfile)
          Constructor
 
Method Summary
 java.io.File getFile()
          Get the profile XMl file
 java.lang.String getProfileName()
          Get name of the Profile.
protected  java.lang.String getRootAttributeValue(java.lang.String attName)
          Get the value of a root attribute
abstract  java.io.File getSchemaHelperFile()
          Get the Schema helper file
 java.lang.String getSchemaHelperFileName()
          Get the file name of the associated Schema Helper file.
abstract  java.io.File getVocabFile()
          Get hte Vocabulary Helper file
 java.lang.String getVocabularyFileName()
          Get the file name of the associated Vocabulary file.
protected  org.jdom.Document loadProfile(java.io.File fileProfile)
          Load the XML Profile File into a JDOM Document
 java.lang.String toString()
          String representation of the Metadata Profile file
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_docProfile

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


_fileProfile

protected java.io.File _fileProfile
The File of the Profile File

Constructor Detail

ReloadHelperProfile

public ReloadHelperProfile()
Default Constructor


ReloadHelperProfile

public ReloadHelperProfile(java.io.File fileProfile)
                    throws ReloadEditorException
Constructor

Parameters:
fileProfile - the file of the helper profile
Throws:
ReloadEditorException
Method Detail

loadProfile

protected org.jdom.Document loadProfile(java.io.File fileProfile)
                                 throws DweezilXMLException
Load the XML Profile File into a JDOM Document

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

getVocabFile

public abstract java.io.File getVocabFile()
Get hte Vocabulary Helper file

Returns:
the Vocabulary helper File

getSchemaHelperFile

public abstract java.io.File getSchemaHelperFile()
Get the Schema helper file

Returns:
the Schema Helper File

getProfileName

public java.lang.String getProfileName()
Get name of the Profile. This is stored in the XML Profile file against the attribute "name"

Returns:
The name of the Profile

getFile

public java.io.File getFile()
Get the profile XMl file

Returns:
the actual File

getVocabularyFileName

public java.lang.String getVocabularyFileName()
Get the file name of the associated Vocabulary file. This is stored in the XML Profile file against the attribute "vocabfile"

Returns:
The name of the Vocabulary file

getSchemaHelperFileName

public java.lang.String getSchemaHelperFileName()
Get the file name of the associated Schema Helper file. This is stored in the XML Profile file against the attribute "schemahelperfile"

Returns:
The name of the Vocabulary file

getRootAttributeValue

protected java.lang.String getRootAttributeValue(java.lang.String attName)
Get the value of a root attribute

Returns:
the value of a root attribute or null

toString

public java.lang.String toString()
String representation of the Metadata Profile file

Returns:
the profile name

VdexReload 1.1.3 API