Class SchemEditForm
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
DCSViewForm
DocMap attribute, which wraps the XML Document
that is being edited.- Author:
- ostwald
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic StringNOT YET DOCUMENTEDstatic StringNOT YET DOCUMENTEDstatic StringDescription of the FieldFields inherited from class org.apache.struts.action.ActionForm
multipartRequestHandler, servlet -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()NOT YET DOCUMENTEDvoidClear cache of eneration values that are used to optimize property lookup during display of form.voidClear the cache of repeating values that stores the repeating elements which may have empty values after form is submitted.voidexposeNode(String xpath) Make a node visible in the editor.getAcceptsNewChoice(String encodedPath) Gets the acceptsNewChoice attribute of the SchemEditForm objectgetAcceptsNewSibling(String encodedPath) Determines whether the parent of the element corresponding to encodedPath can accept a new sibling of encodedPath.getAcceptsNewSubstitionGroupMember(String encodedPath) Gets the acceptsNewSubstitionGroupMember attribute of the SchemEditForm objectGets the adnDocReader attribute of the SchemEditForm objectgetAnyTypeValueOf(String key) Gets the anyTypeValueOf attribute of the SchemEditForm objectGets the asyncJason attribute of the SchemEditForm objectGets the baseExportDir attribute of the SchemEditForm objectreturn true iff schemaHelper.isRequiredBranch returns TRUEintgetChildElementCountOf(String encodedPath) Gets the childElementCountOf attribute of the SchemEditForm objectorg.apache.struts.util.LabelValueBean[]getChoiceOptions(String encodedPath) Gets the choiceOptions for the element specified by "encodedPath", adding indexing if the element is a multiChoice.Gets the collapseBean attribute of the SchemEditForm objectGets the collection attribute of the SchemEditForm objectGets the collectionName attribute of the SchemEditForm objectorg.apache.struts.util.LabelValueBeanprovide values to use as constants in comboUnionInput processingorg.apache.struts.util.LabelValueBean[]getComboSelectOptions(String encodedPath) Gets the options for a comboSelect input element, which presents a list of options to the user but also allows input of arbitrary values.Gets the contextURL attribute of the DCSBrowseForm objectGets the currentPage attribute of the SchemEditForm objectGets the currentPageEncoded attribute of the SchemEditForm objectGets the currentStdDocKey attribute of the SchemEditForm objectGets the dcsDataRecord attribute of the SchemEditForm objectgetDirs()Gets the dirs attribute of the SchemEditForm objectGets the discussionURL attribute of the SchemEditForm objectGets the docMap attribute of the SchemEditForm objectGets the duplicateUrlRecs attribute of the SchemEditForm objectgetDups()Gets the dups attribute of the SchemEditForm objectorg.apache.struts.util.LabelValueBean[]getEnumerationOptions(String encodedPath) Gets the possible values and labels (defined by the an EnumerationType representing a controlled vocab) that an element may assume.getEnumerationPaths(String encodedPath) Gets the enumerationPaths of a Document given an xpath to a member.String[]getEnumerationValuesOf(String encodedPath) Gets the curently assigned values for the given xpath in the current Document.getFieldInfo(String encodedPath) Returns aFieldInfoReaderfor the specified path.Gets the fieldInfoMap attribute of the SchemEditForm objectGets the fieldInfoReader attribute of the SchemEditForm objectbooleanGets the forceValidation attribute of the SchemEditForm objectGets the framework attribute of the SchemEditForm objectGets the frameworkName attribute of the SchemEditForm objectGets the pathArg attribute of the SchemEditForm objectbooleangetHasChildren(String encodedPath) Gets the hasChildren attribute of the SchemEditForm objectgetHash()Gets the hash attribute of the SchemEditForm objectGets the inputManager attribute of the SchemEditForm objectgetLegalEnumerationValuesOf(String encodedPath) Gets the legal values an enumeration (controlled vocab defined in schema) can assume.intgetMemberCountOf(String encodedPath) Returns number of elements in the Document matching a given xpathgetMembersOf(String encodedPath) Gets the membersOf attribute of the SchemEditForm objectGets the metadata attribute of the SchemEditForm objectbooleangetMuiFormattable(String encodedPath) Returns true if a MUI groups file exists for the provided pathgetNodeExists(String key) Gets the nodeExists attribute of the SchemEditForm objectreturn true if the node exists and it is not emptyReturn true if the node specified by key exists in the instance document and it has a required attribute in the instance document.getNodeHasValue(String key) Return TRUE if this node has a value.getNodeIsEmpty(String key) Gets the nodeIsEmpty attribute of the SchemEditForm objectReturns true of the node designated by key can be expanded.Determines if a text node in the VIEW UI (as opposed to the editor) of a record is missing a value, so it can be highlighted accordingly.Gets the pageList attribute of the SchemEditForm objectGets the pageTitle attribute of the SchemEditForm objectGets the parentNodeExists attribute of the SchemEditForm objectGets the pathArg attribute of the SchemEditForm objectGets the previousPage attribute of the SchemEditForm objectgetRecId()Gets the recId attribute of the SchemEditForm objectRecord[]Gets the records attribute of the SchemEditForm objectGets the location of metadata records for a StandAlone Editor.Cache of repeating values that stores repeating elements which may have empty values after the form is submitted.getRepeatingMembersOf(String encodedPath) Gets a list of all nodes for a given xpath, PLUS a bogus node that supports addition of a new member in the JSP form.Gets the resultDoc attribute of the SchemEditForm objectGets the savedContent attribute of the SchemEditForm objectGets the schemaHelper attribute of the SchemEditForm object.org.apache.struts.util.LabelValueBean[]getSelectOptions(String encodedPath) Gets the selectOptions for the given xpath from the Schema.Gets the servletContext attribute of the SchemEditForm objectGets the setInfo attribute of the SchemEditForm objectGets the similarUrlRecs attribute of the SchemEditForm objectgetSims()Gets the sims attribute of the SchemEditForm objectintgetSubstitutionGroupMemberCountOf(String encodedPath) Gets the substitutionGroupMemberCountOf attribute of the SchemEditForm objectgetSubstitutionGroupMembersOf(String encodedPath) Select all substitutionGroup elements by building up complex selection xpath ORing together the xpaths for the substitutionGroup membersorg.apache.struts.util.LabelValueBean[]getSubstitutionGroupOptions(String encodedPath) Given the path to a schemaNode that isHeadElement(), return an array of LabelValueBean objects representing, the substitutionGroup, where both the label and the value are the group memebers qualifiedNameGets the suggestionServiceHelper attribute of the SchemEditForm objectGets the tmpArg attribute of the SchemEditForm objectGets the validatedUrl attribute of the SchemEditForm objectgetValueOf(String key) Gets the valueOf attribute of the SchemEditForm objectgetViewNode(String key) Returns TRUE if node is Required OR has a value (i.e., satisfies the "nodeExistsWithContent" predicate).getVocab()Gets the vocab attribute of the SchemEditForm objectGet VocabLayout instance for the current vocabField.Get top-level vocabLayoutNodes for the current vocabField.Gets a list of VocabNodes under the current value of "vocabField".Gets the xmlFormat attribute of the SchemEditForm objectprotected static voidOutput a line of text to standard out, with datestamp, if debug is set to true.voidsetAdnDocReader(ADNItemDocReader adnDocReader) Sets the adnDocReader attribute of the SchemEditForm objectvoidsetAsyncJason(String json) Sets the asyncJason attribute of the SchemEditForm objectvoidsetCollection(String collection) Sets the collection attribute of the SchemEditForm objectvoidsetContextURL(String contextURL) Sets the contextURL attribute of the DCSBrowseForm objectvoidSets the currentPage attribute of the SchemEditForm objectvoidSets the currentStdDocKey attribute of the SchemEditForm objectvoidsetDcsDataRecord(DcsDataRecord dataRec) Sets the dcsDataRecord attribute of the SchemEditForm objectvoidsetDiscussionURL(String url) Sets the discussionURL attribute of the SchemEditForm objectvoidsetDocMap(org.dom4j.Document document) Sets the docMap attribute of the SchemEditForm objectvoidsetDuplicateUrlRecs(ResultDocList results) Sets the duplicateUrlRecs attribute of the SchemEditForm objectvoidSets the dups attribute of the SchemEditForm objectvoidsetFieldInfoReader(FieldInfoReader fieldInfoReader) Sets the fieldInfoReader attribute of the SchemEditForm objectvoidsetForceValidation(boolean forceValidation) Sets the forceValidation attribute of the SchemEditForm objectvoidsetFramework(MetaDataFramework framework) Sets the framework attribute of the SchemEditForm objectvoidsetGuardedExitPath(String arg) Sets the guardedExitPath attribute of the SchemEditForm objectvoidSets the hash attribute of the SchemEditForm objectvoidSets the metadata attribute of the SchemEditForm objectvoidsetPageList(PageList pageList) Sets the pageList attribute of the SchemEditForm objectvoidSets the pageTitle attribute of the SchemEditForm objectvoidsetPathArg(String arg) Sets the pathArg attribute of the SchemEditForm objectvoidSets the previousPage attribute of the SchemEditForm objectvoidSets the recId attribute of the SchemEditForm objectvoidsetRecordsDir(File dir) Sets the recordsDir attribute of the SchemEditForm objectvoidsetRepeatingField(String xpath) Stores repeating values that stores repeating elements which may have empty values after the form is submitted.voidsetResultDoc(ResultDoc resultDoc) Sets the resultDoc attribute of the SchemEditForm objectvoidsetSavedContent(Map map) Sets the savedContent attribute of the SchemEditForm objectvoidsetSetInfo(DcsSetInfo info) Sets the setInfo attribute of the SchemEditForm objectvoidsetSimilarUrlRecs(ResultDocList results) Sets the similarUrlRecs attribute of the SchemEditForm objectvoidSets the sims attribute of the SchemEditForm objectvoidSets the suggestionServiceHelper attribute of the SchemEditForm objectvoidSets the tmpArg attribute of the SchemEditForm objectvoidsetValidatedUrl(String validatedUrl) Sets the validatedUrl attribute of the SchemEditForm objectvoidsetValueOf(String key, Object val) Sets the valueOf attribute of the SchemEditForm objectvoidsetVocab(MetadataVocab vocab) Constructor for the setVocab objectvoidsetVocabAudience(String vocabAudience) Sets the vocabAudience attribute of the SchemEditForm objectvoidsetVocabField(String paramName) Sets the vocabField attribute to an xpath extracted from the proviced paramName.voidsetVocabInterface(String vocabInterface) Sets the vocabInterface attribute of the SchemEditForm objectvoidsetVocabLanguage(String vocabLanguage) Sets the vocabLanguage attribute of the SchemEditForm objectvalidate(org.apache.struts.action.ActionMapping mapping, HttpServletRequest request) Validate the request parameters before the Action sees them).Methods inherited from class org.apache.struts.action.ActionForm
getMultipartRequestHandler, getServlet, getServletWrapper, reset, reset, setMultipartRequestHandler, setServlet, validate
-
Field Details
-
UNSPECIFIED
Description of the Field -
TRUE
NOT YET DOCUMENTED -
FALSE
NOT YET DOCUMENTED
-
-
Constructor Details
-
SchemEditForm
public SchemEditForm()Constructor
-
-
Method Details
-
clear
public void clear()NOT YET DOCUMENTED -
getCurrentStdDocKey
Gets the currentStdDocKey attribute of the SchemEditForm object- Returns:
- The currentStdDocKey value
-
setCurrentStdDocKey
Sets the currentStdDocKey attribute of the SchemEditForm object- Parameters:
key- The new currentStdDocKey value
-
getServletContext
Gets the servletContext attribute of the SchemEditForm object- Returns:
- The servletContext value
-
getSuggestionServiceHelper
Gets the suggestionServiceHelper attribute of the SchemEditForm object- Returns:
- The suggestionServiceHelper value
-
setSuggestionServiceHelper
Sets the suggestionServiceHelper attribute of the SchemEditForm object- Parameters:
helper- The new suggestionServiceHelper value
-
setVocab
Constructor for the setVocab object- Parameters:
vocab-
-
getVocab
Gets the vocab attribute of the SchemEditForm object- Returns:
- The vocab value
-
setVocabField
Sets the vocabField attribute to an xpath extracted from the proviced paramName.- Parameters:
paramName- The new vocabField value
-
setVocabInterface
Sets the vocabInterface attribute of the SchemEditForm object- Parameters:
vocabInterface- The new vocabInterface value
-
setVocabAudience
Sets the vocabAudience attribute of the SchemEditForm object- Parameters:
vocabAudience- The new vocabAudience value
-
setVocabLanguage
Sets the vocabLanguage attribute of the SchemEditForm object- Parameters:
vocabLanguage- The new vocabLanguage value
-
getMuiFormattable
Returns true if a MUI groups file exists for the provided path- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- The muiFormattable value
-
getVocabList
Gets a list of VocabNodes under the current value of "vocabField". This method uses the MUI.- Returns:
- The vocabList value
-
getVocabLayout
Get VocabLayout instance for the current vocabField.- Returns:
- The vocabLayout value
-
getVocabLayoutNodes
Get top-level vocabLayoutNodes for the current vocabField.- Returns:
- The vocabLayoutNodes value
-
getAsyncJason
Gets the asyncJason attribute of the SchemEditForm object- Returns:
- The asyncJason value
-
setAsyncJason
Sets the asyncJason attribute of the SchemEditForm object- Parameters:
json- The new asyncJason value
-
getInputManager
Gets the inputManager attribute of the SchemEditForm object- Returns:
- The inputManager value
-
getFramework
Gets the framework attribute of the SchemEditForm object- Returns:
- The framework value
-
setFramework
Sets the framework attribute of the SchemEditForm object- Parameters:
framework- The new framework value
-
getBaseExportDir
Gets the baseExportDir attribute of the SchemEditForm object- Returns:
- The baseExportDir value
-
getResultDoc
Gets the resultDoc attribute of the SchemEditForm object- Returns:
- The resultDoc value
-
setResultDoc
Sets the resultDoc attribute of the SchemEditForm object- Parameters:
resultDoc- The new resultDoc value
-
getContextURL
Gets the contextURL attribute of the DCSBrowseForm object- Returns:
- The contextURL value
-
setContextURL
Sets the contextURL attribute of the DCSBrowseForm object- Parameters:
contextURL- The new contextURL value
-
getSavedContent
Gets the savedContent attribute of the SchemEditForm object- Returns:
- The savedContent value
-
setSavedContent
Sets the savedContent attribute of the SchemEditForm object- Parameters:
map- The new savedContent value
-
getValidatedUrl
Gets the validatedUrl attribute of the SchemEditForm object- Returns:
- The validatedUrl value
-
setValidatedUrl
Sets the validatedUrl attribute of the SchemEditForm object- Parameters:
validatedUrl- The new validatedUrl value
-
getSimilarUrlRecs
Gets the similarUrlRecs attribute of the SchemEditForm object- Returns:
- The similarUrlRecs value
-
setSimilarUrlRecs
Sets the similarUrlRecs attribute of the SchemEditForm object- Parameters:
results- The new similarUrlRecs value
-
getDuplicateUrlRecs
Gets the duplicateUrlRecs attribute of the SchemEditForm object- Returns:
- The duplicateUrlRecs value
-
setDuplicateUrlRecs
Sets the duplicateUrlRecs attribute of the SchemEditForm object- Parameters:
results- The new duplicateUrlRecs value
-
getDups
Gets the dups attribute of the SchemEditForm object- Returns:
- The dups value
-
setDups
Sets the dups attribute of the SchemEditForm object- Parameters:
simDupList- The new dups value
-
getSims
Gets the sims attribute of the SchemEditForm object- Returns:
- The sims value
-
setSims
Sets the sims attribute of the SchemEditForm object- Parameters:
simDupList- The new sims value
-
getDcsDataRecord
Gets the dcsDataRecord attribute of the SchemEditForm object- Returns:
- The dcsDataRecord value
-
getCollapseBean
Gets the collapseBean attribute of the SchemEditForm object- Returns:
- The collapseBean value
-
getSetInfo
Gets the setInfo attribute of the SchemEditForm object- Returns:
- The setInfo value
-
setSetInfo
Sets the setInfo attribute of the SchemEditForm object- Parameters:
info- The new setInfo value
-
exposeNode
Make a node visible in the editor. First create the node if necessary and set its displayState to OPEN. Then, if the node has a compositor, expose the compositor members. Fintally, walk back up the node's path setting each ancestor's displayState to OPEN (accomplished by call to getCollapseBean().exposeElement()).- Parameters:
xpath- xpath to node to be exposed
-
setDcsDataRecord
Sets the dcsDataRecord attribute of the SchemEditForm object- Parameters:
dataRec- The new dcsDataRecord value
-
setMetadata
Sets the metadata attribute of the SchemEditForm object- Parameters:
s- The new metadata value
-
getMetadata
Gets the metadata attribute of the SchemEditForm object- Returns:
- The metadata value
-
getCollection
Gets the collection attribute of the SchemEditForm object- Returns:
- The collection value
-
setCollection
Sets the collection attribute of the SchemEditForm object- Parameters:
collection- The new collection value
-
getCollectionName
Gets the collectionName attribute of the SchemEditForm object- Returns:
- The collectionName value
-
getDiscussionURL
Gets the discussionURL attribute of the SchemEditForm object- Returns:
- The discussionURL value
-
setDiscussionURL
Sets the discussionURL attribute of the SchemEditForm object- Parameters:
url- The new discussionURL value
-
getFrameworkName
Gets the frameworkName attribute of the SchemEditForm object- Returns:
- The frameworkName value
-
getRecordsDir
Gets the location of metadata records for a StandAlone Editor.- Returns:
- The recordsDir value
-
setRecordsDir
Sets the recordsDir attribute of the SchemEditForm object- Parameters:
dir- The new recordsDir value
-
getRecords
Gets the records attribute of the SchemEditForm object- Returns:
- The records value
-
getDirs
Gets the dirs attribute of the SchemEditForm object- Returns:
- The dirs value
-
getHash
Gets the hash attribute of the SchemEditForm object- Returns:
- The hash value
-
setHash
Sets the hash attribute of the SchemEditForm object- Parameters:
s- The new hash value
-
getPageTitle
Gets the pageTitle attribute of the SchemEditForm object- Returns:
- The pageTitle value
-
setPageTitle
Sets the pageTitle attribute of the SchemEditForm object- Parameters:
s- The new pageTitle value
-
getXmlFormat
Gets the xmlFormat attribute of the SchemEditForm object- Returns:
- The xmlFormat value
-
getPageList
Gets the pageList attribute of the SchemEditForm object- Returns:
- The pageList value
-
setPageList
Sets the pageList attribute of the SchemEditForm object- Parameters:
pageList- The new pageList value
-
getForceValidation
public boolean getForceValidation()Gets the forceValidation attribute of the SchemEditForm object- Returns:
- The forceValidation value
-
setForceValidation
public void setForceValidation(boolean forceValidation) Sets the forceValidation attribute of the SchemEditForm object- Parameters:
forceValidation- The new forceValidation value
-
getTmpArg
Gets the tmpArg attribute of the SchemEditForm object- Returns:
- The tmpArg value
-
setTmpArg
Sets the tmpArg attribute of the SchemEditForm object- Parameters:
s- The new tmpArg value
-
getRecId
Gets the recId attribute of the SchemEditForm object- Returns:
- The recId value
-
setRecId
Sets the recId attribute of the SchemEditForm object- Parameters:
id- The new recId value
-
setPathArg
Sets the pathArg attribute of the SchemEditForm object- Parameters:
arg- The new pathArg value
-
getGuardedExitPath
Gets the pathArg attribute of the SchemEditForm object- Returns:
- The pathArg value
-
setGuardedExitPath
Sets the guardedExitPath attribute of the SchemEditForm object- Parameters:
arg- The new guardedExitPath value
-
getPathArg
Gets the pathArg attribute of the SchemEditForm object- Returns:
- The pathArg value
-
getCurrentPage
Gets the currentPage attribute of the SchemEditForm object- Returns:
- The currentPage value
-
setCurrentPage
Sets the currentPage attribute of the SchemEditForm object- Parameters:
s- The new currentPage value
-
getCurrentPageEncoded
Gets the currentPageEncoded attribute of the SchemEditForm object- Returns:
- The currentPageEncoded value
-
getPreviousPage
Gets the previousPage attribute of the SchemEditForm object- Returns:
- The previousPage value
-
setPreviousPage
Sets the previousPage attribute of the SchemEditForm object- Parameters:
s- The new previousPage value
-
getFieldInfoMap
Gets the fieldInfoMap attribute of the SchemEditForm object- Returns:
- The fieldInfoMap value
-
getFieldInfoReader
Gets the fieldInfoReader attribute of the SchemEditForm object- Returns:
- The fieldInfoReader value
-
setFieldInfoReader
Sets the fieldInfoReader attribute of the SchemEditForm object- Parameters:
fieldInfoReader- The new fieldInfoReader value
-
getFieldInfo
Returns aFieldInfoReaderfor the specified path. FieldInfoReaders are stored in the fieldInfoMap attribute of the SchemEditForm object (key is xpath).- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- The fieldInfo value
-
getSchemaHelper
Gets the schemaHelper attribute of the SchemEditForm object.Note: schemaHelper is SET as a side-effect of setFramework().
- Returns:
- The schemaHelper value
-
getDocMap
Gets the docMap attribute of the SchemEditForm object- Returns:
- The docMap value
-
setDocMap
public void setDocMap(org.dom4j.Document document) Sets the docMap attribute of the SchemEditForm object- Parameters:
document- The new docMap value
-
setAdnDocReader
Sets the adnDocReader attribute of the SchemEditForm object- Parameters:
adnDocReader- The new adnDocReader value
-
getAdnDocReader
Gets the adnDocReader attribute of the SchemEditForm object- Returns:
- The adnDocReader value
-
getValueOf
Gets the valueOf attribute of the SchemEditForm object- Parameters:
key- a jsp-encoded xpath- Returns:
- The valueOf value
-
setValueOf
Sets the valueOf attribute of the SchemEditForm object- Parameters:
key- a jsp-encoded xpathval- the value to set
-
getAnyTypeValueOf
Gets the anyTypeValueOf attribute of the SchemEditForm object- Parameters:
key- a jsp-encoded xpath- Returns:
- The anyTypeValueOf value
-
getNodeExists
Gets the nodeExists attribute of the SchemEditForm object- Parameters:
key- a jsp-encoded xpath- Returns:
- The nodeExists value
-
getNodeHasValue
Return TRUE if this node has a value. Used by fullView to determine whether a value should be shown as "missing or not".We don't want to flag simpleOrComplexContent nodes having type of "xsd:string" as missing, though.
- Parameters:
key- a jsp-encoded xpath- Returns:
- The nodeHasValue value
-
getNodeIsMissingValue
Determines if a text node in the VIEW UI (as opposed to the editor) of a record is missing a value, so it can be highlighted accordingly. A node is missing a value if it does not have a value or it has a value of SchemEditForm.UNSPECIFIED, which is used to denote a unmade menu selection. Nodes that are defined as "string" and are extension element of a derivedType are not considered to be missing a value, even if they are empty (these nodes are not even rendered as input fields in the editor).- Parameters:
key- encoded path- Returns:
- The nodeIsMissingValue value
-
getNodeExistsWithContent
return true if the node exists and it is not empty- Parameters:
key- a jsp-encoded xpath- Returns:
- The nodeExistsWithContent value
-
getNodeExistsWithRequiredAttribute
Return true if the node specified by key exists in the instance document and it has a required attribute in the instance document.- Parameters:
key- a jsp-encoded xpath- Returns:
- The nodeExistsWithRequiredAttribute value
-
getBranchIsRequired
return true iff schemaHelper.isRequiredBranch returns TRUE- Parameters:
key- a jsp-encoded xpath- Returns:
- The branchIsRequired value
-
getViewNode
Returns TRUE if node is Required OR has a value (i.e., satisfies the "nodeExistsWithContent" predicate).Used with views for displaying (as opposed to editing) metadata fields.
- Parameters:
key- a jsp-encoded xpath- Returns:
- The viewNode value
-
getNodeIsExpandable
Returns true of the node designated by key can be expanded.A node can be expanded if: - it is a required branch - the node exists and it is NOT empty (it should also be complex??) -
- Parameters:
key- a jsp-encoded xpath- Returns:
- The nodeIsExpandable value
-
getParentNodeExists
Gets the parentNodeExists attribute of the SchemEditForm object- Parameters:
key- a jsp-encoded xpath- Returns:
- The parentNodeExists value
-
getNodeIsEmpty
Gets the nodeIsEmpty attribute of the SchemEditForm object- Parameters:
key- a jsp-encoded xpath- Returns:
- The nodeIsEmpty value
-
getEnumerationPaths
Gets the enumerationPaths of a Document given an xpath to a member. For exmample, given "/itemRecord/general/subjects/subject", a list of all elements satisfying this path would be returned . /itemRecord/general/subjects/subject[1] would be the first member of this list.- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- a list of xpaths corresponding to the values of enumeration.
-
clearMultiValuesCache
public void clearMultiValuesCache()Clear cache of eneration values that are used to optimize property lookup during display of form. (cleared before presenting form) -
getEnumerationValuesOf
Gets the curently assigned values for the given xpath in the current Document. This method can be called very many times for the same page, so we cache values in the multiValuesCache- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- The enumerationValuesOf value
-
getMembersOf
Gets the membersOf attribute of the SchemEditForm object- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- The membersOf value
-
getMemberCountOf
Returns number of elements in the Document matching a given xpath- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- The membersOf value
-
getChildElementCountOf
Gets the childElementCountOf attribute of the SchemEditForm object- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- The childElementCountOf value
-
getHasChildren
Gets the hasChildren attribute of the SchemEditForm object- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- The hasChildren value
-
getSubstitutionGroupMembersOf
Select all substitutionGroup elements by building up complex selection xpath ORing together the xpaths for the substitutionGroup members- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- The substitutionGroupMembersOf value
-
getSubstitutionGroupMemberCountOf
Gets the substitutionGroupMemberCountOf attribute of the SchemEditForm object- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- The substitutionGroupMemberCountOf value
-
getLegalEnumerationValuesOf
Gets the legal values an enumeration (controlled vocab defined in schema) can assume.- Parameters:
encodedPath- encoded xpath of field- Returns:
- The legal values
-
getEnumerationOptions
Gets the possible values and labels (defined by the an EnumerationType representing a controlled vocab) that an element may assume.- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- array of LabelValue beans for controlled vocab defined for the xpath
-
getSubstitutionGroupOptions
Given the path to a schemaNode that isHeadElement(), return an array of LabelValueBean objects representing, the substitutionGroup, where both the label and the value are the group memebers qualifiedName- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- The substitutionGroupOptions value
-
getComboOtherOption
public org.apache.struts.util.LabelValueBean getComboOtherOption()provide values to use as constants in comboUnionInput processing- Returns:
- The comboOtherOption value
-
getComboSelectOptions
Gets the options for a comboSelect input element, which presents a list of options to the user but also allows input of arbitrary values.If the field being edited contains a value other than those specified in the schema, then add this value to the options returned.
- Parameters:
encodedPath- jsp-encoded xpath to the element- Returns:
- The comboSelectOptions value
-
getSelectOptions
Gets the selectOptions for the given xpath from the Schema. If the element specified by xpath is an optionalSingleSelect then method returns results identical to getEnumerationOptions, except a new, blank option is added to the list of options.If the element at xpath is NOT an optionalSingleSelect, then getEnumerationOptions is returned.
- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- an array of LabelValueBean instances
-
getAcceptsNewSibling
Determines whether the parent of the element corresponding to encodedPath can accept a new sibling of encodedPath.The indexing of the target element is important, since it is required by the compositor to determine whether a new sibling can be accepted.
- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- TRUE if a new sibling can be added.
-
getAcceptsNewSubstitionGroupMember
Gets the acceptsNewSubstitionGroupMember attribute of the SchemEditForm object- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- The acceptsNewSubstitionGroupMember value
-
getAcceptsNewChoice
Gets the acceptsNewChoice attribute of the SchemEditForm object- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- The acceptsNewChoice value
-
getChoiceOptions
Gets the choiceOptions for the element specified by "encodedPath", adding indexing if the element is a multiChoice.- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- The choiceOptions value
-
getRepeatingFieldsToPrune
Cache of repeating values that stores repeating elements which may have empty values after the form is submitted. The cache is cleared after validation of form.- Returns:
- The repeatingFieldsToPrune value
-
clearRepeatingFieldsToPrune
public void clearRepeatingFieldsToPrune()Clear the cache of repeating values that stores the repeating elements which may have empty values after form is submitted. Called bySchemEditValidator.pruneRepeatingFields() -
setRepeatingField
Stores repeating values that stores repeating elements which may have empty values after the form is submitted. Necessary to support the case in which a user unselects all previously selected values- Parameters:
xpath- The new repeatingField value
-
getRepeatingMembersOf
Gets a list of all nodes for a given xpath, PLUS a bogus node that supports addition of a new member in the JSP form.- Parameters:
encodedPath- a jsp-encoded xpath- Returns:
- A list of existing nodes PLUS a new, empty one
-
validate
public SchemEditActionErrors validate(org.apache.struts.action.ActionMapping mapping, HttpServletRequest request) Validate the request parameters before the Action sees them). NOTE: "validate" must be 2set to TRUE in action mapping (see struts-config) for this method to be called.NOTE: is this necessary for the entities to get displayed correctly in the editing forms??
- Overrides:
validatein classorg.apache.struts.action.ActionForm- Parameters:
mapping- NOT YET DOCUMENTEDrequest- NOT YET DOCUMENTED- Returns:
- NOT YET DOCUMENTED
-
prtln
Output a line of text to standard out, with datestamp, if debug is set to true.- Parameters:
s- The String that will be output.
-