com.aspc.DBObj

Class FldParams

java.lang.Object

com.aspc.DBObj.FldParams

All Implemented Interfaces:

java.lang.Cloneable

public class FldParams
extends java.lang.Object
implements java.lang.Cloneable

Allows etc parameters to be passed to a derived fields.
THREAD MODE: SINGLE-THREADED

Since:

October 1, 2002, 5:54 PM

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAM_ALT_LANGUAGE The alternative language
static java.lang.String	PARAM_AUTO_ENTERED auto entered is a known parameter
static java.lang.String	PARAM_CAST cast to different types
static java.lang.String	PARAM_CREATE_MISSING_OBJECT create missing object if this param is true
static java.lang.String	PARAM_DEFAULT The default value is...
static java.lang.String	PARAM_FORMAT The format
static java.lang.String	PARAM_LABEL The label is...
static java.lang.String	PARAM_LANGUAGE The required Language
static java.lang.String	PARAM_LOOKUP_CLASS internal lookup parameter
static java.lang.String	PARAM_LOOKUP_CREATE internal lookup parameter
static java.lang.String	PARAM_LOOKUP_FIELD internal lookup parameter#
static java.lang.String	PARAM_LOOKUP_NOSEARCH internal lookup parameter
static java.lang.String	PARAM_LOOKUP_VALUE internal lookup parameter
static java.lang.String	PARAM_POSITION Position is a known parameter
static java.lang.String	PARAM_TIMEZONE timezone parameter

Constructor Summary

Constructors

Constructor and Description
FldParams() constructor
FldParams(int defaultValue) constructor
FldParams(java.lang.String params) constructor

Method Summary

Modifier and Type	Method and Description
void	clearLookup() Removed lookup settings
java.lang.Object	clone()
static FldParams	createIfNeeded(java.lang.String... args)
static FldParams	createNewObject(FldParams params) Clone the passed in parameters or create new blank parameters.
java.lang.Object	doCast(java.lang.Object value) do cast
protected void	extClearFieldValues() OVERRIDE this method to clear your own fields.
protected void	extSetParameter(java.lang.String name, java.lang.Object value) OVERRIDE this method to handle your own fields.
java.lang.Object	formatError(DataSource ds, DBField field, java.lang.Exception e) TODO: Handle ERR=
java.lang.String[]	getAltLanguage()
java.util.Date	getDateParameter(java.lang.String name)
java.util.Date	getDateParameter(java.lang.String name, java.util.TimeZone tz)
java.lang.Object	getDefault(DataSource ds, DBField field) What is the default value for this fields.
int	getDefaultInt()
java.lang.String	getDefaultString(DataSource ds)
java.lang.String	getLanguage() The required language
java.lang.String	getLanguageList() Gets a comma-separated string containing the languages specified.
java.lang.String	getLookupClass() returns the Lookup Class.
boolean	getLookupCreate() returns the Lookup Create If Missing Value.
java.lang.String	getLookupFld() returns the Lookup Field.
boolean	getLookupNoSearch() returns the Lookup Create If Missing Value.
java.lang.String	getLookupValue() returns the Lookup Value.
java.lang.Object	getObjParameter(java.lang.String name)
java.lang.String	getParameter(java.lang.String name)
java.lang.String	getParameter(java.lang.String name, java.lang.String defaultValue)
java.lang.String	getParameterString(java.lang.String name)
int	getPosition()
boolean	hasLanguagePreference() are there any language preferences ?
boolean	hasParameter(java.lang.String name) Do we have this parameter
boolean	isAutoEntered()
boolean	isChangedByUser()
boolean	isCreateMissingObject() returns the create object if missing
boolean	isDefaultNull() is the default value set to NULL.
boolean	isLocked()
boolean	isValid() Is the parameter in valid format?
java.lang.Object[][]	list()
java.lang.String	parseFields(java.lang.String field) This function can be used to strips the parameters in a field for example reasonForUpload{KEY=Reason for Upload,UNPUBLISHED=true} this function will make the field as only reasonforUpload and will have two parameters Key and Unpublished with respective values
void	parseParams(java.lang.String params) parse the string of Parameters passed in.
void	parseParams(java.lang.String params, boolean clearValues) parse the string of Parameters passed in.
void	setAltLanguage(java.lang.String list)
void	setDefault(java.lang.Object obj) Set the default value for this field if the result is null
void	setIsAutoEntered(boolean flag)
void	setIsChangedByUser(boolean flag)
void	setLanguage(java.lang.String language) Sets the language for this request
void	setLocked(boolean on)
void	setLookup(DBClassConcrete cls, DBField fld, java.lang.String val, boolean createIfMissing, boolean noSearch) Sets the lookup settings
void	setObjParameter(java.lang.String name, java.lang.Object value) Allows to pass object, such as Date into param
void	setParameter(java.lang.String name, java.lang.String value)
FldParams	setPosition(int pos)
java.lang.String	toString()
void	validate(DataSource ds) Validates the parameters that are stored in this FldParams object.
void	validParameters(java.util.HashSet params) check if the list of parameters are valid

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_POSITION

public static final java.lang.String PARAM_POSITION

Position is a known parameter

See Also:

Constant Field Values

PARAM_AUTO_ENTERED

public static final java.lang.String PARAM_AUTO_ENTERED

auto entered is a known parameter

See Also:

Constant Field Values

PARAM_CREATE_MISSING_OBJECT

public static final java.lang.String PARAM_CREATE_MISSING_OBJECT

create missing object if this param is true

See Also:

Constant Field Values

PARAM_LANGUAGE

public static final java.lang.String PARAM_LANGUAGE

The required Language

See Also:

Constant Field Values

PARAM_DEFAULT

public static final java.lang.String PARAM_DEFAULT

The default value is...

See Also:

Constant Field Values

PARAM_FORMAT

public static final java.lang.String PARAM_FORMAT

The format

See Also:

Constant Field Values

PARAM_CAST

public static final java.lang.String PARAM_CAST

cast to different types

See Also:

Constant Field Values

PARAM_LABEL

public static final java.lang.String PARAM_LABEL

The label is...

See Also:

Constant Field Values

PARAM_ALT_LANGUAGE

public static final java.lang.String PARAM_ALT_LANGUAGE

The alternative language

See Also:

Constant Field Values

PARAM_LOOKUP_CREATE

public static final java.lang.String PARAM_LOOKUP_CREATE

internal lookup parameter

See Also:

Constant Field Values

PARAM_LOOKUP_CLASS

public static final java.lang.String PARAM_LOOKUP_CLASS

internal lookup parameter

See Also:

Constant Field Values

PARAM_LOOKUP_FIELD

public static final java.lang.String PARAM_LOOKUP_FIELD

internal lookup parameter#

See Also:

Constant Field Values

PARAM_LOOKUP_VALUE

public static final java.lang.String PARAM_LOOKUP_VALUE

internal lookup parameter

See Also:

Constant Field Values

PARAM_LOOKUP_NOSEARCH

public static final java.lang.String PARAM_LOOKUP_NOSEARCH

internal lookup parameter

See Also:

Constant Field Values

PARAM_TIMEZONE

public static final java.lang.String PARAM_TIMEZONE

timezone parameter

See Also:

Constant Field Values

Constructor Detail

FldParams

public FldParams()

constructor

FldParams

public FldParams(int defaultValue)

constructor

Parameters:

defaultValue - The default value

FldParams

public FldParams(@Nullable
                 java.lang.String params)

constructor

Parameters:

params - The comma separated parameters

Method Detail

parseFields

@CheckReturnValue
 @Nonnull
public java.lang.String parseFields(@Nonnull
                                                                java.lang.String field)

This function can be used to strips the parameters in a field for example reasonForUpload{KEY=Reason for Upload,UNPUBLISHED=true} this function will make the field as only reasonforUpload and will have two parameters Key and Unpublished with respective values

Parameters:

field - the field with parameter in it.

Returns:

the parsed value

parseParams

public final void parseParams(@Nullable
                              java.lang.String params)

parse the string of Parameters passed in.

Parameters:

params - the user parameters.

parseParams

public final void parseParams(@Nullable
                              java.lang.String params,
                              boolean clearValues)

parse the string of Parameters passed in.

Parameters:

params - the user parameters

clearValues - clear the previous parameters.

setIsChangedByUser

public final void setIsChangedByUser(boolean flag)

Parameters:

flag - changed by user.

setIsAutoEntered

public final void setIsAutoEntered(boolean flag)

Parameters:

flag - is auto entered.

isAutoEntered

@CheckReturnValue
public final boolean isAutoEntered()

Returns:

is auto entered.

isChangedByUser

@CheckReturnValue
public final boolean isChangedByUser()

Returns:

is changed by user.

setObjParameter

public final void setObjParameter(@Nullable
                                  java.lang.String name,
                                  @Nonnull
                                  java.lang.Object value)

Allows to pass object, such as Date into param

Parameters:

name - the parameter name

value - the value

setParameter

public final void setParameter(java.lang.String name,
                               java.lang.String value)

Parameters:

name - the parameter name

value - the value

list

@CheckReturnValue
 @Nonnull
public final java.lang.Object[][] list()

Returns:

list of parameters

hasParameter

@CheckReturnValue
public final boolean hasParameter(java.lang.String name)

Do we have this parameter

Parameters:

name - The parameter name

Returns:

true if we do.

doCast

@CheckReturnValue
 @Nullable
public final java.lang.Object doCast(@Nullable
                                                                  java.lang.Object value)

do cast

Parameters:

value - the original value

Returns:

the cast value

getObjParameter

@CheckReturnValue
 @Nullable
public final java.lang.Object getObjParameter(@Nullable
                                                                           java.lang.String name)

Parameters:

name - the parameter name

Returns:

the parameter

getDateParameter

@CheckReturnValue
 @Nullable
public final java.util.Date getDateParameter(@Nullable
                                                                          java.lang.String name)

Parameters:

name - the parameter name

Returns:

the date parameter

getDateParameter

@CheckReturnValue
 @Nullable
public final java.util.Date getDateParameter(java.lang.String name,
                                                                          java.util.TimeZone tz)

Parameters:

name - the parameter name

tz - the timezone

Returns:

the date parameter

getParameterString

@CheckReturnValue
 @Nonnull
public final java.lang.String getParameterString(java.lang.String name)

Parameters:

name - the parameter name

Returns:

the value

getParameter

@CheckReturnValue
 @Nullable
public final java.lang.String getParameter(java.lang.String name)

Parameters:

name - the parameter name

Returns:

the value

getParameter

@CheckReturnValue
 @Nullable
public final java.lang.String getParameter(java.lang.String name,
                                                                        java.lang.String defaultValue)

Parameters:

name - the parameter name

defaultValue - the default value.

Returns:

the value

formatError

@CheckReturnValue
 @Nullable
public java.lang.Object formatError(DataSource ds,
                                                                 DBField field,
                                                                 java.lang.Exception e)

TODO: Handle ERR=

Parameters:

ds - the data source

field - the field

e - the exception

Returns:

the error

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

extClearFieldValues

@OverridingMethodsMustInvokeSuper
protected void extClearFieldValues()

OVERRIDE this method to clear your own fields.

extSetParameter

@OverridingMethodsMustInvokeSuper
protected void extSetParameter(java.lang.String name,
                                                                 java.lang.Object value)

OVERRIDE this method to handle your own fields.

Parameters:

name - the parameter name

value - the value

getLanguage

@CheckReturnValue
 @Nonnull
public java.lang.String getLanguage()

The required language

Returns:

the language

hasLanguagePreference

@CheckReturnValue
public boolean hasLanguagePreference()

are there any language preferences ?

Returns:

true if there is an language preference

setLanguage

public void setLanguage(@Nonnull
                        java.lang.String language)

Sets the language for this request

Parameters:

language - the language

setAltLanguage

public void setAltLanguage(@Nullable
                           java.lang.String list)

Parameters:

list - the alternative language

getAltLanguage

@CheckReturnValue
 @Nullable
public java.lang.String[] getAltLanguage()

Returns:

the list of alternative language

getPosition

@CheckReturnValue
public int getPosition()

Returns:

the position

setPosition

public FldParams setPosition(int pos)

Parameters:

pos - the position.

Returns:

this

isDefaultNull

@CheckReturnValue
public boolean isDefaultNull()

is the default value set to NULL.

Returns:

true if we should default to null

getDefault

@CheckReturnValue
 @Nullable
public java.lang.Object getDefault(DataSource ds,
                                                                DBField field)

What is the default value for this fields.

Parameters:

ds - the data source

field - the field

Returns:

the default value.

getDefaultInt

@CheckReturnValue
public int getDefaultInt()

Returns:

the default value

getDefaultString

@CheckReturnValue
 @Nullable
public java.lang.String getDefaultString(DataSource ds)

Parameters:

ds - the data source

Returns:

the default value

setDefault

public void setDefault(@Nullable
                       java.lang.Object obj)

Set the default value for this field if the result is null

Parameters:

obj - the default

validParameters

public void validParameters(java.util.HashSet params)
                     throws java.lang.Exception

check if the list of parameters are valid

Parameters:

params - list of valid parameters for checking

Throws:

java.lang.Exception - a serious problem

isValid

@CheckReturnValue
public boolean isValid()

Is the parameter in valid format?

Returns:

is valid

isCreateMissingObject

@CheckReturnValue
public boolean isCreateMissingObject()

returns the create object if missing

Returns:

getLookupClass

@CheckReturnValue
 @Nullable
public java.lang.String getLookupClass()

returns the Lookup Class.

Returns:

the field.

getLookupFld

@CheckReturnValue
 @Nullable
public java.lang.String getLookupFld()

returns the Lookup Field.

Returns:

the field.

getLookupValue

@CheckReturnValue
 @Nullable
public java.lang.String getLookupValue()

returns the Lookup Value.

Returns:

the string value.

getLookupCreate

@CheckReturnValue
public boolean getLookupCreate()

returns the Lookup Create If Missing Value.

Returns:

the boolean value.

getLookupNoSearch

@CheckReturnValue
public boolean getLookupNoSearch()

returns the Lookup Create If Missing Value.

Returns:

the boolean value.

clearLookup

@OverridingMethodsMustInvokeSuper
public void clearLookup()

Removed lookup settings

clone

@CheckReturnValue
 @Nonnull
public java.lang.Object clone()
                                                   throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Returns:

the clone

Throws:

java.lang.CloneNotSupportedException - never happens.

setLookup

public void setLookup(DBClassConcrete cls,
                      DBField fld,
                      java.lang.String val,
                      boolean createIfMissing,
                      boolean noSearch)

Sets the lookup settings

Parameters:

cls - the class

fld - the fields

val - the value

createIfMissing - create if missing

noSearch - no search

validate

public void validate(DataSource ds)
              throws java.lang.Exception

Validates the parameters that are stored in this FldParams object.

Parameters:

ds - the data source

Throws:

java.lang.Exception - a serious problem

getLanguageList

@CheckReturnValue
 @Nonnull
public java.lang.String getLanguageList()

Gets a comma-separated string containing the languages specified.

Returns:

the language list

setLocked

public void setLocked(boolean on)

Parameters:

on - true if locked.

isLocked

@CheckReturnValue
public boolean isLocked()

Returns:

true if locked.

createIfNeeded

@CheckReturnValue
 @Nullable
public static FldParams createIfNeeded(java.lang.String... args)

Parameters:

args - the field parameters

Returns:

create a new field parameters

createNewObject

@CheckReturnValue
 @Nonnull
public static FldParams createNewObject(@Nullable
                                                                    FldParams params)

Clone the passed in parameters or create new blank parameters.

Parameters:

params - the field parameters

Returns:

create a new field parameters