de.frame4j.util

Class Action

java.lang.Object

de.frame4j.util.Action

All Implemented Interfaces:

Cloneable

@MinDoc(copyright="Copyright 2004, 2009  A. Weinert",
        author="Albrecht Weinert",
        version="V.65",
        lastModified="3.06.2024",
        usage="use for human friendly parsers",
        purpose="translate (polyglotly) keywords to unique integer codes")
public class Action
extends Object
implements Cloneable

An Action: Action code (int) plus parameter (int).

Objects of this class subsume an action-(code) and an action-(value).

An Action, for example, would be
"Set day of week" (= code = 3) to "Monday" (= value = 2).

Such an Action object always has a keyword or a list of keywords. Preferably the list is multilingual featuring at least English and German and hopefully also Italian, French, Spanish Portuguese and Dutch. Any keyword in the list would choose the action. The exemplary Action above, would have the keywords:
Montag Monday Lundi lunedí lunedi lunes
(That's de, en, fr, 2*it and sp.)

The method (selectedBy()) can ascertain, if a given String hits one of the keywords fully (Monday) or as an abbreviation (Mo). Case can optionally be ignored (mO, LuNd).

Purpose in life is to enrich parsers by the human friendly utilisation of keywords (like in TimeHelper.parse()).

Some action codes are pre-defined here (could be overridden by applying classes).

Abbreviation	code	Meaning	Value
NOP	0	Do nothing	any, no meaning.
SWD	3	Set day of week	0: Sunday .. 6: Saturday
SMON	4	Set Month	1: January .. 12: December
STZO	5	Set time zone offset in minutes	-12*60 .. +12*60 should be n*30
STIM	6	Set time of day or the 0/12 hour add on hour:minute:second.ms	0: Midnight 0:0:0 1: AM, ante meridiem) 2: Noon 12:00:00 3: Afternoon (PM, post meridiem, = add 12 h to clock reading) 4: End of day 23:59:59,999 (1 ms before next day)
SDAY	7	Set day relative to today	0: today, +1: tomorrow -1: yesterday, -2: day before ...
SDAT	8	Set complete time / date day.month.year hour:minute:second.ms	0: now
SRATE	11	Set a rate / frequency	1 : every second, 2: every minute, 3: every hour, ..
SVERBOS	13	Set a level of verbosity for logs or reports	Verbos.DEBUG .. Verbos.SILENT

© Copyright 2003, 2009 Albrecht Weinert

Version:

65 (3.06.2024)

See Also:

TextHelper, TimeHelper.parse(CharSequence), ColorHelper.getColor(CharSequence), TimeHelper.TIME_CHOOSE

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Action.Filter A filter for Actions.

Field Summary

Fields

Modifier and Type	Field and Description
static Action.Filter	ALL A filter for (all) Actions.
int	anzKeys Number of keywords.
int	code Action code.
static int	NOP Action code: Don't do anything.
static int	SCOLOR Action code: Select colour.
static int	SDAT Action code: Set complete date.
static int	SDAY Action code: Set the day relative to today.
static int	SMON Action code: Set month.
static int	SRATE Action code: Rate.
static int	STOD Action code: Set time of day.
static int	STZO Action code: Set time zone offset.
static int	SVERBOS Action code: Report level.
static int	SWD Action code: Set day of week.
int	value Actions parameter (value).

Constructor Summary

Constructors

Constructor and Description
Action(int code, int value, String[] keys) Common Constructor (without any checks).

Method Summary

Modifier and Type	Method and Description
Object	clone() Copy this Action.
boolean	equals(Object other) Compare to other Action.
String	getKey(int number) Get one of the keywords (by index).
int	hashCode() Hash code.
static Action.Filter	makeCodeFilter(int code) A filter for Actions by code.
static Action	select(Action[] list, Action.Filter filter, CharSequence key, boolean ignoreCase) Find an Action from a list according to key.
int	selectedBy(CharSequence key, boolean ignoreCase) Can this action be chosen by key.
String	toString() State as String.

Methods inherited from class java.lang.Object

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

Field Detail

NOP

public static final int NOP

Action code: Don't do anything.

Value: 0

See Also:

Constant Field Values

SWD

public static final int SWD

Action code: Set day of week.

code = 0 : Sunday, 1 : Monday, ... 6 : Saturday.
Value: 3

See Also:

Constant Field Values

SMON

public static final int SMON

Action code: Set month.

code = 1 : January ... 12 : December.
Value: 4

See Also:

Constant Field Values

STZO

public static final int STZO

Action code: Set time zone offset.

code = Offset in minutes -12*60..+12*60 in 60 (30,15) steps
Value: 5

See Also:

Constant Field Values

STOD

public static final int STOD

Action code: Set time of day.

code = 0 : midnight, 1: AM, 2 : noon, 3: PM, 4: end of day.

See Also:

Constant Field Values

SDAY

public static final int SDAY

Action code: Set the day relative to today.

code = 0 : today, -1 : yesterday, +1 : tomorrow, and so on..
Value: 7

See Also:

Constant Field Values

SDAT

public static final int SDAT

Action code: Set complete date.

code = 0 : (right) now
Value: 8

See Also:

Constant Field Values

SRATE

public static final int SRATE

Action code: Rate.

code = 1 : every second, 2: every minute, 3 : every hour, 4 : daily, 5 : weekly.
Value: 11

See Also:

Constant Field Values

SVERBOS

public static final int SVERBOS

Action code: Report level.

code = 300 (debug) .. 1000 (silent / severe).
Value: 13

See Also:

Verbos.toString(), Constant Field Values

SCOLOR

public static final int SCOLOR

Action code: Select colour.

code = 0xFF0000 : red (e.g.); any of 0xrrggbb.
Value: 32

See Also:

Constant Field Values

code

public final int code

Action code.

value

public final int value

Actions parameter (value).

anzKeys

public final int anzKeys

Number of keywords.

ALL

public static final Action.Filter ALL

A filter for (all) Actions.

This is a filter that accepts (all) non null actions.

Constructor Detail

Action

public Action(int code,
              int value,
              String[] keys)

Common Constructor (without any checks).

This constructor accepts all parameters without checks and uses / stores the array keys as is, i.e without copying it.

This extreme confidentialness is seldom meaningful. It is used here as usually no single Action objects generated out of the blue by a programmer. Usually large arrays of Action by trusted / tested code, to be used for select(Action[], Filter, CharSequence, boolean).

Examples of such action lists are TimeHelper.TIME_CHOOSE, for human friendly time parsers or ColorVal.COLOR_CHOOSE for the same with colours.

Parameters:

code - action code

value - action parameter, value

keys - all keywords meaning (code, value).

Method Detail

equals

public final boolean equals(Object other)

Compare to other Action.

Two action with same code and value are considered as equal.

Overrides:

equals in class Object

hashCode

public final int hashCode()

Hash code.

Depends on both code and value (fitting equals()).

Overrides:

hashCode in class Object

toString

public String toString()

State as String.

Gives "Action(code, value): all keys".

Overrides:

toString in class Object

clone

public final Object clone()

Copy this Action.

As Action objects are immutable, this method returns the object itself (this).

Overrides:

clone in class Object

Returns:

this immutable object

getKey

public String getKey(int number)

Get one of the keywords (by index).

One of the keywords is returned.
The index range is 1..number and an index may be given negative (absolute value is used); compare selectedBy().

Hint: Regard the 1 based numbering.

Parameters:

number - number of key + or - 1..anzKeys

Returns:

the key if abs(number) is within range, else null

selectedBy

public int selectedBy(CharSequence key,
                      boolean ignoreCase)

Can this action be chosen by key.

It is checked, if parameter key fits or abbreviates one of this action's keywords.

Parameters:

key - null or shorter than 2 (excluding an end dot) returns 0

ignoreCase - true means case insensitive matching

Returns:

0 : no match,
> 0 : full match (= + list number / index of keyword)
< 0 : match as abbreviation (= -index of keyword)

See Also:

TextHelper.startsWith()

select

public static Action select(Action[] list,
                            Action.Filter filter,
                            CharSequence key,
                            boolean ignoreCase)

Find an Action from a list according to key.

This method returns an Action from a list (an array) of Actions, if that Actionis selected by the key and null otherwise.

The first matching Action, that matches key directly and completely, is returned. Other Actions found, that would match key as an abbreviation, are ignored. (The first complete match ends the search; complete matches are not checked for ambiguousness.) If ignoreCase is true, the matching is case insensitive.

If an action is found, that is matched by key as an abbreviation, it is returned, if and only if that abbreviation (match) is unambiguous (and if no complete match is found thereafter).

Abbreviated unambiguously means: There is no other Action in list, not equal to the fist found, that matches key as an abbreviation.

In the whole process Actions rejected by the optional filter are ignored (as if not on list).

Parameters:

list - the list of possible Actions to match key to

filter - an optional filter, to select a subset from list. null accepts all Actions from list.

key - the choice; if key ends with a dot (.) that is removed; if key is (then) shorter than 2, null is returned

ignoreCase - true: match non regarding case

Returns:

unambiguously matching Action object or null

See Also:

TimeHelper.parseDuration(CharSequence), TextHelper.startsWith(CharSequence, CharSequence, boolean), Action.Filter, makeCodeFilter(int)

makeCodeFilter

public static Action.Filter makeCodeFilter(int code)

A filter for Actions by code.

This method produces and returns a filter that accepts non null actions, that have code code.

Parameters:

code - the action code

Returns:

the filter