ch.agent.crnickl.impl

Class UpdatableValueTypeImpl<T>

java.lang.Object

ch.agent.crnickl.impl.DBObjectImpl

ch.agent.crnickl.impl.ValueTypeImpl<T>

ch.agent.crnickl.impl.UpdatableValueTypeImpl<T>

Type Parameters:

T - the underlying data type of the values

All Implemented Interfaces:

DBObject, Updatable, UpdatableValueType<T>, ValueType<T>

public class UpdatableValueTypeImpl<T>
extends ValueTypeImpl<T>
implements UpdatableValueType<T>

Default implementation of UpdatableValueType.

Author:

Jean-Paul Vetterli

Nested Class Summary

Nested classes/interfaces inherited from class ch.agent.crnickl.impl.ValueTypeImpl

ValueTypeImpl.BooleanScanner, ValueTypeImpl.DateScanner, ValueTypeImpl.DateTimeScanner, ValueTypeImpl.NameScanner, ValueTypeImpl.NumberScanner, ValueTypeImpl.TextScanner, ValueTypeImpl.TimeDomainScanner, ValueTypeImpl.TypeScanner

Nested classes/interfaces inherited from interface ch.agent.crnickl.api.ValueType

ValueType.StandardValueType

Constructor Summary

Constructors

Modifier	Constructor and Description
	UpdatableValueTypeImpl(String name, boolean restricted, String scannerClassOrKeyword, Map<String,String> valuesAndDescriptions, Surrogate surrogate) Construct an UpdatableValueType.
protected	UpdatableValueTypeImpl(ValueTypeImpl<T> valueType) Construct an UpdatableValueType.

Method Summary

Modifier and Type	Method and Description
void	addValue(T value, String description) Add a value to list of allowed values.
void	applyUpdates() Apply pending updates.
void	deleteValue(T value) Delete a value from the list of allowed values.
void	destroy() Destroy the value type.
UpdatableValueType<T>	edit() Return an UpdatableValueType corresponding to this value type.
String	getName() Return the name of the value type.
Map<T,String>	getValueDescriptions() Return a map with allowed values as keys and a description for each value.
Set<T>	getValues() Return the set of allowed values.
void	setName(String name) Set the name of the value type.
protected void	update() Refresh state.
void	updateValue(T value, String description) Update the description of the given allowed value.

Methods inherited from class ch.agent.crnickl.impl.ValueTypeImpl

check, getAccessMethods, getExternalRepresentation, getScanner, getStandardValueType, getType, getValues, isBuiltIn, isCompatible, isRestricted, scan, toString, toString, typeCheck

Methods inherited from class ch.agent.crnickl.impl.DBObjectImpl

equals, getDatabase, getId, getSurrogate, hashCode, inConstruction, isValid

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.agent.crnickl.api.ValueType

check, getExternalRepresentation, getScanner, getStandardValueType, getType, getValues, isBuiltIn, isCompatible, isRestricted, scan, toString, typeCheck

Methods inherited from interface ch.agent.crnickl.api.DBObject

getDatabase, getId, getSurrogate, inConstruction, isValid

Constructor Detail

UpdatableValueTypeImpl

protected UpdatableValueTypeImpl(ValueTypeImpl<T> valueType)
                          throws T2DBException

Construct an UpdatableValueType. This constructor is meant for ValueTypeImpl.edit().

Parameters:

valueType - a value type

Throws:

T2DBException

UpdatableValueTypeImpl

public UpdatableValueTypeImpl(String name,
                              boolean restricted,
                              String scannerClassOrKeyword,
                              Map<String,String> valuesAndDescriptions,
                              Surrogate surrogate)
                       throws T2DBException

Construct an UpdatableValueType.

Parameters:

name - a string

restricted - if true the value type will keep a list of allowed values

scannerClassOrKeyword - a keyword identifying a standard value type of the name of a scanner class

valuesAndDescriptions - a map of allowed values (as strings) and their description

surrogate - a surrogate

Throws:

T2DBException

Method Detail

update

protected void update()
               throws T2DBException

Description copied from class: ValueTypeImpl

Refresh state.

Overrides:

update in class ValueTypeImpl<T>

Throws:

T2DBException

applyUpdates

public void applyUpdates()
                  throws T2DBException

Description copied from interface: Updatable

Apply pending updates. Any error, including lack of authorization, results in an exception being thrown. This method does not manage transactions nor does it impose transaction boundaries. The management of transactions using Database.commit() and Database.rollback() is the client's responsibility.

Specified by:

applyUpdates in interface Updatable

Throws:

T2DBException

edit

public UpdatableValueType<T> edit()

Description copied from interface: ValueType

Return an UpdatableValueType corresponding to this value type. Successfully getting an Updatable object does not imply that updates can be successfully applied.

Specified by:

edit in interface ValueType<T>

Overrides:

edit in class ValueTypeImpl<T>

Returns:

an updatable value type corresponding to this value type

getName

public String getName()

Description copied from interface: ValueType

Return the name of the value type.

Specified by:

getName in interface ValueType<T>

Overrides:

getName in class ValueTypeImpl<T>

Returns:

the name of the value type

setName

public void setName(String name)
             throws T2DBException

Description copied from interface: UpdatableValueType

Set the name of the value type.

Specified by:

setName in interface UpdatableValueType<T>

Parameters:

name - a string

Throws:

T2DBException

getValues

public Set<T> getValues()

Description copied from interface: ValueType

Return the set of allowed values. Returns an empty set when there is no restriction.

Specified by:

getValues in interface ValueType<T>

Overrides:

getValues in class ValueTypeImpl<T>

Returns:

the set of allowed values

getValueDescriptions

public Map<T,String> getValueDescriptions()

Description copied from interface: ValueType

Return a map with allowed values as keys and a description for each value. Descriptions can be null. Returns an empty map when values are not restricted.

Specified by:

getValueDescriptions in interface ValueType<T>

Overrides:

getValueDescriptions in class ValueTypeImpl<T>

Returns:

a map with values and their descriptions

addValue

public void addValue(T value,
                     String description)
              throws T2DBException

Description copied from interface: UpdatableValueType

Add a value to list of allowed values. This method can only be used if the value type is restricted.

Specified by:

addValue in interface UpdatableValueType<T>

Parameters:

value - a value

description - the value's description

Throws:

T2DBException

updateValue

public void updateValue(T value,
                        String description)
                 throws T2DBException

Description copied from interface: UpdatableValueType

Update the description of the given allowed value. This method can only be used if the value type is restricted.

Specified by:

updateValue in interface UpdatableValueType<T>

Parameters:

value - an allowed value

description - a string

Throws:

T2DBException

deleteValue

public void deleteValue(T value)
                 throws T2DBException

Description copied from interface: UpdatableValueType

Delete a value from the list of allowed values. This method can only be used if the value type is restricted. The operation fails if the value is in use, either as the default value of an attribute or as an actual attribute value.

Specified by:

deleteValue in interface UpdatableValueType<T>

Parameters:

value - the value to delete

Throws:

T2DBException

destroy

public void destroy()
             throws T2DBException

Description copied from interface: UpdatableValueType

Destroy the value type. The operation fails if the value type is in use.

Specified by:

destroy in interface UpdatableValueType<T>

Throws:

T2DBException