dk.heick.properties.types

Class SequencePropertyType

java.lang.Object

dk.heick.properties.PropertyType<SequenceVO>

dk.heick.properties.types.SequencePropertyType

All Implemented Interfaces:

Serializable

public class SequencePropertyType
extends PropertyType<SequenceVO>

PropertyType that validates to a SequenceVO value.
It stores a long value, and returnes a SequenceVO object instance from where
you can get a getNextKey(), everytime the current value reached the number of
reserved keys it increments the stored value an saves it.

The type functions as an incrementing number. Like a primary key.
You are hereby ensured a unique key.

Note: Use this with care, but can be used for small applications, demos and test cases.
Note: The PropertyIO must be writable for the type be able to update the sequence value.

Constructor Example			Comments
Property<SequenceVO> A_PROPERTY= new Property<SequenceVO>("name", new SequencePropertyType());			Creates SequencePropertyType using DEFAULT_INCREMENTS (50) as key increments. No default value.
Property<SequenceVO> A_PROPERTY= new Property<SequenceVO>("name", new SequencePropertyType(80));			Creates SequencePropertyType using 80 as key increments. No default value.
Type of value(s)	Examples	Result	Comments
Valid	80	new Long(45789)	Validate successfully.
Valid	-125	new Long(-127)	Validate successfully.
Invalid	cow	null	Validate will throw an exception. The resulting value is null.
Invalid	«empty string»	null
Invalid	«empty string after trim»	null
Invalid	null	defaultValue OR null	Validate will throw an exception. Return default value if set, otherwise null.

Since:

1.1

Author:

Frederik Heick

See Also:

SequenceVO, SequenceVO.getNextKey(), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_INCREMENTS The default increments of stored keys [50].
static String	TYPE The type name string constant of SequencePropertyType.

Constructor Summary

Constructors

Constructor and Description
SequencePropertyType() Default constructor, with null as default value.
SequencePropertyType(Long increments) Constructor with increments, and null as default value.

Method Summary

Modifier and Type	Method and Description
Long	getIncrements() The positive value which the sequence will increment the stored value of the key, before it next will increment it.
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
void	setIncrements(Long increments) Sets the increments.
String	toString(String propertyName, SequenceVO t) Converts a typed to the string representation.
void	validateConstraints(String propertyName) A PropertyType can have some constraints here is where they are validated.
SequenceVO	validateValue(String propertyName, String value) Converts the string representation of to a typed value.

Methods inherited from class dk.heick.properties.PropertyType

equals, getDefaultValue, getDefaultValueAsString, getDefaultValueDescription, getDescription, getDescription, getInitializationPriority, getIo, getLogger, getTypeName, hasDefaultValue, isDefaultValueValid, postGetValueProcessing, setDefaultValue, setInitializationPriority, setIo, setTypedValue, setTypeName, toType, validate, validateNullType

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

The type name string constant of SequencePropertyType.

See Also:

Constant Field Values

DEFAULT_INCREMENTS

public static final long DEFAULT_INCREMENTS

The default increments of stored keys [50].

See Also:

Constant Field Values

Constructor Detail

SequencePropertyType

public SequencePropertyType()
                     throws NullPointerException

Default constructor, with null as default value.

Throws:

NullPointerException - if typeName is null which it is not.

See Also:

DEFAULT_INCREMENTS

SequencePropertyType

public SequencePropertyType(Long increments)

Constructor with increments, and null as default value.

Parameters:

increments - the positive value it shall increment the stored key each time it reaches its threshold. Must be equals or greater than one.

Throws:

NullPointerException - if typeName is null which it is not.

See Also:

DEFAULT_INCREMENTS

Method Detail

getIncrements

public Long getIncrements()

The positive value which the sequence will increment the stored value of the key, before it next will increment it.

Returns:

how must to increment the stored key every time it reaches the current stored value.

setIncrements

public void setIncrements(Long increments)

Sets the increments.

Parameters:

increments - the positive value it shall increment the stored key each time it reaches its threshold. Must be equals or greater than one.

toString

public String toString(String propertyName,
                       SequenceVO t)
                throws PropertyException

Description copied from class: PropertyType

Converts a typed to the string representation. This must be associative, so the string generate here will successful validate. This is enforced, so the converted string is sub sequencetially validate with the validate method. In some of the property sub types, this method is overridden to ensure above rule.

Overrides:

toString in class PropertyType<SequenceVO>

Parameters:

propertyName - the name of the property used for logging purposes.

t - the type T.

Returns:

The string representation of the type.

Throws:

PropertyException - if conversion failed in validation.

See Also:

PropertyType.validate(String, String)

getRestrictions

public List<String> getRestrictions()

Description copied from class: PropertyType

Gets a detailed description of the PropertyType with any constraints that might influence the validation.
This includes a description for the default value, if the default do not it self parse the validation of the type, the exception is appended to the description.

Specified by:

getRestrictions in class PropertyType<SequenceVO>

Returns:

the restrictions of the PropertyType as a list of strings.

validateValue

public SequenceVO validateValue(String propertyName,
                                String value)
                         throws PropertyException

Description copied from class: PropertyType

Converts the string representation of to a typed value.
Including validation of any restrictions the PropertyType might have.
See the individual property type class description for details on how it convert to a typed value.

IMPORTANT: This only validates the value not the constraints of the PropertyType, which is at this point assumed to be valid.

Specified by:

validateValue in class PropertyType<SequenceVO>

Parameters:

propertyName - the name of the property used for logging purposes. To uniquely identify the Property with validation issues.

value - the string representation of the property

Returns:

the typed converted value.

Throws:

PropertyException - if the conversion failed.

validateConstraints

public void validateConstraints(String propertyName)
                         throws PropertyException

Description copied from class: PropertyType

A PropertyType can have some constraints here is where they are validated.
The constraints of a PropertyType is always assumed to be valid, but what if they are not.
Example: What if you have define the MIN value to be larger than the MAX value. The result will be that no value will ever be validated successfully.
This is the method where we validate the constraints of a PropertyType before any value is actually validated.
Any many cases this will not be nessecary.
This method is call in Property.validate();

Overrides:

validateConstraints in class PropertyType<SequenceVO>

Parameters:

propertyName - the name of the property used for logging purposes, to identify the unique property which PropertyType has constraint issues.

Throws:

PropertyException - if the constraints have invalid/conflicting values.

See Also:

Property.validate()