VdexReload 1.1.3 API

uk.ac.reload.editor.vocabulary
Class VocabularyHelperProfile

java.lang.Object
  extended byuk.ac.reload.editor.ReloadHelperProfile
      extended byuk.ac.reload.editor.vocabulary.VocabularyHelperProfile

public class VocabularyHelperProfile
extends ReloadHelperProfile

The Vocabulary Profile This reads in a VX User Profile XML File


Field Summary
protected  VocabularyProfileElement _rootElement
          The Root VocabularyProfileElement
 
Fields inherited from class uk.ac.reload.editor.ReloadHelperProfile
_docProfile, _fileProfile
 
Method Summary
static VocabularyHelperProfile getDefaultVocabularyHelperProfile()
          Get the default VocabularyHelperProfile
 VocabularyProfileElement getRootElement()
          Get the VocabularyProfileField root field
 java.lang.String getSchemaFileName()
          Get the file name of the associated Schema file.
 java.io.File getSchemaHelperFile()
          Get the Schema Helper File
 java.io.File getVocabFile()
          Get the Vocabulary Helper File
static VocabularyHelperProfile[] getVocabularyHelperProfiles()
          Get all available VocabularyHelperProfiles
static VocabularyHelperProfile getVocabularyProfile(java.io.File fileProfile)
          Factory method for getting a static re-usable VocabularyHelperProfile
 
Methods inherited from class uk.ac.reload.editor.ReloadHelperProfile
getFile, getProfileName, getRootAttributeValue, getSchemaHelperFileName, getVocabularyFileName, loadProfile, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_rootElement

protected VocabularyProfileElement _rootElement
The Root VocabularyProfileElement

Method Detail

getVocabularyProfile

public static VocabularyHelperProfile getVocabularyProfile(java.io.File fileProfile)
                                                    throws ReloadEditorException
Factory method for getting a static re-usable VocabularyHelperProfile

Parameters:
fileProfile - the file of the VocabularyHelperProfile file
Throws:
ReloadEditorException

getVocabularyHelperProfiles

public static VocabularyHelperProfile[] getVocabularyHelperProfiles()
Get all available VocabularyHelperProfiles

Returns:
all available VocabularyHelperProfiles

getVocabFile

public java.io.File getVocabFile()
Get the Vocabulary Helper File

Specified by:
getVocabFile in class ReloadHelperProfile
Returns:
the Vocabulary Helper File

getSchemaHelperFile

public java.io.File getSchemaHelperFile()
Get the Schema Helper File

Specified by:
getSchemaHelperFile in class ReloadHelperProfile
Returns:
the Schema Helper File

getDefaultVocabularyHelperProfile

public static VocabularyHelperProfile getDefaultVocabularyHelperProfile()
                                                                 throws ReloadEditorException
Get the default VocabularyHelperProfile

Returns:
the default VocabularyHelperProfile
Throws:
ReloadEditorException

getSchemaFileName

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

Returns:
The name of the Schema file

getRootElement

public VocabularyProfileElement getRootElement()
Get the VocabularyProfileField root field

Returns:
the root VocabularyProfileElement

VdexReload 1.1.3 API