e4s.html.input.extended
Class E4ValidatorID

java.lang.Object
  e4s.util.E4Object
      e4s.html.input.extended.E4ValidatorID

All Implemented Interfaces:

AEP_ValidationObject_Intf

public class E4ValidatorID
extends E4Object
implements AEP_ValidationObject_Intf

Validator for an input field, validating an ID which is a unique identification consisting of characters, "_" or digits. Must start with a character (may not be empty).

Since:

JDK 1.4

See Also:

E4InputField_Intf.setValidator(e4s.html.input.extended.AEP_ValidationObject_Intf), E4Fieldset.setValidator(e4s.html.input.extended.E4InputFieldName_Intf, e4s.html.input.extended.AEP_ValidationObject_Intf), E4EditingDataDescriptor.setValidator(e4s.html.input.extended.E4InputFieldName_Intf, e4s.html.input.extended.AEP_ValidationObject_Intf)

Field Summary

protected boolean	m_can_start_digit
protected java.lang.String	m_characters_allowed
protected boolean	m_empty_denied

Fields inherited from class e4s.util.E4Object

CRLF, E4S_CORE_SYSTEM_LANGUAGE, NBSP, NULLSTR, URL_ENCODING_CHARSET

Constructor Summary

E4ValidatorID()
Create a mandatory validator for values that are used as identifiers, allows characters, digits (but not starting with) and the '_' sign.

E4ValidatorID(boolean empty_denied)
Create a validator for values that are used as identifiers, allows characters, digits (but not starting with) or the '_' character.

E4ValidatorID(boolean empty_denied, java.lang.String characters_allowed)
Create a validator for values that are used as identifiers, allows characters, digits (but not starting with) or include the specified characters.

E4ValidatorID(java.lang.String characters_allowed)
Create a mandatory validator for values that are used as identifiers, allows characters, digits (but not starting with) or include the specified characters.

Method Summary

static java.lang.String	_getSVNVersionString() Get version info string from subversion.
boolean	canStartNumeric() Can the value start with a digit?
java.lang.String	getCharactersAllowed()
boolean	isMandatory() Check, if this validator is mandatory.
void	setCharactersAllowed(java.lang.String characters_allowed)
void	setFieldset(char mode, E4Fieldset fieldset) Ignored
void	startNumeric(boolean numeric) Can the value start with a digit?
E4Label_Intf	validate(E4InputFieldName_Intf name, E4Label_Intf label, java.lang.String value) Validate a field during input.

Methods inherited from class e4s.util.E4Object

Calendar, CName, CName, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelSys, E4LabelSys, e4sCopyright, e4sVersion, encode, encode, encode, encodeHtml, encodeHtml, encodeHtml, encodeURL, encodeURL, encodeURL, finalize, getLINE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTraceMemory, HtmlEncode, HtmlEncode, HtmlEncode, isdecimal, isdigit, isnotok, isnotok, isnumeric, isok, isok, isok, isok, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingStack, mkdirs, null2nbsp, null2nbsp, null2nbsp, ok, ok, ok, ok, outPrintln, setLogFile4Trace, setTraceMemory, STACKTRACE, toDebug, toDouble, toFloat, toFloat, toString, TRACE_CALLS, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, wait

Methods inherited from class java.lang.Object

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

Field Detail

m_empty_denied

protected boolean m_empty_denied

m_can_start_digit

protected boolean m_can_start_digit

m_characters_allowed

protected java.lang.String m_characters_allowed

Constructor Detail

E4ValidatorID

public E4ValidatorID()

Create a mandatory validator for values that are used as identifiers, allows characters, digits (but not starting with) and the '_' sign.

E4ValidatorID

public E4ValidatorID(boolean empty_denied,
                     java.lang.String characters_allowed)

Create a validator for values that are used as identifiers, allows characters, digits (but not starting with) or include the specified characters.

Parameters:

empty_denied - true means mandatory input

characters_allowed - null means no characters allowed or any character is valid that is included in this parameter

E4ValidatorID

public E4ValidatorID(java.lang.String characters_allowed)

Create a mandatory validator for values that are used as identifiers, allows characters, digits (but not starting with) or include the specified characters.

Parameters:

characters_allowed - null means no characters allowed or any character is valid that is included in this parameter

E4ValidatorID

public E4ValidatorID(boolean empty_denied)

Create a validator for values that are used as identifiers, allows characters, digits (but not starting with) or the '_' character.

Parameters:

empty_denied - true means mandatory input

Method Detail

getCharactersAllowed

public java.lang.String getCharactersAllowed()

setCharactersAllowed

public void setCharactersAllowed(java.lang.String characters_allowed)

startNumeric

public void startNumeric(boolean numeric)

Can the value start with a digit?

Parameters:

numeric - true: the value may start with a digit

See Also:

#canStartNumeric(boolean)

canStartNumeric

public boolean canStartNumeric()

Can the value start with a digit? The default value is false (digits not allowed).

Returns:

true, if digits are allowed at the beginning of the string

See Also:

startNumeric(boolean)

isMandatory

public boolean isMandatory()

Check, if this validator is mandatory.

Specified by:

isMandatory in interface AEP_ValidationObject_Intf

Returns:

true, if emtpy entry was enabled

See Also:

E4InputField.isMandatory()

validate

public E4Label_Intf validate(E4InputFieldName_Intf name,
                             E4Label_Intf label,
                             java.lang.String value)

Description copied from interface: AEP_ValidationObject_Intf

Validate a field during input.

Specified by:

validate in interface AEP_ValidationObject_Intf

Parameters:

name - the name of the field

label - the label of the field (translated)

value - the current value the user has entered

Returns:

null, if validation is o.k. (no errors) or an error message beeingt displayed and also indicating that the validation has failed.

setFieldset

public void setFieldset(char mode,
                        E4Fieldset fieldset)

Ignored

Specified by:

setFieldset in interface AEP_ValidationObject_Intf

Parameters:

mode - one of AEP_EditingDataDescriptor_Intf.MODE_INSERT, AEP_EditingDataDescriptor_Intf.MODE_UPDATE or AEP_EditingDataDescriptor_Intf.MODE_DELETE.

fieldset - the fieldset containing all the fields in the editing screen

_getSVNVersionString

public static java.lang.String _getSVNVersionString()

Get version info string from subversion.

Returns:

the version info string.

See Also:

E4Util.getRevisionCodeFromSVN(Class)