jet.controls

Class JetEnumeration

java.lang.Object

jet.controls.JetProperty

jet.controls.JetEnumeration

All Implemented Interfaces:

jet.convert.EnumerationInfo, jet.convert.PropInfo, jet.util.Propertiable

public class JetEnumeration
extends JetProperty
implements jet.convert.EnumerationInfo

JetEnumeration, for saving/retrieving a entry(name and value).
This JetProperty :
1) can not set 'another object' in ChangeBy value by default
2) can not set 'on the fly formula' in ChangeBy value by default
4) contains a table(called as "entry-table") stored all possible entries for property choice
It does no different with JetString(if value is String) or JetNumber(if value is Integer), except it has property choice

Author:

unknown,zhiliang.liu(APIs and all comments)

Field Summary

Fields inherited from class jet.controls.JetProperty

CHART_BACKGROUND_EDITOR, CHART_FILLPATTERN_EDITOR, CHART_FILTER_EDITOR, CHART_FILTER_EDITOR_NO_DATE, CHART_ICON_STYLE, CHART_PATTERN_LIST_EDITOR, CHART_PENSTYLE_EDITOR, CHART_TEXTSTYLE_EDITOR, CHOICE_EDITOR, COLOR_EDITOR, COMBO_EDITOR, COMMAND_EDITOR, CONTROL_SELECT_ITEMS, DATASOURCE_EDITOR, DBCOL_EDITOR, DETAIL_REPORT_EDITOR, EDIT_FORBIDDEN, EDIT_FORBIDDEN_INIT, EDITABLE_ALLTIME, INTERNAL, LINK_EDITOR, MULSEL_EDITOR, PARAMCOL_EDITOR, QUERY_EDITOR, RECORDDB_EDITOR, SECURITY_EDITOR, TEXT_EDITOR

Fields inherited from interface jet.util.Propertiable

BIGSTRING, BOOLEAN, CHG_FMTTINGBLNAME, CHG_FMTTINGFORMULA, CHG_OTHER, COLOR, COMPFML_RESOURCE, CUSTOMER, CUSTOMERLINK, DELIM, DELIMCHAR, DOUBLE, ENUMERATION, IGNORED, IMAGE, IMGVECTOR, MAPPINGTBL, MODE_PAGE, MODE_UNKNOWN, MODE_WEB, NORMAL_RESOURCE, NUMBER, POINT, REFERENCE, STRING, SUB1_DELIM, UNIT, VAL_NORMALLENGTH, VAL_NORMALSTART, VECTOR

Constructor Summary

Constructors

Constructor and Description
JetEnumeration()
JetEnumeration(jet.controls.JetObject parent, String name) Create a JetEnumeration instance with no value
JetEnumeration(jet.controls.JetObject parent, String name, int enumType) Create a JetEnumeration instance with specified entries-set id but no value

Method Summary

Modifier and Type	Method and Description
Object	add(String key, Object value) Adds/Overwrites an entry to/in entry-table.
void	addAliasKey(String aliasKey, String actualKey) ONLY FOR DEVELOPER, set a aliasKey to actual Key, ONLY CAN CALLED DURING Constructing.
JetProperty	copy() Copies property with normal value
Object	get() Deprecated.
Object	get(int mode)
String	getCurKey() Deprecated.
String	getCurKey(int mode)
Hashtable	getEnumerationSet()
int	getEnumerationType()
String	getKeyByValue(int value) Notice: 1) before call it, please make sure that all entries' value are Integer 2) Before call it, please make sure that this instance is constructed by entries-set id, and no any operation about entry-table after construct
int[]	getMatchingSqlType() Now, this API only for DesignService : get Matching SQL Type of this property Usage in UI : list all the formula whose data-type in returned array
Object	getObject() Deprecated.
Object	getObject(int mode) According to the following priority return : 'another object' > normal value > default value Notice1: returned 'another object' is the description of 'changed by' Notice2: Effective if JetProperty.isCurrentAutoValue() is false
Vector	getPropertyChoice() Effective if JetProperty.isCurrentAutoValue() is false.
int	getValue(Object key) Deprecated.
int	getValue(Object key, int mode)
int	intValue() Deprecated.
int	intValue(int mode)
Object	remove(String key) Removes the an entry from entry-table.
void	removeAll() Clears so that entry-table contains no enumeration items
void	set(Object obj) Deprecated.
void	set(Object obj, int mode)
void	set(String key) Deprecated.
void	set(String key, int mode) sets the normal value via a String.
void	setEnumerationSet(Hashtable enumerationSet) Sets entry-table, notice : it would not change normal value.
void	setValue(Object obj) Sets normal value via specified entry's value.
void	setValue(Object obj, int mode)
void	setValue(String key) Deprecated.
void	setValue(String key, int mode)
String	toString() Effective if JetProperty.isCurrentAutoValue() is false.

Methods inherited from class jet.controls.JetProperty

addPropertyChangeListener, addToAtomicAction, canChangeByBL, canChangeByFmtt, canChangeByOthers, checkValue, curValueEqual, enableAllChangeBys, equal, getChangeBy, getChangeBy, getChangeByBL, getChangeByBL, getChangeByBLName, getChangeByBLName, getChangeByBLType, getChangeByBLType, getChangeByFmtt, getChangeByFmtt, getChangeByFmttName, getChangeByFmttName, getChangeByObject, getChangeByObject, getChangeByObjectName, getChangeByObjectName, getChangeByOtherType, getChangeByOtherType, getCurrentChangedBy, getCurrentChangedBy, getCurrentValue, getCurrentValue, getCurrentValue, getCurrentValue, getEditFlag, getEditorType, getInspValue, getInspValue, getInspValue, getModeProperty, getName, getNormalObject, getNormalObject, getParent, getPropType, getRuntimeChangeBy, getRuntimeChangeBy, getUnifiedObject, getUnifiedObject, getValue, getValue, isChagneByFmtt, isChagneByFmtt, isChangeByBL, isChangeByBL, isChangeByOther, isChangeByOther, isCurrentAutoValue, isCurrentAutoValue, isCurrentChangedBy, isCurrentChangedBy, isEnableAutoValue, isModeProperty, isNull, isNull, isSetAnyChangeBy, isSetRuntimeChgBy, isSetRuntimeChgBy, isSupportMode, isTransient, isUnavailable, loadFullChangeBy, loadFullChangeBy, propertyChanged, removePropertyChangeListener, saveFullChangeBy, saveFullChangeBy, setAsAutoValue, setAsAutoValue, setCanChangeByBL, setCanChangeByFmtt, setCanChangeByOthers, setChangeByBL, setChangeByBL, setChangeByBL, setChangeByBL, setChangeByFmtt, setChangeByFmtt, setChangeByObject, setChangeByObject, setChangeByObject, setChangeByObject, setEditFlag, setEditorType, setEnableAutoValue, setObject, setObject, setRuntimeChangeBy, setRuntimeChangeBy, setSupportMode, setTransient, setUnavailable, setUnitValue, setUnitValue, toUnitString, toUnitString

Methods inherited from class java.lang.Object

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

Methods inherited from interface jet.convert.PropInfo

getChangeByObjectName, getChangeByObjectName, getInspValue, getInspValue, getName, getValue, getValue, isChangeByOther, isChangeByOther, isNull, isNull, toUnitString, toUnitString

Constructor Detail

JetEnumeration

public JetEnumeration()

JetEnumeration

public JetEnumeration(jet.controls.JetObject parent,
                      String name)

Create a JetEnumeration instance with no value

Parameters:

parent - owner

name - name

JetEnumeration

public JetEnumeration(jet.controls.JetObject parent,
                      String name,
                      int enumType)

Create a JetEnumeration instance with specified entries-set id but no value

Parameters:

parent - owner

name - name

enumType - the entries-set defined in EnumerationConstant

Since:

V8

See Also:

EnumerationConstant

Method Detail

addAliasKey

public void addAliasKey(String aliasKey,
                        String actualKey)

ONLY FOR DEVELOPER, set a aliasKey to actual Key, ONLY CAN CALLED DURING Constructing.

Parameters:

aliasKey -

actualKey -

add

public Object add(String key,
                  Object value)

Adds/Overwrites an entry to/in entry-table.

Parameters:

key - the entry's name, can not empty-string and null.

value - the entry's value

Returns:

the previous value of the specified key or null if it did not have one

Throws:

NullPointerException - if the key or value is null

remove

public Object remove(String key)

Removes the an entry from entry-table. This method does nothing if the key is not in.

Parameters:

key - the item's name that needs to be removed, can not empty-string and null.

Returns:

the the item value to which the key had been mapped in, null if the key did not have a mapping

Throws:

NullPointerException - if the key is null

set

public void set(Object obj)

Deprecated.

Sets normal value specified entry's value.

Parameters:

obj - : the value

See Also:

setValue(Object)

set

public void set(Object obj,
                int mode)

set

public void set(String key)

Deprecated.

Sets normal value via specified entry's name if can found mapping in

Specified by:

set in interface jet.util.Propertiable

Overrides:

set in class JetProperty

Parameters:

key - the item's name, can not empty-string and null.

See Also:

setValue(String)

set

public void set(String key,
                int mode)

Description copied from class: JetProperty

sets the normal value via a String.

Specified by:

set in interface jet.util.Propertiable

Overrides:

set in class JetProperty

See Also:

If the subclass supports mode type, need to copy this method

setValue

public void setValue(Object obj)

Sets normal value via specified entry's value.

Parameters:

obj - the value

setValue

public void setValue(Object obj,
                     int mode)

setValue

public void setValue(String key)

Deprecated.

Sets normal value via specified entry's name if can found mapping in

Parameters:

key - the item's name, can not empty string and null.

setValue

public void setValue(String key,
                     int mode)

get

public Object get()

Deprecated.

Effective if JetProperty.isCurrentAutoValue() is false.

Returns:

the normal value.

See Also:

JetProperty.isCurrentAutoValue()

get

public Object get(int mode)

getCurKey

public String getCurKey()

Deprecated.

Effective if JetProperty.isCurrentAutoValue() is false.

Specified by:

getCurKey in interface jet.convert.EnumerationInfo

Returns:

the normal value's name or empty-string if not set

See Also:

set(Object), set(String), setValue(Object), setValue(String), get(), toString(), JetProperty.isCurrentAutoValue()

getCurKey

public String getCurKey(int mode)

Specified by:

getCurKey in interface jet.convert.EnumerationInfo

toString

public String toString()

Effective if JetProperty.isCurrentAutoValue() is false.

Specified by:

toString in interface jet.convert.PropInfo

Overrides:

toString in class Object

Returns:

normal value's name or empty-string if not set

See Also:

set(Object), set(String), setValue(Object), setValue(String), get(), getCurKey(), JetProperty.isCurrentAutoValue()

intValue

public int intValue()

Deprecated.

Notice1: before call it, please make sure that all entries' value are Integer
Notice2: effective if JetProperty.isCurrentAutoValue() is false.

Specified by:

intValue in interface jet.convert.EnumerationInfo

Returns:

the integer that current normal value's value converted. or -1 if can not convert to.

See Also:

getValue(Object), JetProperty.isCurrentAutoValue()

intValue

public int intValue(int mode)

Specified by:

intValue in interface jet.convert.EnumerationInfo

removeAll

public void removeAll()

Clears so that entry-table contains no enumeration items

getValue

public int getValue(Object key)

Deprecated.

Notice:
1) before call it, please make sure that all entries' value are Integer
2) It has not been deleted because it is an API in EnumerationInfo

Specified by:

getValue in interface jet.convert.EnumerationInfo

Parameters:

key - the enumeration item's name whose associated value is to be returned

Returns:

the enumeration item's value to which the specified key is mapped,

Throws:

NullPointerException - if no mapping for the key

ClassCastException - if not all enumeration item's value is Integer.

See Also:

intValue()

getValue

public int getValue(Object key,
                    int mode)

Specified by:

getValue in interface jet.convert.EnumerationInfo

getKeyByValue

public String getKeyByValue(int value)

Notice:
1) before call it, please make sure that all entries' value are Integer
2) Before call it, please make sure that this instance is constructed by entries-set id, and no any operation about entry-table after construct

Parameters:

value - the value whose associated name is to be returned

Returns:

the enumeration item's name to which the specified value is mapped, or null if no mapping for the value.

Since:

V8

getPropertyChoice

public Vector getPropertyChoice()

Effective if JetProperty.isCurrentAutoValue() is false.

Overrides:

getPropertyChoice in class JetProperty

Returns:

a String Vector contains names of all entries in entry-table or in entries-set specified by entries set id.

See Also:

JetProperty.isEnableAutoValue()

getObject

public Object getObject()

Deprecated.

Effective if JetProperty.isCurrentAutoValue() is false;returns normal value's value, or last entry(hash order)'s value in entry-table if not set

Specified by:

getObject in interface jet.util.Propertiable

Overrides:

getObject in class JetProperty

Returns:

the enumeration item's value

See Also:

get(), JetProperty.isCurrentAutoValue()

getObject

public Object getObject(int mode)

Description copied from class: JetProperty

According to the following priority return : 'another object' > normal value > default value
Notice1: returned 'another object' is the description of 'changed by' Notice2: Effective if JetProperty.isCurrentAutoValue() is false

Specified by:

getObject in interface jet.util.Propertiable

Overrides:

getObject in class JetProperty

See Also:

JetProperty.isChangeByOther(), JetProperty.isCurrentAutoValue()

getEnumerationSet

public Hashtable getEnumerationSet()

Returns:

entry-table

setEnumerationSet

public void setEnumerationSet(Hashtable enumerationSet)

Sets entry-table, notice : it would not change normal value.

Parameters:

enumerationSet - a Hashtable, DO NOT null.

getEnumerationType

public int getEnumerationType()

Returns:

the entry-set id if constructed by.

Since:

V8.

getMatchingSqlType

public int[] getMatchingSqlType()

Description copied from class: JetProperty

Now, this API only for DesignService : get Matching SQL Type of this property
Usage in UI : list all the formula whose data-type in returned array

Overrides:

getMatchingSqlType in class JetProperty

See Also:

Db

copy

public JetProperty copy()

Copies property with normal value

Overrides:

copy in class JetProperty

Returns: