org.jminor.common.model.valuemap

Class DefaultValueMapEditModel<K,V>

java.lang.Object

org.jminor.common.model.valuemap.DefaultValueMapEditModel<K,V>

Type Parameters:

K - the type of the value map keys

V - the type of values in this map

All Implemented Interfaces:

ValueMapEditModel<K,V>

Direct Known Subclasses:

DefaultEntityEditModel

public class DefaultValueMapEditModel<K,V>
extends java.lang.Object
implements ValueMapEditModel<K,V>

A default ValueMapEditModel implementation, handling value change events and validation

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultValueMapEditModel(ValueMap<K,V> valueMap, ValueMap.Validator validator)

Method Summary

Modifier and Type	Method and Description
void	addValueListener(K key, EventDataListener<ValueChange<K,V>> listener) Adds a listener notified each time the value associated with the given key changes
void	addValueSetListener(K key, EventDataListener<ValueChange<K,V>> listener) Adds a listener notified each time the value associated with the given key is set via ValueMapEditModel.put(Object, Object), note that this event is only fired when the the value changes
V	get(K key) Returns the value associated with the given key in the underlying value map
ValueMap.Validator	getValidator()
StateObserver	getValidObserver()
protected ValueMap<K,V>	getValueMap()
EventObserver<ValueChange<K,V>>	getValueObserver()
EventObserver<ValueChange<K,V>>	getValueObserver(K key)
boolean	isNotNull(K key)
boolean	isNull(K key)
boolean	isNullable(K key)
boolean	isValid()
boolean	isValid(K key) Returns true if the value associated with the given key is valid, using the validate method
void	put(K key, V value) Sets the given value in the underlying value map
V	remove(K key) Removes the given value from the map
void	removeValueListener(K key, EventDataListener listener)
void	removeValueSetListener(K key, EventDataListener listener)
void	validate() Validates the current state of the ValueMap
void	validate(java.util.Collection<? extends ValueMap<K,V>> valueMaps) Validates the given ValueMaps
void	validate(K key) Checks if the value associated with the given key is valid, throws a ValidationException if not
void	validate(ValueMap<K,V> valueMap) Validates the current state of the given ValueMap

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultValueMapEditModel

protected DefaultValueMapEditModel(ValueMap<K,V> valueMap,
                                   ValueMap.Validator validator)

Parameters:

valueMap - the ValueMap to edit

validator - the validator

Method Detail

get

public final V get(K key)

Returns the value associated with the given key in the underlying value map

Specified by:

get in interface ValueMapEditModel<K,V>

Parameters:

key - the key of the value to retrieve

Returns:

the value associated with the given key

put

public final void put(K key,
                      V value)

Sets the given value in the underlying value map

Specified by:

put in interface ValueMapEditModel<K,V>

Parameters:

key - the key to associate the given value with

value - the value to associate with the given key

remove

public final V remove(K key)

Removes the given value from the map

Specified by:

remove in interface ValueMapEditModel<K,V>

Parameters:

key - the key associated with the value to remove

Returns:

the value, if any

isNullable

public final boolean isNullable(K key)

Specified by:

isNullable in interface ValueMapEditModel<K,V>

Parameters:

key - the key

Returns:

true if this value is allowed to be null in the underlying value map

isNull

public final boolean isNull(K key)

Specified by:

isNull in interface ValueMapEditModel<K,V>

Parameters:

key - the key

Returns:

true if the value of the given key is null

isNotNull

public boolean isNotNull(K key)

Specified by:

isNotNull in interface ValueMapEditModel<K,V>

Parameters:

key - the key

Returns:

true if the value of the given key is not null

getValidObserver

public final StateObserver getValidObserver()

Specified by:

getValidObserver in interface ValueMapEditModel<K,V>

Returns:

a StateObserver indicating the valid status of the underlying value map

See Also:

ValueMapEditModel.getValidator(), ValueMapEditModel.isValid()

isValid

public final boolean isValid()

Specified by:

isValid in interface ValueMapEditModel<K,V>

Returns:

true if the underlying value map contains only valid values

See Also:

ValueMapEditModel.getValidObserver()

validate

public final void validate(K key)
                    throws ValidationException

Checks if the value associated with the given key is valid, throws a ValidationException if not

Specified by:

validate in interface ValueMapEditModel<K,V>

Parameters:

key - the key the value is associated with

Throws:

ValidationException - if the given value is not valid for the given key

validate

public final void validate()
                    throws ValidationException

Validates the current state of the ValueMap

Specified by:

validate in interface ValueMapEditModel<K,V>

Throws:

ValidationException - in case the ValueMap is invalid

validate

public final void validate(ValueMap<K,V> valueMap)
                    throws ValidationException

Validates the current state of the given ValueMap

Specified by:

validate in interface ValueMapEditModel<K,V>

Parameters:

valueMap - the ValueMap to validate

Throws:

ValidationException - in case the ValueMap is invalid

validate

public final void validate(java.util.Collection<? extends ValueMap<K,V>> valueMaps)
                    throws ValidationException

Validates the given ValueMaps

Specified by:

validate in interface ValueMapEditModel<K,V>

Parameters:

valueMaps - the value maps to validate

Throws:

ValidationException - on finding the first invalid ValueMap

isValid

public final boolean isValid(K key)

Returns true if the value associated with the given key is valid, using the validate method

Specified by:

isValid in interface ValueMapEditModel<K,V>

Parameters:

key - the key the value is associated with

Returns:

true if the value is valid

See Also:

ValueMapEditModel.validate(Object), ValueMap.Validator#validate(ValueMap)

getValidator

public final ValueMap.Validator getValidator()

Specified by:

getValidator in interface ValueMapEditModel<K,V>

Returns:

the validator

getValueObserver

public final EventObserver<ValueChange<K,V>> getValueObserver()

Specified by:

getValueObserver in interface ValueMapEditModel<K,V>

Returns:

an EventObserver notified each time a value changes

getValueObserver

public final EventObserver<ValueChange<K,V>> getValueObserver(K key)

Specified by:

getValueObserver in interface ValueMapEditModel<K,V>

Parameters:

key - the key for which to retrieve the event

Returns:

an EventObserver notified when the value of key changes

addValueSetListener

public final void addValueSetListener(K key,
                                      EventDataListener<ValueChange<K,V>> listener)

Adds a listener notified each time the value associated with the given key is set via ValueMapEditModel.put(Object, Object), note that this event is only fired when the the value changes

Specified by:

addValueSetListener in interface ValueMapEditModel<K,V>

Parameters:

key - the key for which to monitor value changes

listener - a listener notified each time the value of key is set via this model

removeValueSetListener

public final void removeValueSetListener(K key,
                                         EventDataListener listener)

Specified by:

removeValueSetListener in interface ValueMapEditModel<K,V>

Parameters:

key - the key

listener - the listener to remove

addValueListener

public final void addValueListener(K key,
                                   EventDataListener<ValueChange<K,V>> listener)

Adds a listener notified each time the value associated with the given key changes

Specified by:

addValueListener in interface ValueMapEditModel<K,V>

Parameters:

key - the key for which to monitor value changes

listener - a listener notified each time the value of key changes

removeValueListener

public final void removeValueListener(K key,
                                      EventDataListener listener)

Specified by:

removeValueListener in interface ValueMapEditModel<K,V>

Parameters:

key - the key

listener - the listener to remove

getValueMap

protected final ValueMap<K,V> getValueMap()

Returns:

the underlying ValueMap object