DefaultValidationResultsModel (Spring Rich Client 1.1.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.binding.validation.support
Class DefaultValidationResultsModel

Show UML class diagram

java.lang.Object
  org.springframework.binding.validation.support.DefaultValidationResultsModel

All Implemented Interfaces:: PropertyChangeListener, EventListener, ValidationListener, ValidationResults, ValidationResultsModel, PropertyChangePublisher

public class DefaultValidationResultsModel
extends Object
implements ValidationResultsModel, ValidationListener, PropertyChangeListener
extends Object
implements ValidationResultsModel, ValidationListener, PropertyChangeListener

Default implementation of ValidationResultsModel. Several events are fired when validationResults are set and can be tracked by registering the appropriate listener.

You can register listeners on:

Changes of the ValidationResults in general. (addValidationListener(ValidationListener))
Changes of validationResults concerning a specific property of the FormModel. (addValidationListener(String, ValidationListener))
Specific events concerning errors, warnings and info. (#addPropertyChangeListener(String, PropertyChangeListener) with one of: ValidationResultsModel#HAS_ERRORS_PROPERTY, ValidationResultsModel#HAS_INFO_PROPERTY or ValidationResultsModel#HAS_WARNINGS_PROPERTY)

A child-parent relation can be used to bundle events and results. A listener set on a parent will receive events originating from the child and when polling for messages, childMessages will be available as well. This makes it possible to efficiently couple formModels and their validation aspect and provides a means to bundle validation reporting. When eg using a {@link org.springframework.richclient.form.ValidationResultsReporter}, you have the opportunity to bundle results from various unrelated formModels to report to one end point.

Example:

 DefaultFormModel formModelA = ...
 DefaultFormModel formModelChildOfA = ...
 formModelA.addChild(formModelChildOfA);
 
 DefaultFormModel formModelB = ...
 
 \\ At this stage, the ValidationResultsModel of formModelChildOfA will route results & 
 \\ events to the ValidationResultsModel of formModelA
 
 DefaultValidationResultsModel container = new DefaultValidationResultsModel();
 container.add(formModelA.getValidationResults());
 container.add(formModelB.getValidationResults());
 
 new SimpleValidationResultsReporter(container, messagable);
 
 \\ the reporter will now receive events & results of all formModels and can show messages of each of them

Author:: Oliver Hutchison, Jan Hoskens
See Also:: DefaultFormModel.addChild(org.springframework.binding.form.HierarchicalFormModel), SimpleValidationResultsReporter

Field Summary

Fields inherited from interface org.springframework.binding.validation.ValidationResultsModel
`HAS_ERRORS_PROPERTY, HAS_INFO_PROPERTY, HAS_WARNINGS_PROPERTY`

Constructor Summary
`DefaultValidationResultsModel()` Constructor without delegate.
`DefaultValidationResultsModel(ValidationResultsModel delegateFor)` Constructor with delegate.

Method Summary
`void`	`add(ValidationResultsModel validationResultsModel)` Add a validationResultsModel as a child to this one.
`void`	`addMessage(ValidationMessage validationMessage)`
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Register a listener to all properties of this publisher.
`void`	`addPropertyChangeListener(String propertyName, PropertyChangeListener listener)` Register a listener to a specific property.
`void`	`addValidationListener(String propertyName, ValidationListener listener)` Adds a listener that will be notified when there is any change to the set validation messages for the specified property.
`void`	`addValidationListener(ValidationListener listener)` Adds a listener that will be notified when there is any change to the set of validation messages.
`void`	`clearAllValidationResults()`
`protected void`	`fireChangedEvents()`
`protected void`	`firePropertyChange(String propertyName, boolean oldValue, boolean newValue)`
`protected void`	`fireValidationResultsChanged()`
`protected void`	`fireValidationResultsChanged(String propertyName)`
`boolean`	`getHasErrors()` Returns `true` of there are any validation messages of `Severity.ERROR`.
`boolean`	`getHasInfo()` Returns `true` of there are any validation messages of `Severity.INFO`.
`boolean`	`getHasWarnings()` Returns `true` of there are any validation messages of `Severity.WARNING`.
`int`	`getMessageCount()` Returns the total number of validation messages.
`int`	`getMessageCount(Severity severity)` Returns the total number of validation messages of the specified Severity.
`int`	`getMessageCount(String propertyName)` Returns the total number of validation messages that apply to the specified property name.
`Set`	`getMessages()` Returns a set holding all of the validation messages.
`Set`	`getMessages(Severity severity)` Returns a set holding all of the validation messages of the specified Severity.
`Set`	`getMessages(String propertyName)` Returns a set holding all of the validation messages that apply to the specified property name.
`protected EventListenerListHelper`	`getPropertyChangeListeners(String propertyName)`
`protected EventListenerListHelper`	`getValidationListeners(String propertyName)`
`void`	`propertyChange(PropertyChangeEvent evt)` Forwarding of known property events coming from child models.
`void`	`remove(ValidationResultsModel validationResultsModel)` Remove the given validationResultsModel from the list of children.
`void`	`removeMessage(ValidationMessage validationMessage)`
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Remove the listener from all properties of this publisher.
`void`	`removePropertyChangeListener(String propertyName, PropertyChangeListener listener)` Remove the listener from a specific property.
`void`	`removeValidationListener(String propertyName, ValidationListener listener)` Removes the provided validation listener.
`void`	`removeValidationListener(ValidationListener listener)` Removes the provided validation listener.
`void`	`replaceMessage(ValidationMessage messageToReplace, ValidationMessage replacementMessage)`
`String`	`toString()`
`void`	`updateValidationResults(ValidationResults newValidationResults)`
`void`	`validationResultsChanged(ValidationResults results)` `DefaultValidationResultsModel` registers itself as a validationListener on it's children to forward the event.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

DefaultValidationResultsModel

public DefaultValidationResultsModel()

Constructor without delegate. (Delegating for 'this').

DefaultValidationResultsModel

public DefaultValidationResultsModel(ValidationResultsModel delegateFor)

Constructor with delegate.

Parameters:: delegateFor - delegate object.

Method Detail

updateValidationResults

public void updateValidationResults(ValidationResults newValidationResults)

addMessage

public void addMessage(ValidationMessage validationMessage)

removeMessage

public void removeMessage(ValidationMessage validationMessage)

replaceMessage

public void replaceMessage(ValidationMessage messageToReplace,
                           ValidationMessage replacementMessage)