ValueTypeImpl (CrNiCKL database 2.0.0 API)

java.lang.Object
- ch.agent.crnickl.impl.DBObjectImpl
- - ch.agent.crnickl.impl.ValueTypeImpl<T>

Type Parameters:

T - the underlying data type of the values

All Implemented Interfaces:

DBObject, ValueType<T>

Direct Known Subclasses:

UpdatableValueTypeImpl
```
public class ValueTypeImpl<T>
extends DBObjectImpl
implements ValueType<T>
```
Default implementation of ValueType. In agreement with the convention mentioned in the ValueScanner class comment, the value type is passed to value scanner constructors when such constructors are available.

Author:

Jean-Paul Vetterli

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ValueTypeImpl.BooleanScanner` A value scanner for boolean data.
`static class`	`ValueTypeImpl.DateScanner` A value scanner for data representing `Day`s.
`static class`	`ValueTypeImpl.DateTimeScanner` A value scanner for data representing `DateTime`s.
`static class`	`ValueTypeImpl.NameScanner` A value scanner for textual data representing simple names.
`static class`	`ValueTypeImpl.NumberScanner` A value scanner for numeric data.
`static class`	`ValueTypeImpl.TextScanner` A value scanner for textual data.
`static class`	`ValueTypeImpl.TimeDomainScanner` A value scanner for data representing `TimeDomain`s.
`static class`	`ValueTypeImpl.TypeScanner` A value scanner for data representing `ValueType`s.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ValueTypeImpl(String name, boolean restricted, String scannerClassOrKeyword, Map<String,String> valuesAndDescriptions, Surrogate surrogate)` Construct a `ValueType`.
`protected`	`ValueTypeImpl(ValueTypeImpl<T> valueType)` This constructor is intended for `UpdatableValueTypeImpl` when implementing the `edit()` method.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`check(T value)` Check that the value is allowed.
`UpdatableValueType<T>`	`edit()` Return an `UpdatableValueType` corresponding to this value type.
`<S> ValueAccessMethods<T>`	`getAccessMethods()` Return the value access methods object for this type.
`String`	`getExternalRepresentation()` Return a string providing an external representation of the value type.
`String`	`getName()` Return the name of the value type.
`ValueScanner<T>`	`getScanner()` Return the value scanner.
`ValueType.StandardValueType`	`getStandardValueType()` Return the constant representing the value type when it is a built-in value type.
`Class<T>`	`getType()` Return the class of the underlying data 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.
`Collection<String>`	`getValues(String format)` Return values and descriptions as a collection of formatted strings.
`boolean`	`isBuiltIn()` Deprecated.
`boolean`	`isCompatible(Object obj)` Returns true if the object can be assigned to a variable of the underlying data type.
`boolean`	`isRestricted()` Return true if the value type maintains an exhaustive list of allowed values.
`T`	`scan(String value)` Convert the argument to an object of the underlying data type.
`String`	`toString()`
`String`	`toString(Object value)` Convert the argument to a string.
`<S> ValueType<S>`	`typeCheck(Class<S> type)` Cast the value type to the type specified.
`protected void`	`update()` Refresh state.

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.DBObject
getDatabase, getId, getSurrogate, inConstruction, isValid

- Constructor Detail
  - ValueTypeImpl
```
protected ValueTypeImpl(ValueTypeImpl<T> valueType)
                 throws T2DBException
```
    This constructor is intended for UpdatableValueTypeImpl when implementing the edit() method.
    
    Parameters:
    
    valueType -
    
    Throws:
    
    T2DBException
  - ValueTypeImpl
```
public ValueTypeImpl(String name,
                     boolean restricted,
                     String scannerClassOrKeyword,
                     Map<String,String> valuesAndDescriptions,
                     Surrogate surrogate)
              throws T2DBException
```
    Construct a ValueType.
    
    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
```
    Refresh state.
    
    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>
    
    Returns:
    
    an updatable value type corresponding to this value type
  - getAccessMethods
```
public <S> ValueAccessMethods<T> getAccessMethods()
                                           throws T2DBException
```
    Return the value access methods object for this type. The value type object plays the role of a cache for the value access method object, which is expensive to construct.
    
    Returns:
    
    a value access methods object
    
    Throws:
    
    T2DBException
  - getName
```
public String getName()
```
    Description copied from interface: ValueType
    
    Return the name of the value type.
    
    Specified by:
    
    getName in interface ValueType<T>
    
    Returns:
    
    the name of the value type
  - isRestricted
```
public boolean isRestricted()
```
    Description copied from interface: ValueType
    
    Return true if the value type maintains an exhaustive list of allowed values.
    
    Specified by:
    
    isRestricted in interface ValueType<T>
    
    Returns:
    
    true if the value type has a list of allowed values
  - isBuiltIn
```
@Deprecated
public boolean isBuiltIn()
```
    Deprecated.
    
    Description copied from interface: ValueType
    
    This method is obsolete and always return false.
    
    Specified by:
    
    isBuiltIn in interface ValueType<T>
    
    Returns:
    
    false
  - getType
```
public Class<T> getType()
```
    Description copied from interface: ValueType
    
    Return the class of the underlying data type.
    
    Specified by:
    
    getType in interface ValueType<T>
    
    Returns:
    
    the class of the underlying data type
  - getScanner
```
public ValueScanner<T> getScanner()
```
    Description copied from interface: ValueType
    
    Return the value scanner.
    
    Specified by:
    
    getScanner in interface ValueType<T>
    
    Returns:
    
    the value scanner
  - 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>
    
    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>
    
    Returns:
    
    a map with values and their descriptions
  - isCompatible
```
public boolean isCompatible(Object obj)
```
    Description copied from interface: ValueType
    
    Returns true if the object can be assigned to a variable of the underlying data type. The method is provided because the instanceof operator cannot be used with generics. The method does not check if the value is allowed. Use ValueType.check(T) for that.
    
    Specified by:
    
    isCompatible in interface ValueType<T>
    
    Parameters:
    
    obj - an object
    
    Returns:
    
    true if the object can be assigned to a variable of the underlying data type
  - scan
```
public T scan(String value)
       throws T2DBException
```
    Description copied from interface: ValueType
    
    Convert the argument to an object of the underlying data type. Throw an exception if the argument cannot be converted. A null is converted to a null. An empty value is converted to a null, unless the value type is restricted. When the value type is restricted, it must be capable of scanning and converting the empty string, and the result of the conversion must be present in the set of allowed values.
    
    Specified by:
    
    scan in interface ValueType<T>
    
    Parameters:
    
    value - a string
    
    Returns:
    
    the value converted to the value type's underlying data type
    
    Throws:
    
    T2DBException
  - check
```
public void check(T value)
           throws T2DBException
```
    Description copied from interface: ValueType
    
    Check that the value is allowed. Throw an exception if a set of allowed values is defined and the value is not in the set.
    
    Specified by:
    
    check in interface ValueType<T>
    
    Parameters:
    
    value - a value
    
    Throws:
    
    T2DBException
  - toString
```
public String toString(Object value)
                throws T2DBException
```
    Description copied from interface: ValueType
    
    Convert the argument to a string. An exception is thrown if the value is illegal for the value type. For example if the scanner actual type is Integer, and the scanner requires positive numbers, a negative or zero value will result in an exception. With most scanners, a null value is converted to a null result.
    
    Specified by:
    
    toString in interface ValueType<T>
    
    Parameters:
    
    value - a value
    
    Returns:
    
    the value converted to a string
    
    Throws:
    
    T2DBException
  - getValues
```
public Collection<String> getValues(String format)
```
    Description copied from interface: ValueType
    
    Return values and descriptions as a collection of formatted strings. If a value has no description, simply convert it to a string. If a value has a description, use the format parameter, which is expected to include two %s fields. If the format is null, use a built-in format.
    
    Specified by:
    
    getValues in interface ValueType<T>
    
    Parameters:
    
    format - a format
    
    Returns:
    
    a collection of formatter values and descriptions
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getExternalRepresentation
```
public String getExternalRepresentation()
```
    Description copied from interface: ValueType
    
    Return a string providing an external representation of the value type. This is either the string value of the standard value type or the name of the value scanner class.
    
    Specified by:
    
    getExternalRepresentation in interface ValueType<T>
    
    Returns:
    
    the external representation of the value type
  - getStandardValueType
```
public ValueType.StandardValueType getStandardValueType()
```
    Description copied from interface: ValueType
    
    Return the constant representing the value type when it is a built-in value type. Return null if the value type is not built-in.
    
    Specified by:
    
    getStandardValueType in interface ValueType<T>
    
    Returns:
    
    the constant representing the value type or null
  - typeCheck
```
public <S> ValueType<S> typeCheck(Class<S> type)
                           throws T2DBException
```
    Description copied from interface: ValueType
    
    Cast the value type to the type specified. The method performs type checking at run time and allows to catch type errors in controlled fashion.
    
    Specified by:
    
    typeCheck in interface ValueType<T>
    
    Parameters:
    
    type - the underlying type required
    
    Returns:
    
    the value type cast to the type specified
    
    Throws:
    
    T2DBException

Class ValueTypeImpl<T>

Nested Class Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueTypeImpl

ValueTypeImpl

Method Detail

update

edit

getAccessMethods

getName

isRestricted

isBuiltIn

getType

getScanner

getValues

getValueDescriptions

isCompatible

scan

check

toString

getValues

toString

getExternalRepresentation

getStandardValueType

typeCheck