VdexReload 1.1.3 API

uk.ac.reload.editor.vocabulary
Class VocabularySchemaController

java.lang.Object
  extended byuk.ac.reload.moonunit.schema.ReloadSchemaController
      extended byuk.ac.reload.editor.ReloadEditorSchemaController
          extended byuk.ac.reload.editor.vocabulary.VocabularySchemaController

public class VocabularySchemaController
extends ReloadEditorSchemaController

The Vocabulary Schema Controller - this interfaces from the various helpers


Field Summary
 
Fields inherited from class uk.ac.reload.editor.ReloadEditorSchemaController
_helperProfile
 
Fields inherited from class uk.ac.reload.moonunit.schema.ReloadSchemaController
_reloadSchema, _schemaFile, _schemaHelper, _version, _vocab
 
Constructor Summary
VocabularySchemaController(java.io.File fileSchema, java.lang.String version)
          Constructor with Default Profile
VocabularySchemaController(VocabularyHelperProfile vxProfile)
          Constructor
 
Method Summary
 javax.swing.Icon getClosedIcon(org.jdom.Element element)
          Get The Closed Icon (for the Full View Tree)
 javax.swing.Icon getClosedIcon(ReloadSchemaElement schemaElement)
          Get The Closed Icon (for the Full View Tree)
static VocabularySchemaController getDefaultSchemaController()
          Get the default VocabularySchemaController
 javax.swing.Icon getLeafIcon(org.jdom.Element element)
          Get The Leaf Icon (for the Full View Tree)
 javax.swing.Icon getLeafIcon(ReloadSchemaElement schemaElement)
          Get The Leaf Icon (for the Full View Tree)
 javax.swing.Icon getOpenIcon(org.jdom.Element element)
          Get The Open Icon (for the Full View Tree)
 javax.swing.Icon getOpenIcon(ReloadSchemaElement schemaElement)
          Get The Open Icon (for the Full View Tree)
 java.lang.String getRootElementName()
          Return the Vocabulary Root Element name
 ReloadSchemaElement[] getTopLevelElements()
          Get the top level VDEX Element Categories (4 in this case)
 boolean isTopLevelElement(ReloadSchemaElement schemaElement)
          Find out if the given Element is a top level one below "vdex"
 void setVocabularyProfile(VocabularyHelperProfile vxProfile)
          Set the Vocabulary Profile
 VocabularySchemaController setVocabularySchema(VocabularyHelperProfile vxProfile)
          Set the Vocabulary Schema and return the approrpiate VocabularySchemaController
 
Methods inherited from class uk.ac.reload.editor.ReloadEditorSchemaController
getReloadHelperProfile, getReloadSchemaController, getReloadSchemaController, loadSchema, loadSchemaHelper, loadVocab, setHelperProfile, showWarningMessage
 
Methods inherited from class uk.ac.reload.moonunit.schema.ReloadSchemaController
getDefaultValue, getElementFriendlyName, getElementHelperValue, getElementTip, getFacetValue, getReloadSchema, getReloadSchemaNode, getSchemaFile, getSchemaHelper, getVersion, getVocabularyList, getVocabularyList, getVocabularyList, getWidgetType, setDefaultVocabLanguage, setVersion
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VocabularySchemaController

public VocabularySchemaController(java.io.File fileSchema,
                                  java.lang.String version)
Constructor with Default Profile

Parameters:
fileSchema - the schema file version the schema version

VocabularySchemaController

public VocabularySchemaController(VocabularyHelperProfile vxProfile)
Constructor

Parameters:
vxProfile - the vocabulary helper profile
Method Detail

getDefaultSchemaController

public static VocabularySchemaController getDefaultSchemaController()
Get the default VocabularySchemaController

Returns:
the default VocabularySchemaController

setVocabularySchema

public VocabularySchemaController setVocabularySchema(VocabularyHelperProfile vxProfile)
Set the Vocabulary Schema and return the approrpiate VocabularySchemaController

Parameters:
vxProfile - the Vocabulary helper profile that is used for getting the appropriate vocabulary schema
Returns:
the VocabualarySchemaController

setVocabularyProfile

public void setVocabularyProfile(VocabularyHelperProfile vxProfile)
Set the Vocabulary Profile

Parameters:
vxProfile - the vocabulary helper profile

getRootElementName

public java.lang.String getRootElementName()
Return the Vocabulary Root Element name

Specified by:
getRootElementName in class ReloadSchemaController
Returns:
the root element name

getTopLevelElements

public ReloadSchemaElement[] getTopLevelElements()
Get the top level VDEX Element Categories (4 in this case)

Returns:
An Enumeration of ReloadSchemaElement objects

isTopLevelElement

public boolean isTopLevelElement(ReloadSchemaElement schemaElement)
Find out if the given Element is a top level one below "vdex"

Parameters:
schemaElement - The Schema Element to query
Returns:
true if the parent of schemaElement is the root Element

getLeafIcon

public javax.swing.Icon getLeafIcon(org.jdom.Element element)
Get The Leaf Icon (for the Full View Tree)

Specified by:
getLeafIcon in class ReloadEditorSchemaController
Parameters:
element - the leaf element
Returns:
the leaf icon

getLeafIcon

public javax.swing.Icon getLeafIcon(ReloadSchemaElement schemaElement)
Get The Leaf Icon (for the Full View Tree)

Specified by:
getLeafIcon in class ReloadEditorSchemaController
Parameters:
schemaElement - the leaf schema element
Returns:
the leaf icon

getOpenIcon

public javax.swing.Icon getOpenIcon(org.jdom.Element element)
Get The Open Icon (for the Full View Tree)

Specified by:
getOpenIcon in class ReloadEditorSchemaController
Parameters:
element - the open element
Returns:
the open icon

getOpenIcon

public javax.swing.Icon getOpenIcon(ReloadSchemaElement schemaElement)
Get The Open Icon (for the Full View Tree)

Specified by:
getOpenIcon in class ReloadEditorSchemaController
Parameters:
schemaElement - the open schema element
Returns:
the open icon

getClosedIcon

public javax.swing.Icon getClosedIcon(org.jdom.Element element)
Get The Closed Icon (for the Full View Tree)

Specified by:
getClosedIcon in class ReloadEditorSchemaController
Parameters:
element - the closed element
Returns:
the close icon

getClosedIcon

public javax.swing.Icon getClosedIcon(ReloadSchemaElement schemaElement)
Get The Closed Icon (for the Full View Tree)

Specified by:
getClosedIcon in class ReloadEditorSchemaController
Parameters:
schemaElement - the closed schemaElement
Returns:
the close icon

VdexReload 1.1.3 API