org.openxava.view
Class View

java.lang.Object
  org.openxava.view.View

All Implemented Interfaces:

java.io.Serializable

public class View
extends java.lang.Object
implements java.io.Serializable

Session object to manage a view based in maps, hence suitable for OpenXava

Author:

Javier Paniza

See Also:

Serialized Form

Constructor Summary

View()

Method Summary

void	addDetailAction(java.lang.String qualifiedActionName) Has sense if the subview represents a collection, although always works.
void	addListAction(java.lang.String qualifiedActionName) Has sense if the subview represents a collection, although always works.
void	addValues(java.util.Map map)
void	assignValuesToWebView()
void	assignValuesToWebView(java.lang.String qualifier)
void	clear() Clear all displayed data.
boolean	displayAsDescriptionsList(MetaReference ref)
boolean	displayDetailInCollection(java.lang.String collectionName)
void	findObject() Using the key values loaded in the view search the rest of the data from persistent storage and fill the view.
void	findObject(MetaProperty changedProperty) Using the key values loaded in the view search the rest of the data from persistent storage and fill the view.
java.util.Collection	getActionsNamesDetail() Has sense if the subview represents a collection, although always works.
java.util.Collection	getActionsNamesForProperty(MetaProperty p, boolean editable)
java.util.Collection	getActionsNamesForReference(boolean editable) If this is a view that represents a reference
java.util.Collection	getActionsNamesForReference(MetaReference ref, boolean editable)
java.util.Collection	getActionsNamesList()
int	getActiveSection()
java.util.Map	getAllValues() Copy of all values showed in view.
java.util.Map	getCalculatedPropertiesNames()
java.util.Map	getChangedCollections() Qualified ids of the collections changed in this request.
java.util.Map	getChangedLabels() Qualified ids of the member whose labels have changed in this request.
java.util.Map	getChangedPropertiesActionsAndDescriptionsListReferences() Qualified ids of the properties and references as descriptions lists changed in this request.
View	getChangedSectionsView()
int	getCollectionEditingRow()
java.util.List	getCollectionObjects() A list of all objects (POJOs or EntityBeans) in the collection.
java.util.List	getCollectionSelectedObjects() A list of selected objects (POJOs or EntityBeans) in the collection.
java.util.List	getCollectionSelectedValues() A list of selected collection element when each element is a map with the values of the collection element.
Tab	getCollectionTab() Tab used for manage the data of this collection.
java.util.List	getCollectionValues() A list of all collection element when each element is a map with the values of the collection element.
java.lang.String	getConditionInDescriptionsList(MetaReference ref)
java.lang.String	getDescriptionPropertiesInDescriptionsList(MetaReference ref)
java.lang.String	getDescriptionPropertyInDescriptionsList(MetaReference ref)
int	getDisplaySizeForProperty(MetaProperty p)
java.lang.String	getEditCollectionElementAction()
Messages	getErrors()
java.lang.String	getFocusPropertyId()
View	getGroupView(java.lang.String name)
java.lang.String	getHideCollectionElementAction()
java.util.Map	getKeyValues()
java.util.Map	getKeyValuesWithValue() Excludes those values that are null, zero or empty string.
java.lang.String	getLabelFor(MetaMember p)
int	getLabelFormatForProperty(MetaProperty p)
int	getLabelFormatForReference(MetaReference ref)
java.lang.String	getMemberName()
java.util.Map	getMembersNames()
java.util.Map	getMembersNamesWithHidden()
Messages	getMessages()
java.util.Collection	getMetaMembers()
MetaModel	getMetaModel()
java.util.List	getMetaProperties()
java.util.Collection	getMetaPropertiesList()
MetaProperty	getMetaProperty(java.lang.String name)
MetaReference	getMetaReference(java.lang.String name)
java.lang.String	getModelName()
java.lang.String	getNewCollectionElementAction()
java.lang.Object	getObject(java.lang.String name) Retrieve an object associated to this view.
java.lang.String	getOrderInDescriptionsList(MetaReference ref)
java.lang.String	getParameterValuesPropertiesInDescriptionsList(MetaReference ref)
View	getParent()
java.util.Collection	getPropertiesNamesFromPropertiesList(java.lang.String propertiesList)
java.util.Collection	getPropertiesNamesFromStereotypesList(java.lang.String stereotypesList)
java.lang.String	getPropertyPrefix() Prefix used in HTML code for the properties of this view.
java.lang.String	getQualifiedNameForDisplayedPropertyOrDescriptionsListReference(java.lang.String name) If the property or the reference as descriptions list is displayed in this moment then the qualified name (in ModelName.memberName format) is returned.
java.lang.String	getRemoveCollectionElementAction()
java.lang.String	getRemoveSelectedCollectionElementsAction()
HttpServletRequest	getRequest()
View	getRoot()
java.lang.String	getSaveCollectionElementAction()
java.lang.String	getSearchAction()
java.util.List	getSections()
View	getSectionView(int index)
View	getSubview(java.lang.String name)
java.lang.Object	getValue(java.lang.String name)
int	getValueInt(java.lang.String name)
java.util.Map	getValues() Copy of the values showed in view.
java.lang.String	getValueString(java.lang.String name)
java.lang.String	getViewCollectionElementAction()
java.lang.String	getViewName()
java.lang.String	getViewObject() The name of this view as session object.
boolean	hasEditableChanged() If the state of the editable has changed in the last request.
boolean	hasKeyEditableChanged() If the state of the keyEditable has changed in the last request.
boolean	hasKeyProperties()
boolean	hasListActions()
boolean	hasSections()
boolean	isAlignedByColumns()
boolean	isCollectionCalculated() If the collection represents by this view is calculated.
boolean	isCollectionDetailVisible()
boolean	isCollectionEditable()
boolean	isCollectionMembersEditables()
boolean	isCreateNew()
boolean	isCreateNewForReference(MetaReference ref)
boolean	isDetailMemberInCollection()
boolean	isEditable()
boolean	isEditable(MetaProperty metaProperty) If at this moment is editable.
boolean	isEditable(MetaReference metaReference) If at this moment is editable.
boolean	isEditable(java.lang.String member)
boolean	isFirstPropertyAndViewHasNoKeys(MetaProperty pr)
boolean	isFrame()
boolean	isHidden(java.lang.String name)
boolean	isKeyEditable()
boolean	isLastSearchKey(MetaProperty p)
boolean	isLastSearchKey(java.lang.String propertyName)
boolean	isModify()
boolean	isModifyForReference(MetaReference ref)
boolean	isOnlyThrowsOnChange()
boolean	isOrderByKeyInDescriptionsList(MetaReference ref)
boolean	isReloadNeeded()
boolean	isRepresentsAggregate()
boolean	isRepresentsCollection()
boolean	isRepresentsEntityReference()
boolean	isSearch()
boolean	isSearchForReference(MetaReference ref)
boolean	isSection()
boolean	isSectionEditable(java.lang.String sectionName)
boolean	isSubview()
boolean	propertyHasActions(MetaProperty p) If the property has actions associated to it.
boolean	propertyHasActions(java.lang.String name) If the property has actions associated to it.
void	putObject(java.lang.String name, java.lang.Object object) Associates an arbitrary object to this view.
void	recalculateProperties()
void	refresh() Refresh the displayed data from database.
void	refreshCollections() Refreshs the displayed data of all the collections of this view from database.
void	refreshDescriptionsLists() Refresh the displayed data of all the references as descriptions list of this view from database.
void	removeDetailAction(java.lang.String qualifiedActionName) Has sense if the subview represents a collection, although always works.
void	removeListAction(java.lang.String qualifiedActionName) Has sense if the subview represents a collection, although always works.
void	removeObject(java.lang.String name) Remove from this view an object previously associated with @link #putObject(String, Object)
void	reset() Clear all data and set the default values.
void	setActionsNamesDetail(java.util.Collection collection) Has sense if the subview represents a collection, although always works.
void	setActionsNamesList(java.util.Collection collection)
void	setActiveSection(int i)
void	setCollectionDetailVisible(boolean b)
void	setCollectionEditable(boolean b)
void	setCollectionEditingRow(int i)
void	setCollectionMembersEditables(boolean b)
void	setEditable(boolean b)
void	setEditable(java.lang.String name, boolean editable)
void	setEditCollectionElementAction(java.lang.String editCollectionElementAction)
void	setErrors(Messages messages)
void	setFocus(java.lang.String newFocusProperty) Sets the focus in the provided property
void	setHidden(java.lang.String name, boolean hidden)
void	setHideCollectionElementAction(java.lang.String hideCollectionElementAction)
void	setKeyEditable(boolean b)
void	setLabelId(java.lang.String propertyName, java.lang.String id)
void	setMemberName(java.lang.String string)
void	setMessages(Messages messages)
void	setMetaMembers(java.util.Collection metaMembers)
void	setModelName(java.lang.String newModel)
void	setNewCollectionElementAction(java.lang.String newCollectionElementAction)
void	setOnlyThrowsOnChange(boolean onlyThrowsOnChange)
void	setPropertyPrefix(java.lang.String propertyPrefix) Prefix used in HTML code for the properties of this view.
void	setRemoveCollectionElementAction(java.lang.String removeCollectionElementAction)
void	setRemoveSelectedCollectionElementsAction(java.lang.String removeSelectedCollectionElementAction)
void	setRepresentsAggregate(boolean b)
void	setRepresentsCollection(boolean b)
void	setRepresentsEntityReference(boolean b)
void	setRequest(HttpServletRequest request)
void	setSaveCollectionElementAction(java.lang.String saveCollectionElementAction)
void	setSection(boolean b)
void	setSectionEditable(java.lang.String sectionName, boolean editable)
void	setSubview(boolean b)
void	setValue(java.lang.String name, java.lang.Object value) Set the value to the indicated member.
void	setValueNotifying(java.lang.String name, java.lang.Object value) Set the value and notifies the property change, recalculating all dependent properties.
void	setValues(java.util.Map map)
void	setValuesExecutingOnChangeActions(java.util.Map values) Set the values and execute the on-change actions associated to the assigned properties.
void	setValuesNotifying(java.util.Map values) Set the values and throws are events associated to the changed values.
void	setViewCollectionElementAction(java.lang.String viewCollectionElementAction)
void	setViewName(java.lang.String newView)
void	setViewObject(java.lang.String viewObject) The name of this view as session object.
boolean	throwsPropertyChanged(MetaProperty p)
boolean	throwsPropertyChanged(java.lang.String propertyName)
boolean	throwsReferenceChanged(MetaReference ref)
java.lang.String	toString()
boolean	trySetValue(java.lang.String name, java.lang.Object value) Try to set the value to the indicated member.

Methods inherited from class java.lang.Object

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

Constructor Detail

View

public View()

Method Detail

getMetaMembers

public java.util.Collection getMetaMembers()
                                    throws XavaException

Throws:

XavaException

setMetaMembers

public void setMetaMembers(java.util.Collection metaMembers)

getMetaModel

public MetaModel getMetaModel()
                       throws XavaException

Throws:

XavaException

getValues

public java.util.Map getValues()
                        throws XavaException

Copy of the values showed in view.

It's a copy, if you change it the displayed data is not changed. If you wish change displayed data you have to use setValues or setValue.

Throws:

XavaException

getAllValues

public java.util.Map getAllValues()
                           throws XavaException

Copy of all values showed in view.

It's a copy, if you change it the displayed data is not changed. If you wish change displayed data you have to use setValues or setValue.

Throws:

XavaException

addValues

public void addValues(java.util.Map map)
               throws XavaException

Throws:

XavaException

setValues

public void setValues(java.util.Map map)
               throws XavaException

Throws:

XavaException

setValuesExecutingOnChangeActions

public void setValuesExecutingOnChangeActions(java.util.Map values)
                                       throws XavaException

Set the values and execute the on-change actions associated to the assigned properties.

Throws:

XavaException

setValuesNotifying

public void setValuesNotifying(java.util.Map values)
                        throws XavaException

Set the values and throws are events associated to the changed values.

Throws:

XavaException

getValue

public java.lang.Object getValue(java.lang.String name)
                          throws XavaException

Parameters:

name - Qualified properties are allowed

Throws:

XavaException

getValueInt

public int getValueInt(java.lang.String name)
                throws XavaException

Parameters:

name - Qualified properties are allowed

Throws:

XavaException

getValueString

public java.lang.String getValueString(java.lang.String name)
                                throws XavaException

Parameters:

name - Qualified properties are allowed

Throws:

XavaException

getSubview

public View getSubview(java.lang.String name)
                throws XavaException

Throws:

XavaException

getGroupView

public View getGroupView(java.lang.String name)
                  throws XavaException

Throws:

XavaException

setValueNotifying

public void setValueNotifying(java.lang.String name,
                              java.lang.Object value)
                       throws ElementNotFoundException,
                              XavaException

Set the value and notifies the property change, recalculating all dependent properties.

Parameters:

name - Can be qualified

Throws:

ElementNotFoundException

XavaException

setValue

public void setValue(java.lang.String name,
                     java.lang.Object value)
              throws XavaException

Set the value to the indicated member.

If member is not of this view an exception is thrown.

Parameters:

name - Can be qualified

Throws:

XavaException - If name is not a displayed member of this view.

trySetValue

public boolean trySetValue(java.lang.String name,
                           java.lang.Object value)
                    throws XavaException

Try to set the value to the indicated member.

If member does not exist in view, returns false, but it does not throw exception.

Parameters:

name - Can be qualified

Returns:

true if member exists and it's updated, false otherwise.

Throws:

XavaException

setSectionEditable

public void setSectionEditable(java.lang.String sectionName,
                               boolean editable)
                        throws XavaException

Throws:

XavaException

isSectionEditable

public boolean isSectionEditable(java.lang.String sectionName)
                          throws XavaException

Throws:

XavaException

getKeyValuesWithValue

public java.util.Map getKeyValuesWithValue()
                                    throws XavaException

Excludes those values that are null, zero or empty string.

Throws:

XavaException

getKeyValues

public java.util.Map getKeyValues()
                           throws XavaException

Throws:

XavaException

getMembersNamesWithHidden

public java.util.Map getMembersNamesWithHidden()
                                        throws XavaException

Throws:

XavaException

getMembersNames

public java.util.Map getMembersNames()
                              throws XavaException

Throws:

XavaException

getCalculatedPropertiesNames

public java.util.Map getCalculatedPropertiesNames()
                                           throws XavaException

Throws:

XavaException

getCollectionTab

public Tab getCollectionTab()
                     throws XavaException

Tab used for manage the data of this collection.

This view must represents a collection in order to call this method.

Throws:

XavaException

getCollectionValues

public java.util.List getCollectionValues()
                                   throws XavaException

A list of all collection element when each element is a map with the values of the collection element.

In order to call this method this view must represents a collection.

The values only include the displayed data in the row.

Returns:

Of type Map. Never null.

Throws:

XavaException

getCollectionSelectedValues

public java.util.List getCollectionSelectedValues()
                                           throws XavaException

A list of selected collection element when each element is a map with the values of the collection element.

In order to call this method this view must represents a collection.

The values only include the displayed data in the row.

Returns:

Of type Map. Never null.

Throws:

XavaException

getCollectionObjects

public java.util.List getCollectionObjects()
                                    throws XavaException

A list of all objects (POJOs or EntityBeans) in the collection.

In order to call this method this view must represents a collection.

Generally the objects are POJOs, although if you use EJBPersistenceProvider the they will be EntityBeans (of EJB2).

Returns:

Never null.

Throws:

XavaException

getCollectionSelectedObjects

public java.util.List getCollectionSelectedObjects()
                                            throws XavaException

A list of selected objects (POJOs or EntityBeans) in the collection.

In order to call this method this view must represents a collection.

Generally the objects are POJOs, although if you use EJBPersistenceProvider the they will be EntityBeans (of EJB2).

Returns:

Never null.

Throws:

XavaException

isCollectionCalculated

public boolean isCollectionCalculated()
                               throws XavaException

If the collection represents by this view is calculated.

In order to call this method this view must represents a collection.

Throws:

XavaException

isDetailMemberInCollection

public boolean isDetailMemberInCollection()
                                   throws XavaException

Throws:

XavaException

reset

public void reset()
           throws XavaException

Clear all data and set the default values.

Throws:

XavaException

clear

public void clear()
           throws XavaException

Clear all displayed data.

Throws:

XavaException

isKeyEditable

public boolean isKeyEditable()

setKeyEditable

public void setKeyEditable(boolean b)
                    throws XavaException

Throws:

XavaException

isEditable

public boolean isEditable(MetaProperty metaProperty)

If at this moment is editable.

isEditable

public boolean isEditable(MetaReference metaReference)

If at this moment is editable.

isEditable

public boolean isEditable(java.lang.String member)
                   throws XavaException

Throws:

XavaException

setEditable

public void setEditable(java.lang.String name,
                        boolean editable)
                 throws XavaException

Throws:

XavaException

isEditable

public boolean isEditable()

setEditable

public void setEditable(boolean b)
                 throws XavaException

Throws:

XavaException

getModelName

public java.lang.String getModelName()

setModelName

public void setModelName(java.lang.String newModel)

assignValuesToWebView

public void assignValuesToWebView()

assignValuesToWebView

public void assignValuesToWebView(java.lang.String qualifier)

throwsPropertyChanged

public boolean throwsPropertyChanged(MetaProperty p)

throwsPropertyChanged

public boolean throwsPropertyChanged(java.lang.String propertyName)
                              throws XavaException

Throws:

XavaException

isFirstPropertyAndViewHasNoKeys

public boolean isFirstPropertyAndViewHasNoKeys(MetaProperty pr)
                                        throws XavaException

Throws:

XavaException

hasKeyProperties

public boolean hasKeyProperties()
                         throws XavaException

Throws:

XavaException

findObject

public void findObject()
                throws java.lang.Exception

Using the key values loaded in the view search the rest of the data from persistent storage and fill the view.

Throws:

java.lang.Exception

findObject

public void findObject(MetaProperty changedProperty)
                throws java.lang.Exception

Using the key values loaded in the view search the rest of the data from persistent storage and fill the view.

Parameters:

changedProperty - Property which change produces the search.

Throws:

java.lang.Exception

refresh

public void refresh()

Refresh the displayed data from database.

getPropertiesNamesFromStereotypesList

public java.util.Collection getPropertiesNamesFromStereotypesList(java.lang.String stereotypesList)
                                                           throws XavaException

Parameters:

stereotypesList - Comma separated

Throws:

XavaException

getMetaProperties

public java.util.List getMetaProperties()
                                 throws XavaException

Throws:

XavaException

getMetaProperty

public MetaProperty getMetaProperty(java.lang.String name)
                             throws XavaException

Throws:

XavaException

getMetaReference

public MetaReference getMetaReference(java.lang.String name)
                               throws XavaException

Throws:

XavaException

getMetaPropertiesList

public java.util.Collection getMetaPropertiesList()
                                           throws XavaException

Throws:

XavaException

getPropertiesNamesFromPropertiesList

public java.util.Collection getPropertiesNamesFromPropertiesList(java.lang.String propertiesList)
                                                          throws XavaException

Parameters:

propertiesList - Properties names comma separated

Throws:

XavaException

getViewName

public java.lang.String getViewName()

setViewName

public void setViewName(java.lang.String newView)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isSubview

public boolean isSubview()

setSubview

public void setSubview(boolean b)

isRepresentsAggregate

public boolean isRepresentsAggregate()

setRepresentsAggregate

public void setRepresentsAggregate(boolean b)

getSearchAction

public java.lang.String getSearchAction()
                                 throws XavaException

Throws:

XavaException

isRepresentsCollection

public boolean isRepresentsCollection()

setRepresentsCollection

public void setRepresentsCollection(boolean b)

displayDetailInCollection

public boolean displayDetailInCollection(java.lang.String collectionName)
                                  throws XavaException

Throws:

XavaException

isCollectionDetailVisible

public boolean isCollectionDetailVisible()

setCollectionDetailVisible

public void setCollectionDetailVisible(boolean b)

getErrors

public Messages getErrors()

getMessages

public Messages getMessages()

setErrors

public void setErrors(Messages messages)

setMessages

public void setMessages(Messages messages)
                 throws XavaException

Throws:

XavaException

getRequest

public HttpServletRequest getRequest()

setRequest

public void setRequest(HttpServletRequest request)
                throws XavaException

Throws:

XavaException

displayAsDescriptionsList

public boolean displayAsDescriptionsList(MetaReference ref)
                                  throws XavaException

Throws:

XavaException

getDescriptionPropertyInDescriptionsList

public java.lang.String getDescriptionPropertyInDescriptionsList(MetaReference ref)
                                                          throws XavaException

Throws:

XavaException

getDescriptionPropertiesInDescriptionsList

public java.lang.String getDescriptionPropertiesInDescriptionsList(MetaReference ref)
                                                            throws XavaException

Throws:

XavaException

throwsReferenceChanged

public boolean throwsReferenceChanged(MetaReference ref)
                               throws XavaException

Throws:

XavaException

getParameterValuesPropertiesInDescriptionsList

public java.lang.String getParameterValuesPropertiesInDescriptionsList(MetaReference ref)
                                                                throws XavaException

Throws:

XavaException

getConditionInDescriptionsList

public java.lang.String getConditionInDescriptionsList(MetaReference ref)
                                                throws XavaException

Throws:

XavaException

getOrderInDescriptionsList

public java.lang.String getOrderInDescriptionsList(MetaReference ref)
                                            throws XavaException

Throws:

XavaException

isOrderByKeyInDescriptionsList

public boolean isOrderByKeyInDescriptionsList(MetaReference ref)
                                       throws XavaException

Throws:

XavaException

isCreateNewForReference

public boolean isCreateNewForReference(MetaReference ref)
                                throws XavaException

Throws:

XavaException

isModifyForReference

public boolean isModifyForReference(MetaReference ref)
                             throws XavaException

Throws:

XavaException

isSearchForReference

public boolean isSearchForReference(MetaReference ref)
                             throws XavaException

Throws:

XavaException

isCreateNew

public boolean isCreateNew()
                    throws XavaException

Throws:

XavaException

isModify

public boolean isModify()
                 throws XavaException

Throws:

XavaException

isSearch

public boolean isSearch()
                 throws XavaException

Throws:

XavaException

isLastSearchKey

public boolean isLastSearchKey(java.lang.String propertyName)
                        throws XavaException

Throws:

XavaException

isLastSearchKey

public boolean isLastSearchKey(MetaProperty p)
                        throws XavaException

Throws:

XavaException

isHidden

public boolean isHidden(java.lang.String name)

setHidden

public void setHidden(java.lang.String name,
                      boolean hidden)
               throws XavaException

Throws:

XavaException

getParent

public View getParent()

getRoot

public View getRoot()

hasSections

public boolean hasSections()
                    throws XavaException

Throws:

XavaException

getSections

public java.util.List getSections()
                           throws XavaException

Throws:

XavaException

getSectionView

public View getSectionView(int index)
                    throws XavaException

Throws:

XavaException

isSection

public boolean isSection()

setSection

public void setSection(boolean b)

getActiveSection

public int getActiveSection()
                     throws XavaException

Throws:

XavaException

setActiveSection

public void setActiveSection(int i)

getCollectionEditingRow

public int getCollectionEditingRow()

setCollectionEditingRow

public void setCollectionEditingRow(int i)

getMemberName

public java.lang.String getMemberName()

setMemberName

public void setMemberName(java.lang.String string)
                   throws XavaException

Throws:

XavaException

isCollectionMembersEditables

public boolean isCollectionMembersEditables()

setCollectionMembersEditables

public void setCollectionMembersEditables(boolean b)

isCollectionEditable

public boolean isCollectionEditable()

setCollectionEditable

public void setCollectionEditable(boolean b)

isRepresentsEntityReference

public boolean isRepresentsEntityReference()

setRepresentsEntityReference

public void setRepresentsEntityReference(boolean b)

getActionsNamesDetail

public java.util.Collection getActionsNamesDetail()

Has sense if the subview represents a collection, although always works.

setActionsNamesDetail

public void setActionsNamesDetail(java.util.Collection collection)

Has sense if the subview represents a collection, although always works.

addDetailAction

public void addDetailAction(java.lang.String qualifiedActionName)

Has sense if the subview represents a collection, although always works.

Parameters:

qualifiedActionName - Qualified name (controller.action) as in controllers.xml

removeDetailAction

public void removeDetailAction(java.lang.String qualifiedActionName)

Has sense if the subview represents a collection, although always works.

Parameters:

qualifiedActionName - Qualified name (controller.action) as in controllers.xml

addListAction

public void addListAction(java.lang.String qualifiedActionName)

Has sense if the subview represents a collection, although always works.

Parameters:

qualifiedActionName - Qualified name (controller.actio