org.dlese.dpc.schemedit.action.form
Class SchemEditForm

java.lang.Object
  org.apache.struts.action.ActionForm
      org.dlese.dpc.schemedit.action.form.SchemEditForm

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DCSViewForm

public class SchemEditForm
extends org.apache.struts.action.ActionForm

ActionForm bean for handling requests to support MetaDataEditor. Most methods acesss the DocMap attribute, which wraps the XML Document that is being edited.

Author:

ostwald

See Also:

Serialized Form

Field Summary

static String	FALSE NOT YET DOCUMENTED
static String	TRUE NOT YET DOCUMENTED
static String	UNSPECIFIED Description of the Field

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Constructor Summary

SchemEditForm()
Constructor

Method Summary

void	clear() NOT YET DOCUMENTED
void	clearMultiValuesCache() Clear cache of eneration values that are used to optimize property lookup during display of form.
void	clearRepeatingFieldsToPrune() Clear the cache of repeating values that stores the repeating elements which may have empty values after form is submitted.
void	exposeNode(String xpath) Make a node visible in the editor.
String	getAcceptsNewChoice(String encodedPath) Gets the acceptsNewChoice attribute of the SchemEditForm object
String	getAcceptsNewSibling(String encodedPath) Determines whether the parent of the element corresponding to encodedPath can accept a new sibling of encodedPath.
String	getAcceptsNewSubstitionGroupMember(String encodedPath) Gets the acceptsNewSubstitionGroupMember attribute of the SchemEditForm object
ADNItemDocReader	getAdnDocReader() Gets the adnDocReader attribute of the SchemEditForm object
Object	getAnyTypeValueOf(String key) Gets the anyTypeValueOf attribute of the SchemEditForm object
String	getAsyncJason() Gets the asyncJason attribute of the SchemEditForm object
String	getBaseExportDir() Gets the baseExportDir attribute of the SchemEditForm object
String	getBranchIsRequired(String key) return true iff schemaHelper.isRequiredBranch returns TRUE
int	getChildElementCountOf(String encodedPath) Gets the childElementCountOf attribute of the SchemEditForm object
org.apache.struts.util.LabelValueBean[]	getChoiceOptions(String encodedPath) Gets the choiceOptions for the element specified by "encodedPath", adding indexing if the element is a multiChoice.
CollapseBean	getCollapseBean() Gets the collapseBean attribute of the SchemEditForm object
String	getCollection() Gets the collection attribute of the SchemEditForm object
String	getCollectionName() Gets the collectionName attribute of the SchemEditForm object
org.apache.struts.util.LabelValueBean	getComboOtherOption() provide values to use as constants in comboUnionInput processing
org.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.
String	getContextURL() Gets the contextURL attribute of the DCSBrowseForm object
String	getCurrentPage() Gets the currentPage attribute of the SchemEditForm object
String	getCurrentPageEncoded() Gets the currentPageEncoded attribute of the SchemEditForm object
String	getCurrentStdDocKey() Gets the currentStdDocKey attribute of the SchemEditForm object
DcsDataRecord	getDcsDataRecord() Gets the dcsDataRecord attribute of the SchemEditForm object
List	getDirs() Gets the dirs attribute of the SchemEditForm object
String	getDiscussionURL() Gets the discussionURL attribute of the SchemEditForm object
DocMap	getDocMap() Gets the docMap attribute of the SchemEditForm object
ResultDocList	getDuplicateUrlRecs() Gets the duplicateUrlRecs attribute of the SchemEditForm object
List	getDups() Gets the dups attribute of the SchemEditForm object
org.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.
List	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.
FieldInfoReader	getFieldInfo(String encodedPath) Returns a FieldInfoReader for the specified path.
FieldInfoMap	getFieldInfoMap() Gets the fieldInfoMap attribute of the SchemEditForm object
FieldInfoReader	getFieldInfoReader() Gets the fieldInfoReader attribute of the SchemEditForm object
boolean	getForceValidation() Gets the forceValidation attribute of the SchemEditForm object
MetaDataFramework	getFramework() Gets the framework attribute of the SchemEditForm object
String	getFrameworkName() Gets the frameworkName attribute of the SchemEditForm object
String	getGuardedExitPath() Gets the pathArg attribute of the SchemEditForm object
boolean	getHasChildren(String encodedPath) Gets the hasChildren attribute of the SchemEditForm object
String	getHash() Gets the hash attribute of the SchemEditForm object
InputManager	getInputManager() Gets the inputManager attribute of the SchemEditForm object
List	getLegalEnumerationValuesOf(String encodedPath) Gets the legal values an enumeration (controlled vocab defined in schema) can assume.
int	getMemberCountOf(String encodedPath) Returns number of elements in the Document matching a given xpath
List	getMembersOf(String encodedPath) Gets the membersOf attribute of the SchemEditForm object
String	getMetadata() Gets the metadata attribute of the SchemEditForm object
boolean	getMuiFormattable(String encodedPath) Returns true if a MUI groups file exists for the provided path
String	getNodeExists(String key) Gets the nodeExists attribute of the SchemEditForm object
String	getNodeExistsWithContent(String key) return true if the node exists and it is not empty
String	getNodeExistsWithRequiredAttribute(String key) Return true if the node specified by key exists in the instance document and it has a required attribute in the instance document.
String	getNodeHasValue(String key) Return TRUE if this node has a value.
String	getNodeIsEmpty(String key) Gets the nodeIsEmpty attribute of the SchemEditForm object
String	getNodeIsExpandable(String key) Returns true of the node designated by key can be expanded.
String	getNodeIsMissingValue(String key) 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.
PageList	getPageList() Gets the pageList attribute of the SchemEditForm object
String	getPageTitle() Gets the pageTitle attribute of the SchemEditForm object
String	getParentNodeExists(String key) Gets the parentNodeExists attribute of the SchemEditForm object
String	getPathArg() Gets the pathArg attribute of the SchemEditForm object
String	getPreviousPage() Gets the previousPage attribute of the SchemEditForm object
String	getRecId() Gets the recId attribute of the SchemEditForm object
Record[]	getRecords() Gets the records attribute of the SchemEditForm object
File	getRecordsDir() Gets the location of metadata records for a StandAlone Editor.
ArrayList	getRepeatingFieldsToPrune() Cache of repeating values that stores repeating elements which may have empty values after the form is submitted.
List	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.
ResultDoc	getResultDoc() Gets the resultDoc attribute of the SchemEditForm object
Map	getSavedContent() Gets the savedContent attribute of the SchemEditForm object
SchemaHelper	getSchemaHelper() Gets 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.
ServletContext	getServletContext() Gets the servletContext attribute of the SchemEditForm object
DcsSetInfo	getSetInfo() Gets the setInfo attribute of the SchemEditForm object
ResultDocList	getSimilarUrlRecs() Gets the similarUrlRecs attribute of the SchemEditForm object
List	getSims() Gets the sims attribute of the SchemEditForm object
int	getSubstitutionGroupMemberCountOf(String encodedPath) Gets the substitutionGroupMemberCountOf attribute of the SchemEditForm object
List	getSubstitutionGroupMembersOf(String encodedPath) Select all substitutionGroup elements by building up complex selection xpath ORing together the xpaths for the substitutionGroup members
org.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 qualifiedName
CATServiceHelper	getSuggestionServiceHelper() Gets the suggestionServiceHelper attribute of the SchemEditForm object
String	getTmpArg() Gets the tmpArg attribute of the SchemEditForm object
String	getValidatedUrl() Gets the validatedUrl attribute of the SchemEditForm object
Object	getValueOf(String key) Gets the valueOf attribute of the SchemEditForm object
String	getViewNode(String key) Returns TRUE if node is Required OR has a value (i.e., satisfies the "nodeExistsWithContent" predicate).
MetadataVocab	getVocab() Gets the vocab attribute of the SchemEditForm object
VocabLayout	getVocabLayout() Get VocabLayout instance for the current vocabField.
List	getVocabLayoutNodes() Get top-level vocabLayoutNodes for the current vocabField.
ArrayList	getVocabList() Gets a list of VocabNodes under the current value of "vocabField".
String	getXmlFormat() Gets the xmlFormat attribute of the SchemEditForm object
protected static void	prtln(String s) Output a line of text to standard out, with datestamp, if debug is set to true.
void	setAdnDocReader(ADNItemDocReader adnDocReader) Sets the adnDocReader attribute of the SchemEditForm object
void	setAsyncJason(String json) Sets the asyncJason attribute of the SchemEditForm object
void	setCollection(String collection) Sets the collection attribute of the SchemEditForm object
void	setContextURL(String contextURL) Sets the contextURL attribute of the DCSBrowseForm object
void	setCurrentPage(String s) Sets the currentPage attribute of the SchemEditForm object
void	setCurrentStdDocKey(String key) Sets the currentStdDocKey attribute of the SchemEditForm object
void	setDcsDataRecord(DcsDataRecord dataRec) Sets the dcsDataRecord attribute of the SchemEditForm object
void	setDiscussionURL(String url) Sets the discussionURL attribute of the SchemEditForm object
void	setDocMap(Document document) Sets the docMap attribute of the SchemEditForm object
void	setDuplicateUrlRecs(ResultDocList results) Sets the duplicateUrlRecs attribute of the SchemEditForm object
void	setDups(List simDupList) Sets the dups attribute of the SchemEditForm object
void	setFieldInfoReader(FieldInfoReader fieldInfoReader) Sets the fieldInfoReader attribute of the SchemEditForm object
void	setForceValidation(boolean forceValidation) Sets the forceValidation attribute of the SchemEditForm object
void	setFramework(MetaDataFramework framework) Sets the framework attribute of the SchemEditForm object
void	setGuardedExitPath(String arg) Sets the guardedExitPath attribute of the SchemEditForm object
void	setHash(String s) Sets the hash attribute of the SchemEditForm object
void	setMetadata(String s) Sets the metadata attribute of the SchemEditForm object
void	setPageList(PageList pageList) Sets the pageList attribute of the SchemEditForm object
void	setPageTitle(String s) Sets the pageTitle attribute of the SchemEditForm object
void	setPathArg(String arg) Sets the pathArg attribute of the SchemEditForm object
void	setPreviousPage(String s) Sets the previousPage attribute of the SchemEditForm object
void	setRecId(String id) Sets the recId attribute of the SchemEditForm object
void	setRecordsDir(File dir) Sets the recordsDir attribute of the SchemEditForm object
void	setRepeatingField(String xpath) Stores repeating values that stores repeating elements which may have empty values after the form is submitted.
void	setResultDoc(ResultDoc resultDoc) Sets the resultDoc attribute of the SchemEditForm object
void	setSavedContent(Map map) Sets the savedContent attribute of the SchemEditForm object
void	setSetInfo(DcsSetInfo info) Sets the setInfo attribute of the SchemEditForm object
void	setSimilarUrlRecs(ResultDocList results) Sets the similarUrlRecs attribute of the SchemEditForm object
void	setSims(List simDupList) Sets the sims attribute of the SchemEditForm object
void	setSuggestionServiceHelper(CATServiceHelper helper) Sets the suggestionServiceHelper attribute of the SchemEditForm object
void	setTmpArg(String s) Sets the tmpArg attribute of the SchemEditForm object
void	setValidatedUrl(String validatedUrl) Sets the validatedUrl attribute of the SchemEditForm object
void	setValueOf(String key, Object val) Sets the valueOf attribute of the SchemEditForm object
void	setVocab(MetadataVocab vocab) Constructor for the setVocab object
void	setVocabAudience(String vocabAudience) Sets the vocabAudience attribute of the SchemEditForm object
void	setVocabField(String paramName) Sets the vocabField attribute to an xpath extracted from the proviced paramName.
void	setVocabInterface(String vocabInterface) Sets the vocabInterface attribute of the SchemEditForm object
void	setVocabLanguage(String vocabLanguage) Sets the vocabLanguage attribute of the SchemEditForm object
SchemEditActionErrors	validate(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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UNSPECIFIED

public static String UNSPECIFIED

Description of the Field

TRUE

public static String TRUE

NOT YET DOCUMENTED

FALSE

public static String FALSE

NOT YET DOCUMENTED

Constructor Detail

SchemEditForm

public SchemEditForm()

Constructor

Method Detail

clear

public void clear()

NOT YET DOCUMENTED

getCurrentStdDocKey

public String getCurrentStdDocKey()

Gets the currentStdDocKey attribute of the SchemEditForm object

Returns:

The currentStdDocKey value

setCurrentStdDocKey

public void setCurrentStdDocKey(String key)

Sets the currentStdDocKey attribute of the SchemEditForm object

Parameters:

key - The new currentStdDocKey value

getServletContext

public ServletContext getServletContext()

Gets the servletContext attribute of the SchemEditForm object

Returns:

The servletContext value

getSuggestionServiceHelper

public CATServiceHelper getSuggestionServiceHelper()

Gets the suggestionServiceHelper attribute of the SchemEditForm object

Returns:

The suggestionServiceHelper value

setSuggestionServiceHelper

public void setSuggestionServiceHelper(CATServiceHelper helper)

Sets the suggestionServiceHelper attribute of the SchemEditForm object

Parameters:

helper - The new suggestionServiceHelper value

setVocab

public void setVocab(MetadataVocab vocab)

Constructor for the setVocab object

Parameters:

vocab -

getVocab

public MetadataVocab getVocab()

Gets the vocab attribute of the SchemEditForm object

Returns:

The vocab value

setVocabField

public void setVocabField(String paramName)

Sets the vocabField attribute to an xpath extracted from the proviced paramName.

Parameters:

paramName - The new vocabField value

setVocabInterface

public void setVocabInterface(String vocabInterface)

Sets the vocabInterface attribute of the SchemEditForm object

Parameters:

vocabInterface - The new vocabInterface value

setVocabAudience

public void setVocabAudience(String vocabAudience)

Sets the vocabAudience attribute of the SchemEditForm object

Parameters:

vocabAudience - The new vocabAudience value

setVocabLanguage

public void setVocabLanguage(String vocabLanguage)

Sets the vocabLanguage attribute of the SchemEditForm object

Parameters:

vocabLanguage - The new vocabLanguage value

getMuiFormattable

public boolean getMuiFormattable(String encodedPath)

Returns true if a MUI groups file exists for the provided path

Parameters:

encodedPath - a jsp-encoded xpath

Returns:

The muiFormattable value

getVocabList

public ArrayList getVocabList()

Gets a list of VocabNodes under the current value of "vocabField". This method uses the MUI.

Returns:

The vocabList value

getVocabLayout

public VocabLayout getVocabLayout()

Get VocabLayout instance for the current vocabField.

Returns:

The vocabLayout value

getVocabLayoutNodes

public List getVocabLayoutNodes()

Get top-level vocabLayoutNodes for the current vocabField.

Returns:

The vocabLayoutNodes value

getAsyncJason

public String getAsyncJason()

Gets the asyncJason attribute of the SchemEditForm object

Returns:

The asyncJason value

setAsyncJason

public void setAsyncJason(String json)

Sets the asyncJason attribute of the SchemEditForm object

Parameters:

json - The new asyncJason value

getInputManager

public InputManager getInputManager()

Gets the inputManager attribute of the SchemEditForm object

Returns:

The inputManager value

getFramework

public MetaDataFramework getFramework()

Gets the framework attribute of the SchemEditForm object

Returns:

The framework value

setFramework

public void setFramework(MetaDataFramework framework)

Sets the framework attribute of the SchemEditForm object

Parameters:

framework - The new framework value

getBaseExportDir

public String getBaseExportDir()

Gets the baseExportDir attribute of the SchemEditForm object

Returns:

The baseExportDir value

getResultDoc

public ResultDoc getResultDoc()

Gets the resultDoc attribute of the SchemEditForm object

Returns:

The resultDoc value

setResultDoc

public void setResultDoc(ResultDoc resultDoc)

Sets the resultDoc attribute of the SchemEditForm object

Parameters:

resultDoc - The new resultDoc value

getContextURL

public String getContextURL()

Gets the contextURL attribute of the DCSBrowseForm object

Returns:

The contextURL value

setContextURL

public void setContextURL(String contextURL)

Sets the contextURL attribute of the DCSBrowseForm object

Parameters:

contextURL - The new contextURL value

getSavedContent

public Map getSavedContent()

Gets the savedContent attribute of the SchemEditForm object

Returns:

The savedContent value

setSavedContent

public void setSavedContent(Map map)

Sets the savedContent attribute of the SchemEditForm object

Parameters:

map - The new savedContent value

getValidatedUrl

public String getValidatedUrl()

Gets the validatedUrl attribute of the SchemEditForm object

Returns:

The validatedUrl value

setValidatedUrl

public void setValidatedUrl(String validatedUrl)

Sets the validatedUrl attribute of the SchemEditForm object

Parameters:

validatedUrl - The new validatedUrl value

getSimilarUrlRecs

public ResultDocList getSimilarUrlRecs()

Gets the similarUrlRecs attribute of the SchemEditForm object

Returns:

The similarUrlRecs value

setSimilarUrlRecs

public void setSimilarUrlRecs(ResultDocList results)

Sets the similarUrlRecs attribute of the SchemEditForm object

Parameters:

results - The new similarUrlRecs value

getDuplicateUrlRecs

public ResultDocList getDuplicateUrlRecs()

Gets the duplicateUrlRecs attribute of the SchemEditForm object

Returns:

The duplicateUrlRecs value

setDuplicateUrlRecs

public void setDuplicateUrlRecs(ResultDocList results)

Sets the duplicateUrlRecs attribute of the SchemEditForm object

Parameters:

results - The new duplicateUrlRecs value

getDups

public List getDups()

Gets the dups attribute of the SchemEditForm object

Returns:

The dups value

setDups

public void setDups(List simDupList)

Sets the dups attribute of the SchemEditForm object

Parameters:

simDupList - The new dups value

getSims

public List getSims()

Gets the sims attribute of the SchemEditForm object

Returns:

The sims value

setSims

public void setSims(List simDupList)

Sets the sims attribute of the SchemEditForm object

Parameters:

simDupList - The new sims value

getDcsDataRecord

public DcsDataRecord getDcsDataRecord()

Gets the dcsDataRecord attribute of the SchemEditForm object

Returns:

The dcsDataRecord value

getCollapseBean

public CollapseBean getCollapseBean()

Gets the collapseBean attribute of the SchemEditForm object

Returns:

The collapseBean value

getSetInfo

public DcsSetInfo getSetInfo()

Gets the setInfo attribute of the SchemEditForm object

Returns:

The setInfo value

setSetInfo

public void setSetInfo(DcsSetInfo info)

Sets the setInfo attribute of the SchemEditForm object

Parameters:

info - The new setInfo value

exposeNode

public void exposeNode(String xpath)

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

public void setDcsDataRecord(DcsDataRecord dataRec)

Sets the dcsDataRecord attribute of the SchemEditForm object

Parameters:

dataRec - The new dcsDataRecord value

setMetadata

public void setMetadata(String s)

Sets the metadata attribute of the SchemEditForm object

Parameters:

s - The new metadata value

getMetadata

public String getMetadata()

Gets the metadata attribute of the SchemEditForm object

Returns:

The metadata value

getCollection

public String getCollection()

Gets the collection attribute of the SchemEditForm object

Returns:

The collection value

setCollection

public void setCollection(String collection)

Sets the collection attribute of the SchemEditForm object

Parameters:

collection - The new collection value

getCollectionName

public String getCollectionName()

Gets the collectionName attribute of the SchemEditForm object

Returns:

The collectionName value

getDiscussionURL

public String getDiscussionURL()

Gets the discussionURL attribute of the SchemEditForm object

Returns:

The discussionURL value

setDiscussionURL

public void setDiscussionURL(String url)

Sets the discussionURL attribute of the SchemEditForm object

Parameters:

url - The new discussionURL value

getFrameworkName

public String getFrameworkName()

Gets the frameworkName attribute of the SchemEditForm object

Returns:

The frameworkName value

getRecordsDir

public File getRecordsDir()

Gets the location of metadata records for a StandAlone Editor.

Returns:

The recordsDir value

setRecordsDir

public void setRecordsDir(File dir)

Sets the recordsDir attribute of the SchemEditForm object

Parameters:

dir - The new recordsDir value

getRecords

public Record[] getRecords()

Gets the records attribute of the SchemEditForm object

Returns:

The records value

getDirs

public List getDirs()

Gets the dirs attribute of the SchemEditForm object

Returns:

The dirs value

getHash

public String getHash()

Gets the hash attribute of the SchemEditForm object

Returns:

The hash value

setHash

public void setHash(String s)

Sets the hash attribute of the SchemEditForm object

Parameters:

s - The new hash value

getPageTitle

public String getPageTitle()

Gets the pageTitle attribute of the SchemEditForm object

Returns:

The pageTitle value

setPageTitle

public void setPageTitle(String s)

Sets the pageTitle attribute of the SchemEditForm object

Parameters:

s - The new pageTitle value

getXmlFormat

public String getXmlFormat()

Gets the xmlFormat attribute of the SchemEditForm object

Returns:

The xmlFormat value

getPageList

public PageList getPageList()

Gets the pageList attribute of the SchemEditForm object

Returns:

The pageList value

setPageList

public void setPageList(PageList pageList)

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

public String getTmpArg()

Gets the tmpArg attribute of the SchemEditForm object

Returns:

The tmpArg value

setTmpArg

public void setTmpArg(String s)

Sets the tmpArg attribute of the SchemEditForm object

Parameters:

s - The new tmpArg value

getRecId

public String getRecId()

Gets the recId attribute of the SchemEditForm object

Returns:

The recId value

setRecId

public void setRecId(String id)

Sets the recId attribute of the SchemEditForm object

Parameters:

id - The new recId value

setPathArg

public void setPathArg(String arg)

Sets the pathArg attribute of the SchemEditForm object

Parameters:

arg - The new pathArg value

getGuardedExitPath

public String getGuardedExitPath()

Gets the pathArg attribute of the SchemEditForm object

Returns:

The pathArg value

setGuardedExitPath

public void setGuardedExitPath(String arg)

Sets the guardedExitPath attribute of the SchemEditForm object

Parameters:

arg - The new guardedExitPath value

getPathArg

public String getPathArg()

Gets the pathArg attribute of the SchemEditForm object

Returns:

The pathArg value

getCurrentPage

public String getCurrentPage()

Gets the currentPage attribute of the SchemEditForm object

Returns:

The currentPage value

setCurrentPage

public void setCurrentPage(String s)

Sets the currentPage attribute of the SchemEditForm object

Parameters:

s - The new currentPage value

getCurrentPageEncoded

public String getCurrentPageEncoded()

Gets the currentPageEncoded attribute of the SchemEditForm object

Returns:

The currentPageEncoded value

getPreviousPage

public String getPreviousPage()

Gets the previousPage attribute of the SchemEditForm object

Returns:

The previousPage value

setPreviousPage

public void setPreviousPage(String s)

Sets the previousPage attribute of the SchemEditForm object

Parameters:

s - The new previousPage value

getFieldInfoMap

public FieldInfoMap getFieldInfoMap()

Gets the fieldInfoMap attribute of the SchemEditForm object

Returns:

The fieldInfoMap value

getFieldInfoReader

public FieldInfoReader getFieldInfoReader()

Gets the fieldInfoReader attribute of the SchemEditForm object

Returns:

The fieldInfoReader value

setFieldInfoReader

public void setFieldInfoReader(FieldInfoReader fieldInfoReader)

Sets the fieldInfoReader attribute of the SchemEditForm object

Parameters:

fieldInfoReader - The new fieldInfoReader value

getFieldInfo

public FieldInfoReader getFieldInfo(String encodedPath)

Returns a FieldInfoReader for 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

public SchemaHelper getSchemaHelper()

Gets the schemaHelper attribute of the SchemEditForm object.

Note: schemaHelper is SET as a side-effect of setFramework().

Returns:

The schemaHelper value

getDocMap

public DocMap getDocMap()

Gets the docMap attribute of the SchemEditForm object

Returns:

The docMap value

setDocMap

public void setDocMap(Document document)

Sets the docMap attribute of the SchemEditForm object

Parameters:

document - The new docMap value

setAdnDocReader

public void setAdnDocReader(ADNItemDocReader adnDocReader)

Sets the adnDocReader attribute of the SchemEditForm object

Parameters:

adnDocReader - The new adnDocReader value

getAdnDocReader

public ADNItemDocReader getAdnDocReader()

Gets the adnDocReader attribute of the SchemEditForm object

Returns:

The adnDocReader value

getValueOf

public Object getValueOf(String key)

Gets the valueOf attribute of the SchemEditForm object

Parameters:

key - a jsp-encoded xpath

Returns:

The valueOf value

setValueOf

public void setValueOf(String key,
                       Object val)

Sets the valueOf attribute of the SchemEditForm object

Parameters:

key - a jsp-encoded xpath

val - the value to set

getAnyTypeValueOf

public Object getAnyTypeValueOf(String key)

Gets the anyTypeValueOf attribute of the SchemEditForm object

Parameters:

key - a jsp-encoded xpath

Returns:

The anyTypeValueOf value

getNodeExists

public String getNodeExists(String key)

Gets the nodeExists attribute of the SchemEditForm object

Parameters:

key - a jsp-encoded xpath

Returns:

The nodeExists value

getNodeHasValue

public String getNodeHasValue(String key)

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

public String getNodeIsMissingValue(String key)

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

public String getNodeExistsWithContent(String key)

return true if the node exists and it is not empty

Parameters:

key - a jsp-encoded xpath

Returns:

The nodeExistsWithContent value

getNodeExistsWithRequiredAttribute

public String getNodeExistsWithRequiredAttribute(String key)

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

public String getBranchIsRequired(String key)

return true iff schemaHelper.isRequiredBranch returns TRUE

Parameters:

key - a jsp-encoded xpath

Returns:

The branchIsRequired value

getViewNode

public String getViewNode(String key)

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

public String getNodeIsExpandable(String key)

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

public String getParentNodeExists(String key)

Gets the parentNodeExists attribute of the SchemEditForm object

Parameters:

key - a jsp-encoded xpath

Returns:

The parentNodeExists value

getNodeIsEmpty

public String getNodeIsEmpty(String key)

Gets the nodeIsEmpty attribute of the SchemEditForm object

Parameters:

key - a jsp-encoded xpath

Returns:

The nodeIsEmpty value

getEnumerationPaths

public List getEnumerationPaths(String encodedPath)

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

public String[] getEnumerationValuesOf(String encodedPath)

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

public List getMembersOf(String encodedPath)

Gets the membersOf attribute of the SchemEditForm object

Parameters:

encodedPath - a jsp-encoded xpath

Returns:

The membersOf value

getMemberCountOf

public int getMemberCountOf(String encodedPath)

Returns number of elements in the Document matching a given xpath

Parameters:

encodedPath - a jsp-encoded xpath

Returns:

The membersOf value

getChildElementCountOf

public int getChildElementCountOf(String encodedPath)

Gets the childElementCountOf attribute of the SchemEditForm object

Parameters:

encodedPath - a jsp-encoded xpath

Returns:

The childElementCountOf value

getHasChildren

public boolean getHasChildren(String encodedPath)

Gets the hasChildren attribute of the SchemEditForm object

Parameters:

encodedPath - a jsp-encoded xpath

Returns:

The hasChildren value

getSubstitutionGroupMembersOf

public List getSubstitutionGroupMembersOf(String encodedPath)

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

public int getSubstitutionGroupMemberCountOf(String encodedPath)

Gets the substitutionGroupMemberCountOf attribute of the SchemEditForm object

Parameters:

encodedPath - a jsp-encoded xpath

Returns:

The substitutionGroupMemberCountOf value

getLegalEnumerationValuesOf

public List getLegalEnumerationValuesOf(String encodedPath)

Gets the legal values an enumeration (controlled vocab defined in schema) can assume.

Parameters:

encodedPath - encoded xpath of field

Returns:

The legal values

getEnumerationOptions

public org.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.

Parameters:

encodedPath - a jsp-encoded xpath

Returns:

array of LabelValue beans for controlled vocab defined for the xpath

getSubstitutionGroupOptions

public org.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 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

public org.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.

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

public org.apache.struts.util.LabelValueBean[] getSelectOptions(String encodedPath)

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

public String getAcceptsNewSibling(String encodedPath)

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

public String getAcceptsNewSubstitionGroupMember(String encodedPath)

Gets the acceptsNewSubstitionGroupMember attribute of the SchemEditForm object

Parameters:

encodedPath - a jsp-encoded xpath

Returns:

The acceptsNewSubstitionGroupMember value

getAcceptsNewChoice

public String getAcceptsNewChoice(String encodedPath)

Gets the acceptsNewChoice attribute of the SchemEditForm object

Parameters:

encodedPath - a jsp-encoded xpath

Returns:

The acceptsNewChoice value

getChoiceOptions

public org.apache.struts.util.LabelValueBean[] getChoiceOptions(String encodedPath)

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

public ArrayList 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 by SchemEditValidator.pruneRepeatingFields()

setRepeatingField

public void setRepeatingField(String xpath)

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

public List 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.

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:

validate in class org.apache.struts.action.ActionForm

Parameters:

mapping - NOT YET DOCUMENTED

request - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

prtln

protected static void prtln(String s)

Output a line of text to standard out, with datestamp, if debug is set to true.

Parameters:

s - The String that will be output.