com.goldencode.p2j.ui.client.format

Class DatetimeFormat.DatetimeBuf

java.lang.Object

com.goldencode.p2j.ui.client.format.DisplayFormat.Presentation

com.goldencode.p2j.ui.client.format.DatetimeFormat.DatetimeBuf

Enclosing class:

DatetimeFormat

private class DatetimeFormat.DatetimeBuf
extends DisplayFormat.Presentation

Internal form of datetime data.

Field Summary

Fields

Modifier and Type	Field and Description
private char[][]	compBufs Buffers for datetime component digits.
private static char	SPACE Special value for an empty digit place.

Fields inherited from class com.goldencode.p2j.ui.client.format.DisplayFormat.Presentation

forFieldValue, presCursorPos, presInsertMode

Constructor Summary

Constructors

Constructor and Description
DatetimeBuf() Constructs default presentation used for clear operation.
DatetimeBuf(datetime varDatetime) Constructs presentation initialized with given datetime.

Method Summary

Modifier and Type	Method and Description
private void	assignAMComponent(char[] comp, int value, boolean upper) Fills the AMPM component with the computed value from current hours.
private boolean	assignComponent(char[] comp, int value, char leftPad, boolean sign) Fills the date/time component with the given value.
void	checkFormat() Checks format rules.
void	clear() Delete the screen value.
private void	clearComponent(char[] comp, int compIdx) Fills the date component with SPACE.
private void	completeComponent(char[][] newCompBufs, char[][] oldCompBufs, int compIndex) Completes datetime component.
boolean	deleteBack() Erases one symbol before the cursor position.
boolean	deleteCurrent() Erases one symbol in the cursor position.
private int	extractDateOrTimeComponent(char[] comp, boolean includeSign, int defVal) Calculates numeric value of the date component.
private int	extractYearComponent(char[][] comp) Calculates numeric value of the year.
boolean	finishEdit() Indicates completion of an edit.
private char[][]	initBuffers() Allocates datetime components buffers.
private void	initClear() Resets content to space value.
boolean	input(char ch) Inputs character.
boolean	isFixedFont() Determine if this format must use the DEFAULT-FIXED-FONT, if no font is specified.
boolean	isUnknown() Returns if the presentation currently represents the unknown value.
boolean	moveCursorBegin() Moves cursor to the beginning of the field.
boolean	moveCursorEnd() Moves cursor to the end of the field.
boolean	moveCursorLeft() Moves cursor one character to the left.
boolean	moveCursorRight() Moves cursor one character to the right.
private datetime	toDatetime() Returns the current presentation's value converted to datetime.
java.lang.String	toScreenValue() Formats the data as a string that is ready for display.
java.lang.String	toScreenValue(boolean edit) Formats the data as a string that is ready for display.
void	toVar(BaseDataType var) Instantiates a variable that is equivalent to the presentation's internal representation.
ErrorManager.ErrorEntry[]	validateFormat() Validate representation according to format rules and return error message if there is an error.
private ErrorManager.ErrorEntry	verifyYearComponent(char[][] comp) Validate year without throwing exceptions.

Methods inherited from class com.goldencode.p2j.ui.client.format.DisplayFormat.Presentation

activate, deleteRegion, forFieldValue, getCursorPos, getInitialCursorPos, getInsertMode, getLastPos, isFixedNumeric, isLastCharEntered, isNegative, isOptionalLeftSign, setCursorPos, setInsertMode, setLastCharEntered

Methods inherited from class java.lang.Object

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

Field Detail

SPACE

private static final char SPACE

Special value for an empty digit place.

See Also:

Constant Field Values

compBufs

private char[][] compBufs

Buffers for datetime component digits. May be null which means UNKNOWN value. Array element must contain a digit or SPACE which will be rendered as space.

Constructor Detail

DatetimeBuf

public DatetimeBuf()

Constructs default presentation used for clear operation.

DatetimeBuf

public DatetimeBuf(datetime varDatetime)
            throws DisplayFormatCheckException

Constructs presentation initialized with given datetime.

Parameters:

varDatetime - Initial value.

Throws:

DisplayFormatCheckException - This value can't be displayed with the current format.

Method Detail

clear

public void clear()

Delete the screen value.

Specified by:

clear in class DisplayFormat.Presentation

isFixedFont

public boolean isFixedFont()

Determine if this format must use the DEFAULT-FIXED-FONT, if no font is specified.

Specified by:

isFixedFont in class DisplayFormat.Presentation

Returns:

Always true.

checkFormat

public void checkFormat()
                 throws DisplayFormatCheckException

Checks format rules. Method finishEdit() should be called before it.

Specified by:

checkFormat in class DisplayFormat.Presentation

Throws:

DisplayFormatCheckException - When data is incompatible with format

validateFormat

public ErrorManager.ErrorEntry[] validateFormat()

Validate representation according to format rules and return error message if there is an error.

Overrides:

validateFormat in class DisplayFormat.Presentation

Returns:

null if no error or error message if there is an error.

isUnknown

public boolean isUnknown()

Returns if the presentation currently represents the unknown value. If any editing has occurred, then this will return false even if the editing is not complete.

Specified by:

isUnknown in class DisplayFormat.Presentation

Returns:

true if this is unknown.

deleteBack

public boolean deleteBack()

Erases one symbol before the cursor position.

Specified by:

deleteBack in class DisplayFormat.Presentation

Returns:

true if input is accepted (nevertheless it may be silently ignored in reality).

deleteCurrent

public boolean deleteCurrent()

Erases one symbol in the cursor position.

Specified by:

deleteCurrent in class DisplayFormat.Presentation

Returns:

true if input is accepted (nevertheless it may be silently ignored in reality).

input

public boolean input(char ch)

Inputs character. The result depends from the current insert mode.

Specified by:

input in class DisplayFormat.Presentation

Parameters:

ch - Input character

Returns:

true if input is accepted (nevertheless it may be silently ignored in reality).

moveCursorLeft

public boolean moveCursorLeft()

Moves cursor one character to the left.

Specified by:

moveCursorLeft in class DisplayFormat.Presentation

Returns:

true if input is accepted (nevertheless it may be silently ignored in reality).

moveCursorRight

public boolean moveCursorRight()

Moves cursor one character to the right. Also updates insert mode.

Specified by:

moveCursorRight in class DisplayFormat.Presentation

Returns:

true if input is accepted (nevertheless it may be silently ignored in reality).

moveCursorBegin

public boolean moveCursorBegin()

Moves cursor to the beginning of the field.

Specified by:

moveCursorBegin in class DisplayFormat.Presentation

Returns:

true if input is accepted (nevertheless it may be silently ignored in reality).

moveCursorEnd

public boolean moveCursorEnd()

Moves cursor to the end of the field.

Specified by:

moveCursorEnd in class DisplayFormat.Presentation

Returns:

true if input is accepted (nevertheless it may be silently ignored in reality).

finishEdit

public boolean finishEdit()

Indicates completion of an edit. The presentation instance may fill some unfilled places.

Specified by:

finishEdit in class DisplayFormat.Presentation

Returns:

true if rendering is necessary.

toScreenValue

public java.lang.String toScreenValue(boolean edit)

Formats the data as a string that is ready for display.

Overrides:

toScreenValue in class DisplayFormat.Presentation

Parameters:

edit - true if the screen value is being generated for interactive editing purposes.

Returns:

The formatted string.

toScreenValue

public java.lang.String toScreenValue()

Formats the data as a string that is ready for display.

Specified by:

toScreenValue in class DisplayFormat.Presentation

Returns:

The formatted string.

toVar

public void toVar(BaseDataType var)

Instantiates a variable that is equivalent to the presentation's internal representation.

Specified by:

toVar in class DisplayFormat.Presentation

Parameters:

var - A variable which must be compatible with the format.

initBuffers

private char[][] initBuffers()

Allocates datetime components buffers.

Returns:

Components buffers array.

initClear

private void initClear()

Resets content to space value.

clearComponent

private void clearComponent(char[] comp,
                            int compIdx)

Fills the date component with SPACE.

Parameters:

comp - The component.

compIdx - The id of the component.

assignComponent

private boolean assignComponent(char[] comp,
                                int value,
                                char leftPad,
                                boolean sign)

Fills the date/time component with the given value.

Parameters:

comp - The component.

value - The new value.

leftPad - Character to be used for left padding.

sign - The first character is reserved for the sign (only used for hours TZ).

Returns:

true if the value could be assigned or if component is optional and false if value cannot be represented in the available space

assignAMComponent

private void assignAMComponent(char[] comp,
                               int value,
                               boolean upper)

Fills the AMPM component with the computed value from current hours.

Parameters:

comp - The AMPM component.

value - The hours to be processed in 24H format.

extractDateOrTimeComponent

private int extractDateOrTimeComponent(char[] comp,
                                       boolean includeSign,
                                       int defVal)

Calculates numeric value of the date component.

Parameters:

comp - The date or time component. May partially consist from spaces.

includeSign - The component is sign prefixed (for TZ_HOURS only).

defVal - Default value to be returned if field not found or could not be parsed

Returns:

The integer value of component of defVal on error.

extractYearComponent

private int extractYearComponent(char[][] comp)
                          throws ErrorConditionException

Calculates numeric value of the year. Calculation can be described by the following algorithm:

If format separator isn't null then:

1. Input sequence is autocompleted (to a temporary buffer).
2. If the extreme right position holds '-' then it is discarded (e.g. -10- -> -10)
3. Remaining characters are parsed as a usual integer.

If format separator is null then:

1. Only the extreme left (before the space if it presents) digits are taken into account. If the first character is a space then the whole field content is ignored (e.g. 12_3 -> 12; _123 -> null)
2. If input consists of three digits then the last one is ignored (e.g. 123_ -> 12).
3. Remaining characters are parsed as a usual integer. If it cannot be parsed then the current year is used.

Parameters:

comp - The input datetime buffer.

Returns:

The numeric value of the year.

Throws:

ErrorConditionException - If the input sequence does not represent a valid year.

verifyYearComponent

private ErrorManager.ErrorEntry verifyYearComponent(char[][] comp)

Validate year without throwing exceptions.

Parameters:

comp - Component to verify.

Returns:

null if no error found, ErrorManager.ErrorEntry instance otherwise.

completeComponent

private void completeComponent(char[][] newCompBufs,
                               char[][] oldCompBufs,
                               int compIndex)

Completes datetime component. Day, month, hour, minutes, seconds and milliseconds are completed with 0's.

This method uses only one old and one new buffer for component but takes all buffers to simplify coding of its call.

The year completion algorithm can be described as follows:

1. If format separator is null then do nothing.
2. Find the extreme right '-' and fill all empty place-holders to the left of it with the '-' (e.g. __-_ -> ---_; _1_- -> -1--).
3. The extreme leftmost meaningful symbol (not SPACE) is found. After that we search for the extreme right meaningful symbol such that no spaces are present between it and the extreme left meaningful symbol. All symbols which are not between these ones are discarded (e.g. __12 -> 12; -2_3 -> -2; _1_3 -> 1). If no meaningful symbols are present then the current year is used.
4. To the previously found sequence of meaningful symbols some leading symbol may be added depending on the sequence length and year format:
   • When length is 3 and format is full-year OR length is 1 and format is not full-year then add a leading 0.
   • When length is 2 or 1 and format is full-year then the date.windowingImpl() which takes as input the digits from the sequence (the one that was created on the third step) is used (if the sequence contains no digits then 0 is used).
   • From the return value we take first 2 or 3 characters and complete the sequence with it. (e.g. -2- -> 0-2-; 99 -> 1999; -- -> 20--; 9 -> 2009)

Parameters:

newCompBufs - Buffers for new value. May be the same with oldCompBufs.

oldCompBufs - Buffers for old value.

compIndex - Component's index (DAY, MONTH, YEAR, HOURS, MINUTES, SECONDS, MILLIS, AMPM, TZ_HOURS, TZ_MINS).

toDatetime

private datetime toDatetime()
                     throws DisplayFormatCheckException

Returns the current presentation's value converted to datetime.

Returns:

The current presentation's value converted to datetime.

Throws:

DisplayFormatCheckException - Value doesn't represent a correct datetime.