|
VdexReload 1.1.3 API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.reload.moonunit.schema.ReloadSchemaController
The Schema Controller - this controls access to helper and vocabulary files as well as various default values.
Field Summary | |
protected ReloadSchema |
_reloadSchema
The Schema that will be our template |
protected java.io.File |
_schemaFile
The Schema File |
protected ReloadSchemaHelper |
_schemaHelper
The Schema Helper that we will query |
protected java.lang.String |
_version
The version String |
protected ReloadVocabulary |
_vocab
The Reload Schema Vocabulary |
Constructor Summary | |
ReloadSchemaController()
Default Constructor |
|
ReloadSchemaController(java.io.File fileSchema,
java.io.File fileHelper,
java.io.File fileVocab)
Constructor |
Method Summary | |
java.lang.String |
getDefaultValue(ReloadSchemaNode schemaNode)
Get the default value of a ReloadSchemaNode |
java.lang.String |
getElementFriendlyName(DomPath domPath)
Get a friendly name for a schema element |
java.lang.String |
getElementHelperValue(DomPath domPath,
java.lang.String helperKey)
Get a Helper value for a given key |
java.lang.String |
getElementTip(DomPath domPath)
Get an element tip |
java.lang.String |
getFacetValue(ReloadSchemaNode schemaNode,
java.lang.String facetName)
Get a Facet value of an Element or attribute. |
ReloadSchema |
getReloadSchema()
Return the ReloadSchema connected with this Controller |
ReloadSchemaNode |
getReloadSchemaNode(DomPath domPath)
For each JDOM Path there is a corresponding ReloadSchemaNode. |
abstract java.lang.String |
getRootElementName()
Get the root element name |
java.io.File |
getSchemaFile()
Get the Schema File for this Schema |
ReloadSchemaHelper |
getSchemaHelper()
Get the Schema Helper |
java.lang.String |
getVersion()
Get the schema version |
ReloadVocabularyList |
getVocabularyList(DomPath domPath)
Get the Vocabulary list for a given element or attribute. |
ReloadVocabularyList |
getVocabularyList(ReloadSchemaNode schemaNode)
Get the Vocabulary list for a given element or attribute. |
ReloadVocabularyList |
getVocabularyList(ReloadSchemaNode schemaNode,
ReloadDocument doc)
Get the Vocabulary list for a given element or attribute. |
java.lang.String |
getWidgetType(DomPath domPath)
Get the widget type of the element from the helper file or null if not set |
void |
loadSchema(java.io.File schemaFile)
Load the Schema File |
void |
loadSchemaHelper(java.io.File fileHelper)
Load the Schema Helper File |
void |
loadVocab(java.io.File fileVocab)
Load the Vocabulary Helper File |
void |
setDefaultVocabLanguage(java.lang.String lang)
Set the Default Language for the Language vocabulary |
void |
setVersion(java.lang.String version)
Set the Version String of the Schema. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected java.lang.String _version
protected ReloadSchema _reloadSchema
protected java.io.File _schemaFile
protected ReloadSchemaHelper _schemaHelper
protected ReloadVocabulary _vocab
Constructor Detail |
public ReloadSchemaController()
public ReloadSchemaController(java.io.File fileSchema, java.io.File fileHelper, java.io.File fileVocab) throws ReloadSchemaException
fileSchema
- the schema filefileHelper
- the schema helper file that we will queryfileVocab
- the reload vocabulary file
ReloadSchemaException
Method Detail |
public void loadSchema(java.io.File schemaFile) throws ReloadSchemaException
schemaFile
- the schema file
ReloadSchemaException
public void loadSchemaHelper(java.io.File fileHelper) throws ReloadSchemaException
fileHelper
- the schema helper file
ReloadSchemaException
public void loadVocab(java.io.File fileVocab) throws ReloadSchemaException
fileVocab
- the vocabulary helper file
ReloadSchemaException
public void setDefaultVocabLanguage(java.lang.String lang)
public java.lang.String getVersion()
public void setVersion(java.lang.String version)
version
- the schema versionpublic ReloadSchemaNode getReloadSchemaNode(DomPath domPath)
domPath
- the Path to find the ReloadSchemaElement or ReloadSchemaAttribute
public java.lang.String getElementHelperValue(DomPath domPath, java.lang.String helperKey)
domPath
- the path to find the ReloadSchemaNodehelperKey
- the helper key to get a value from the schema helper file
public java.lang.String getElementFriendlyName(DomPath domPath)
domPath
- the path to find the ReloadSchemaNode
public java.lang.String getElementTip(DomPath domPath)
domPath
- the path to find the ReloadSchemaNode
public java.lang.String getWidgetType(DomPath domPath)
domPath
- the path to find the ReloadSchemaElement
public abstract java.lang.String getRootElementName()
public ReloadVocabularyList getVocabularyList(ReloadSchemaNode schemaNode)
schemaNode
- The Element or Attribute for which to get the vocab list
public ReloadVocabularyList getVocabularyList(DomPath domPath)
domPath
- the path of the Element or Attribute for which to get the vocab list
public ReloadVocabularyList getVocabularyList(ReloadSchemaNode schemaNode, ReloadDocument doc)
schemaNode
- The Element or Attribute for which to get the vocab listdoc
- the ReloadDocument instance
public java.lang.String getDefaultValue(ReloadSchemaNode schemaNode)
schemaNode
- the ReloadSchemaNode concerned
public java.lang.String getFacetValue(ReloadSchemaNode schemaNode, java.lang.String facetName)
schemaNode
- the ReloadSchema Element or Attribute concernedfacetName
- the name of the facet for which we need a value
public ReloadSchema getReloadSchema()
public java.io.File getSchemaFile()
public ReloadSchemaHelper getSchemaHelper()
|
VdexReload 1.1.3 API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |